Report Library API

Use the Report Library API to create reports for:

The Report Library API integrates with your systems to:

The Report Library API uses header-based API keys for authentication and authorization. To authenticate to the Report Library API service, use your CertCentral API key. For step-by-step instructions on creating an API key, see Authentication.

In requests to the Report Library API, place your API key in the custom HTTP header X-DC-DEVKEY . For example, here's a sample request to the List report history endpoint:

curl --request GET 'https://api.digicert.com/reports/v1/report/history' \
--header 'X-DC-DEVKEY: {{api_key}}' \
--header 'Content-Type: application/json'

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

Use this base URL when constructing Report Library API requests:

https://api.digicert.com/reports/v1/

Some GET requests return a list of records that you can filter, sort, and paginate using URL query strings.

The syntax for query strings is {{name}}={{value}}. To apply multiple filters, append each query string to the request URL with an & character. For example, this request to the List report history endpoint uses two filters:

https://api.digicert.com/reports/v1/report/history?report_type=orders&schedule=MONTHLY

To create a filter that matches more than one value, provide a comma-separated list of each value that meets your filter criteria. For example, this request to the same List report history endpoint uses a filter that matches against multiple values:

https://api.digicert.com/reports/v1/report/history?report_display_name=test,example

All requests you submit to the Report Library API use RESTful URLs and 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.

Requests that require a payload accept JSON-formatted data. Include the header content-type: application/json in your request.

Responses consist of headers and a body. Response headers are based on the RFC 2616 specification. 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.

All report types except FQDN are formatted as a single data structure (CSV, JSON) or spreadsheet (EXCEL) containing data for each row and column in the report. Reports with many rows are split into multiple files for download (see Download report - Reports with multiple files).

FQDN reports are formatted as an Excel workbook containing two worksheets:

The Report Library can only generate FQDN reports as Excel files. Additionally, large FQDN reports are not split into multiple files for download.

To give you time to download your data, DigiCert stores the results of each report run for several months.

By default, reports and API responses use English for column display names and report type descriptions. To translate these values into a language other than English, when you submit a request to an API that supports multiple languages, include the language_id query parameter in the request URL. Set the value of the language_id parameter to the ID of the language you want to use (see Glossary - Locale codes).

For example:

https://api.digicert.com/reports/v1/report/types?language_id=2

These GET requests support the option to return column display names and report type descriptions in another language:

To generate reports that use a language other than English for column headings, include the language_id query parameter in your request to create or edit a report.