Configuring API Keys

In this article

    To configure Veeam Service Provider Console integration with third party solutions or Veeam Service Provider Console plugins, for example ConnectWise Automate, you must generate API keys. Veeam Service Provider Console uses API keys to authenticate requests from third party solutions to Veeam Service Provider Console server.

    In Veeam Service Provider Console, you can configure the following API keys:

     

    Required Privileges

    To perform this task, a user must have the following role assigned: Portal Administrator.

    Configuring Simple API Key

    To generate simple API key:

    1. Log in to Veeam Service Provider Console.

    For details, see Accessing Veeam Service Provider Console.

    1. At the top right corner of the Veeam Service Provider Console window, click Configuration.
    2. In the configuration menu on the left, click Security.
    3. Navigate to the API Keys tab.
    4. At the top of the list, click New > Simple Key (Recommended).
    5. In the Create Key window, enter a description for the API key.
    6. Click Create.

    The Private API key will display.

    Configuring API Keys 

    1. Click Copy key to clipboard to copy the Private API key.

    The Private key is only available at the time when the key is created, thus you must save the key externally for future use.

    Configuring API Keys 

    1. Click OK.

    Configuring Advanced API Keys

    To generate public and private API keys:

    1. Log in to Veeam Service Provider Console.

    For details, see Accessing Veeam Service Provider Console.

    1. At the top right corner of the Veeam Service Provider Console window, click Configuration.
    2. In the configuration menu on the left, click Security.
    3. Navigate to the API Keys tab.
    4. At the top of the list, click New > Advanced Key.
    5. In the Create Key window, select API key type:
    • Built-in plugins — choose this option to create an API key for Veeam Service Provider Console internal integrations. For details on Veeam Service Provider Console integrations, see Plugins and Integration.
    • 3rd party integrations — choose this option to create an API key for third party integrations.
    1. Click Generate a key for me.

    The Public API key will display.

    1. In the Description field, enter a description for the API key.
    2. Click Create.

    The Private API key will display.

    Configuring API Keys 

    1. Click Copy key to clipboard to copy the Private API key.

    The Private key is only available at the time when the key is created, thus you must save the key externally for future use.

    Configuring API Keys 

    1. Click OK.

    Related Topics

    I want to report a typo

    There is a misspelling right here:

     

    I want to let the Veeam Documentation Team know about that.