Skip to main content

API guide

Updated

Overview

This guide provides step-by-step instructions for testing DigiCert®​​ DNS's API endpoints using an API key generated within the DigiCert®​​ DNS platform. Follow the procedure in order, or start at Step 2 if you already have an API key.

The full procedure includes:

  1. Generating an API key: Generate an API key within DigiCert®​​ DNS to authenticate requests to the API.
  2. Accessing the DigiCert DNS API: Locate and review available API endpoints and their specifications.
  3. Generating an authentication token: Use your API key to generate a bearer token for authorized access.
  4. Testing an endpoint: Make a request to your chosen endpoint using the authentication token.

Downloads

API Version Format File Type Notes
1.4.0 JSON Resolved Ideal for quick imports into Postman or other testing tools
Unresolved Ideal for use in automated pipelines
YAML Resolved Ideal for manually reviewing the API definition file
Unresolved Ideal for editing and maintaining the definition file in a modular format

Procedure

Generate an API key

Notice

This procedure generates two API keys: apikey1 and apikey2. These API keys are referenced in other procedures.

To test this function, call this API endpoint: POST /accessmanagement/api-key

  1. Sign in to your DigiCert®​​ DNS account.
  2. From the landing page, select the user icon in the top right corner and select My API Keys.

  3. Select the Generate API Key button.

    A maximum of two API keys can exist at any given time.

  4. In the Generate API Key dialog:
    1. Enter a name for the key in the Name field (for example, apikey1).

    2. Select an expiration option.

      The default expiration date is set to one year from the current date.

    3. (Optional) Add a note.

      This can be viewed later by selecting the note icon next to the key.

    4. Select Save to generate the API key.
  5. In the API Key Generated - Action Required dialog:
    1. Select Copy to copy the generated key.

    2. Select Done to complete the process.

      A message appears confirming the successful generation of the API key.

  6. Repeat Steps 3-5 to create another API key, apikey2.

Access the DigiCert DNS API

Notice

This procedure explains how to access the DigiCert®​​ DNS API by importing the definition file into a testing tool. While this guide uses Postman, other API testing tools can also be used.

  1. Navigate to the Downloads section above.
  2. Download the file you wish to import into Postman.
  3. Log in to Postman.
  4. In Postman:

    1. If this is a new instance, go to Get Started > Import APIs and collections, then select Import.

      Alternatively, select the Import button in the My Workspace sidebar.

    2. Locate the file downloaded in Step 2.
    3. In the Choose how to import your Specification dialog:
      1. Confirm your file selection.
      2. Select an import setting:
        1. Postman Collection: Ideal for quickly testing and running pre-built API requests.

        2. OpenAPI 3.0 Specification with a Postman Collection: Ideal for importing a full API definition with schema, for documentation and lifecycle management.

          DigiCert​​®​​ recommends selecting this option.

      3. Select Import.
    4. Confirm that DigiCert DNS appears in your workspace.

Generate an authentication token

Notice

This procedure uses the API key generated in an earlier procedure to request an authentication token in Postman. The token is valid for one hour and must be refreshed before it expires. If the token is not regenerated in time, API endpoints cannot be tested. If the user no longer has access to their API key when the token expires, a new API key must be generated to obtain a new token.

To test this function, call this API endpoint: POST /auth/login

  1. Log in to Postman.
  2. In the My Workspace sidebar, navigate to DigiCert DNS > auth > login > POST /auth/login:
    1. Go to the Authorization tab, and in the Token field, paste your API key.
    2. Select Send.
    3. In the response window, copy the authentication token.
  3. In the My Workspace sidebar, select DigiCert DNS:
    1. Go to the Auth tab, and paste your authentication token into the Token field.
    2. Under the Add variable to heading, select Collection.

Test an endpoint

Notice

This procedure explains how to use an authentication token to test endpoints in DigiCert®​​ DNS. While this example tests an endpoint that returns the user's activity log, the same approach can be used to test any endpoint.

  1. Log in to Postman.
  2. In the My Workspace sidebar, navigate to DigiCert DNS.
  3. Select an endpoint you want to test, for example, GET /activitylog.

  4. Select Send.

    The response window will populate with the API response.