Configuring API Keys

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:

• Simple Key — this API key is recommended for configuring Veeam Service Provider Console REST API authentication. For details, see section API Key-Based Authorization of the REST API Reference.
• Advanced Key — this API key is recommended for configuring Veeam Service Provider Console internal integrations. For details, see Plugins and Integration.

Required Privileges

To perform this task, a user must have the following role assigned: Service Provider Global Administrator, Service Provider 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.

2. At the top right corner of the Veeam Service Provider Console window, click Configuration.
3. In the configuration menu on the left, click Security.
4. Navigate to the API Keys tab.
5. At the top of the list, click New > Simple Key (Recommended).
6. In the Create Key window, enter a description for the API key.
7. If you want to enable read-only access to the API key, set the Read-only access toggle to On.
8. Click Create.

The Private API key will display.

9. 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.

10. 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.

2. At the top right corner of the Veeam Service Provider Console window, click Configuration.
3. In the configuration menu on the left, click Security.
4. Navigate to the API Keys tab.
5. At the top of the list, click New > Advanced Key.
6. 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.

7. Click Generate a key for me.

The Public API key will display.

8. If you want to enable read-only access to the API key, set the Read-only access toggle to On.
9. In the Description field, enter a description for the API key.
10. Click Create.

The Private API key will display.

11. 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.

12. Click OK.

Related Topics

• Modifying API Keys
• Deleting API Keys