Skip to main content

Generate an API key

An application programming interface (API) key gives a user or service user API-only access to CertCentral. Use an API key to authenticate automated integrations, third-party tools, and custom API workflows without requiring interactive sign-in credentials.

Before you begin

  • You must have Administrator access to generate API keys.

  • Decide whether to link the key to an existing CertCentral user or create a new service user. A service user has API-only access and inherits administrator-level permissions by default.

Important

The API key is displayed only once at the time of generation. Copy and store it securely before leaving the page. It cannot be retrieved after you close the window.

Generate an API key

  1. In the CertCentral main menu, go to Automation > API Keys.

  2. Select Add API Key.

  3. In the Add API Key window, enter a description for the key. Use a name that identifies the integration or user it is linked to.

  4. In the User menu, select one of the following:

    • An existing CertCentral user: the key inherits that user's permissions

    • Create new service user: creates a service user with API-only access

      If you select Create new service user:r:

      • Enter the email address for the service user

      • (Optional) Select the divisions to restrict the service user to

      Notice

      The division restriction option appears only when divisions are enabled in your account.

  5. (Optional) Under API key restrictions, select the actions the key is permitted to perform. Leave blank to allow all actions the linked user can perform.

  6. Select Add.

Copy the API key immediately and store it in a secure location. You can create a maximum of 30 API keys per session. Return to Automation > API Keys at any time to view, edit, or revoke existing keys.