Manage API Credentials

The API Credentials window allows you to view, generate, or deactivate API credentials. API credentials consist of the access key and associated secret key. The API credentials allow you to export or retrieve plan data using an API.

To manage the API credentials:

• You must be defined as an ESP admin user.

• The public API feature must be enabled.

View, generate, and deactivate API credentials

1. After logging in to ESP, open the user menu by clicking your username in the top corner.

2. Select API Credentials.

   This option appears if you are an ESP admin user. It is only available if the public API feature is enabled.

   The API Credentials window displays these read-only fields for the latest API credentials:

   • Status

     The status of the API credentials. Close and reopen the window to see status updates. The status can be:

     Status	Description
     No Credentials	No API credentials are active or pending activation. The Access Key and Secret Key are blank. Click Generate to generate the API credentials. The Deactivate button is not available.
     Pending Activation	Waiting for ESP to activate the access key and secret key. Click Deactivate to deactivate the API credentials. The Generate button is not available. If the API credentials remain in Pending Activation status for more than 24 hours, the status will automatically change to Activation Failed.
     Activated	The API credentials are active. Click Deactivate to deactivate the API credentials. The Generate button is not available.
     Activation Failed	ESP is unable to create the API credentials. Click Generate to re-generate the API credentials. The Deactivate button is not available.
     Pending Deactivation	Waiting for ESP to deactivate the access key and secret key. The Deactivate and Generate buttons are not available.
     Deactivated	The API credentials are not active. ESP removes credentials deactivated for 24 hours or more weekly from the ESP tenant database. Click Generate to re-generate the API credentials. The Deactivate button is not available.
     Deactivation Failed	ESP is unable to delete the API credentials. Click Generate to re-generate the API credentials. The Deactivate button is not available.

   • Created

     The date and time the API credentials were created.

   • Access Key

     The key for access to the public APIs. There can only be one active access key for each ESP tenant.

     This field shows only the last 4 characters of the access key, except after generating new keys. For a new access key, this field shows the whole key and is available to copy.

   • Secret Key

     The key associated with the access key.

     This field shows only the last 4 characters of the secret key, except after generating new keys. For a new secret key, this field shows the whole key and is available to copy.

3. To generate new API credentials, click Generate.

   The status moves to Pending Activation. After a successful generation, the access and secret keys become visible. For each key, click Copy to clipboard and paste the key into a file. Save the file in case you need the keys later.

   The status moves to Activated after ESP activates the new access key and secret key. When you close and reopen the API Credentials window:

   • you see status updates

   • the access key and secret key become masked

   • you can no longer copy the access key or secret key

   The Generate button is only available if the status is No Credentials, Failed Activation or Deactivated.

4. To deactivate API credentials, click Deactivate.

   The status moves to Pending Deactivation. Wait for a Deactivated status to generate new API credentials. Close and reopen the API Credentials window to see status updates.

   The Deactivate button is only available if the status is Activated or Pending Activation.