Skip to main content

Create your API key

You can generate an API key to securely authenticate DigiCert ONE API requests. Your API key will have the same user roles as your user profile in DigiCert ONE. Creating an API key may be useful to you if:

  • You prefer key-based authentication for simplicity and ease of integration.

  • Your application does not support certificate-based authentication.

  • You need a quick way to authenticate API requests without managing certificates.

  • The API you are using requires both an API key and a client authentication certificate for added security.

Note

Include the API key in the request header to authenticate API calls.

Before you begin

It may be useful to consider the following before you begin:

  • Store your API key securely—it cannot be retrieved after generation.

  • You can optionally set an expiration date for the API key:

    • If set, the key will expire on the chosen date and cannot be updated.

    • If no expiration is set, the key remains valid until manually revoked.

  • Avoid exposing your API key in public repositories or shared codebases.

To create your API key

  1. Sign in to DigiCert ONE.

  2. In the top-right corner, select the profile icon > Admin Profile.

  3. On the Admin page, in the API Tokens section, select Create API token.

  4. On the Create API token page, add the details as needed:

    1. Name

      Enter a name for the API token. This name is the display name on the API token cards. The name must be unique and only include letters, numbers, spaces, dashes, and underscores.

    2. End date (optional)

      Adding an end date is not required. The end date is in UTC. For example, if you select 12 August 2023 as your end date, your API token expires on 12 August 2023 at 23:59:59 UTC.

      Note

      If you add an end date, make sure to note when the API token expires. You must update all API integrations using the API token before it expires. If you don't, the API token integrations will stop working.

      You can always edit the API token details and extend the expiration date before it expires.

  5. Select Create.

  6. On the Congratulations page, copy the API token and save it in a secure location so you can use it later.

    Important

    The API token is only displayed only once. You cannot access it after you select Finish. If you ever lose the API token, you'll need to delete the lost token and create a new one.

  7. After you save the token, select Finish.

Publication date: