Configuring API Keys

To configure Veeam Service Provider Console integration with third party solutions, 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:

Important!

To configure API Keys, you must have access to Veeam Service Provider Console RESTful API. To get access to RESTful API, contact your service provider.

Note that after your service provider disables access to Veeam Service Provider Console REST API for your company, all API keys will be disabled automatically.

 

Required Privileges

To perform this task, a user must have the following role assigned: Company Owner, Company 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 API Keys.
  3. At the top of the list, click New > Simple Key (Recommended).
  4. In the Create Key window, enter a description for the API key.
  5. 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 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 API Keys.
  3. At the top of the list, click New > Advanced Key.
  4. In the Create Key window, 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.