Automation API

The Automation API helps organizations simplify and scale their TLS/SSL certificate lifecycle management. Instead of manually ordering, configuring, and installing certificates across servers and devices, the Automation API integrates with your systems to:

Each request to the Automation API must include an API key. This is done using the custom HTTP header X‑DC‑DEVKEY. The value for this header is the same API key used to authenticate requests to the other CertCentral APIs.

To learn more about generating an API key and authenticating to CertCentral APIs, see Authentication.

Also, verify that your account has the necessary permissions to execute specific API request. For more information, see List permissions and Check permission.

Use this base URL when constructing Automation API requests:

https://caas.digicert.com/automationws/v1

All API requests are submitted via RESTful URLs using REST features, including header-based authentication and JSON/XML request types.

The data character set encoding for requests is UTF-8. A well-formed request uses port 443 and has the user-agent and content-length headers specified.

The Automation API uses these standard HTTP methods:

Most requests require passing JSON formatted data. If an endpoint supports or requires a different format, it will be noted for that endpoint.

Supported content-type values include:

Responses consist of headers and a body. The body is formatted based on the content-type specified in the request.

See Glossary – Headers for information about HTTP header response codes.

To view the errors returned by the DigiCert CertCentral® API and their descriptions, see Errors.

Some requests that return many results support filtering, sorting, and pagination. In the Automation API, the syntax for filtering and sorting data requires that you include the searchCriteriaList and sorting parameters in the request body.

To see which properties an endpoint supports for filtering and sorting, check the reference documentation for the endpoint. For general information and examples of the syntax to use when applying filters and sorting results, see the parameter descriptions and examples below.

In the sample request body for the Get agent list endpoint below, we use the searchCriteriaList array to limit the response to results where the AGENTSTATUS property has a value of Not Configured. Results are sorted in descending order by the value of the agentName property.

{
    "accountId": 5153184,
    "searchCriteriaList": [
        {
            "key": "AGENTSTATUS",
            "operation": "EQUALS",
            "value": [
                "Not Configured"
            ]
        }
    ],
    "divisionIds": [],
    "startIndex": 1,
    "pageSize": 50,
    "sorting": {
        "agentName": "DESC"
    }
}

In this next sample request body for the Get automation IPs list endpoint, we use the searchCriteriaList array to limit the response to results that meet the following criteria:

Results are sorted in ascending order by the value of the commonName property.

{
    "accountId": 5153184,
    "searchCriteriaList": [
        {
            "key": "AUTOMATION_STATUS",
            "operation": "EQUALS",
            "value": [
                "SUCCESSFULLY_RENEWED"
            ]
        },
        {
            "key": "LB_APP_NAME",
            "operation": "LIKE",
            "value": [
                "Tomcat"
            ]
        }
    ],
    "divisionIds": [],
    "pageSize": 50,
    "startIndex": 1,
    "sorting": {
        "commonName": "ASC"
    }
}

The DigiCert CertCentral® managed automation solution uses the Automation API to provide an end-to-end workflow for automating certificate lifecycle management for your VMs and servers. A typical workflow can include the following actions: