List certificates

POST https://daas.digicert.com/apicontroller/v1/certificate/list
Get a total count and list of all certificates found through CertCentral Discovery scans. Optionally filter results by certificate attributes.

Example requests and responses

curl -X POST \
  https://daas.digicert.com/apicontroller/v1/certificate/list \
  -H 'Content-Type: application/json' \
  -H 'X-DC-DEVKEY: {{api_key}}' \
  -d '{
    "searchCriteriaList": [
        {
            "key":"cn",
            "operation": "EQUALS",
            "value": [
                "www.digicert.com","www.cert.com","docs.digicert.com"
            ]
        },
        {
            "key":"org",
            "operation": "EQUALS",
            "value": [
                "DigiCert Inc"
            ]
        },
        {
            "key":"status",
            "operation": "EQUALS",
            "value": [
                "VALID"
            ]
        },
        {
            "key":"serialNum",
            "operation": "EQUALS",
            "value": [
                "0eb6eab418c873d8f3c031dcdddf18b0"
            ]
        },
        {
            "key":"securityRating",
            "operation": "EQUALS",
            "value": [
                "Not secure","At risk"
            ]
        },
        {
            "key":"ca",
            "operation": "EQUALS",
            "value": [
                "DigiCert SHA2 Secure Server CA"
            ]
        },
        {
            "key":"daysToExpire",
            "operation": "EQUALS",
            "value": [
                "90"
            ]
        },
        {
            "key":"tags",
            "operation": "EQUALS",
            "value": [
                "internal","devbox"
            ]
        }
    ],
    "accountId": "126993",
    "divisionIds": [],
    "startIndex": 1,
    "pageSize": 50,
    "sortedColumnId": "cn",
    "sortOrder": "ASC"
}'
import requests

url = "https://daas.digicert.com/apicontroller/v1/certificate/list"

payload = "{\n    \"searchCriteriaList\": [\n        {\n            \"key\": \"cn\",\n            \"operation\": \"EQUALS\",\n            \"value\": [\n                \"www.digicert.com\",\"www.cert.com\",\"docs.digicert.com\"\n            ]\n        },\n        {\n            \"key\": \"org\",\n            \"operation\": \"EQUALS\",\n            \"value\": [\n                \"DigiCert Inc\"\n            ]\n        },\n        {\n            \"key\": \"status\",\n            \"operation\": \"EQUALS\",\n            \"value\": [\n                \"VALID\"\n            ]\n        },\n        {\n            \"key\": \"serialNum\",\n            \"operation\": \"EQUALS\",\n            \"value\": [\n                \"0eb6eab418c873d8f3c031dcdddf18b0\"\n            ]\n        },\n        {\n            \"key\": \"securityRating\",\n            \"operation\": \"EQUALS\",\n            \"value\": [\n                \"Not secure\",\"At risk\"\n            ]\n        },\n        {\n            \"key\": \"ca\",\n            \"operation\": \"EQUALS\",\n            \"value\": [\n                \"DigiCert SHA2 Secure Server CA\"\n            ]\n        },\n        {\n            \"key\": \"daysToExpire\",\n            \"operation\": \"EQUALS\",\n            \"value\": [\n                \"90\"\n            ]\n        },\n        {\n            \"key\": \"tags\",\n            \"operation\": \"EQUALS\",\n            \"value\": [\n                \"internal\",\"devbox\"\n            ]\n        }\n    ],\n    \"accountId\": \"126993\",\n    \"divisionIds\": [],\n    \"startIndex\": 1,\n    \"pageSize\": 50,\n    \"sortedColumnId\": \"cn\",\n    \"sortOrder\": \"ASC\"\n}"
headers = {
    'X-DC-DEVKEY': "{{api_key}}",
    'Content-Type': "application/json",
    }

response = requests.request("POST", url, data=payload, headers=headers)

print(response.text)
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://daas.digicert.com/apicontroller/v1/certificate/list"

	payload := strings.NewReader("{\n    \"searchCriteriaList\": [\n        {\n            \"key\": \"cn\",\n            \"operation\": \"EQUALS\",\n            \"value\": [\n                \"www.digicert.com\",\"www.cert.com\",\"docs.digicert.com\"\n            ]\n        },\n        {\n            \"key\": \"org\",\n            \"operation\": \"EQUALS\",\n            \"value\": [\n                \"DigiCert Inc\"\n            ]\n        },\n        {\n            \"key\": \"status\",\n            \"operation\": \"EQUALS\",\n            \"value\": [\n                \"VALID\"\n            ]\n        },\n        {\n            \"key\": \"serialNum\",\n            \"operation\": \"EQUALS\",\n            \"value\": [\n                \"0eb6eab418c873d8f3c031dcdddf18b0\"\n            ]\n        },\n        {\n            \"key\": \"securityRating\",\n            \"operation\": \"EQUALS\",\n            \"value\": [\n                \"Not secure\",\"At risk\"\n            ]\n        },\n        {\n            \"key\": \"ca\",\n            \"operation\": \"EQUALS\",\n            \"value\": [\n                \"DigiCert SHA2 Secure Server CA\"\n            ]\n        },\n        {\n            \"key\": \"daysToExpire\",\n            \"operation\": \"EQUALS\",\n            \"value\": [\n                \"90\"\n            ]\n        },\n        {\n            \"key\": \"tags\",\n            \"operation\": \"EQUALS\",\n            \"value\": [\n                \"internal\",\"devbox\"\n            ]\n        }\n    ],\n    \"accountId\": \"126993\",\n    \"divisionIds\": [],\n    \"startIndex\": 1,\n    \"pageSize\": 50,\n    \"sortedColumnId\": \"cn\",\n    \"sortOrder\": \"ASC\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-DC-DEVKEY", "{{api_key}}")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
var request = require("request");

var options = { method: 'POST',
  url: 'https://daas.digicert.com/apicontroller/v1/certificate/list',
  headers: 
   { 'Content-Type': 'application/json',
     'X-DC-DEVKEY': '{{api_key}}' },
  body: 
   { searchCriteriaList: 
      [ { key: 'cn', operation: 'EQUALS', value: [ 'www.digicert.com','www.cert.com','docs.digicert.com' ] },
        { key: 'org', operation: 'EQUALS', value: [ 'DigiCert Inc' ] },
        { key: 'status', operation: 'EQUALS', value: [ 'VALID' ] },
        { key: 'serialNum', operation: 'EQUALS', value: [ '0eb6eab418c873d8f3c031dcdddf18b0' ] },
        { key: 'securityRating', operation: 'EQUALS', value: [ 'Not secure','At risk' ] },
        { key: 'ca', operation: 'EQUALS', value: [ 'DigiCert SHA2 Secure Server CA' ] },
        { key: 'daysToExpire', operation: 'EQUALS', value: [ '90' ] },
        { key: 'tags', operation: 'EQUALS', value: [ 'internal','devbox' ] } ],
     accountId: '126993',
     divisionIds: [],
     startIndex: 1,
     pageSize: 50,
     sortedColumnId: 'cn',
     sortOrder: 'ASC' },
  json: true };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

200 OK

{
    "data": {
        "totalCount": 81,
        "currentCount": 50,
        "certificateDetailsDTOList": [
            {
                "certId": "fb92ee3a2fd0cb6549e58c252f8787f467bfbeff",
                "serialNum": "2bf1c0d8a20fef721f67011d6231c16e",
                "validFrom": 1523318400000,
                "expiryDate": 1591660799000,
                "subject": "CN=*.aparat.com,OU=EssentialSSL Wildcard,OU=Domain Control Validated",
                "issuedBy": "CN=COMODO RSA Domain Validation Secure Server CA, O=COMODO CA Limited, L=Salford, ST=Greater Manchester, C=GB",
                "cn": "*.aparat.com",
                "ca": "Comodo",
                "lastDiscoveredDate": 1645007394721,
                "firstDiscoveredDate": 1561409074447,
                "keyLength": 2048,
                "algoType": "SHA256withRSA",
                "accountId": null,
                "certStatusString": "VALID",
                "owner": "",
                "org": null,
                "orgUnit": "Domain Control Validated",
                "city": "",
                "state": "",
                "country": "",
                "sanCount": 2,
                "publicKeyAlgo": "RSA",
                "san": "isBlobUTF8=true;[2, *.aparat.com];[2, aparat.com]",
                "certRating": "Secure",
                "tags": "",
                "certStatusError": null,
                "certIssues": "CRLDistributionPoints"
            },
            {
                "certId": "4c5d6a9813d3c858ac1ba279a3dd318460bc9ad7",
                "serialNum": "040b914d32914ffc2474a3fdfd892c99",
                "validFrom": 1539734400000,
                "expiryDate": 1573992000000,
                "subject": "CN=espn.com",
                "issuedBy": "CN=Amazon, OU=Server CA 1B, O=Amazon, C=US",
                "cn": "espn.com",
                "ca": "Amazon",
                 
                "firstDiscoveredDate": 1563917838074,
                "keyLength": 2048,
                "algoType": "SHA256withRSA",
                "accountId": null,
                "certStatusString": "VALID",
                "owner": "",
                "org": null,
                "orgUnit": "",
                "city": "",
                "state": "",
                "country": "",
                "sanCount": 6,
                "publicKeyAlgo": "RSA",
                "san": "isBlobUTF8=true;[2, espn.com];[2, *.espn.com];[2, *.geo.hosted.espn.com];[2, *.us-west-2.aws.hosted.espn.com];[2, *.core.api.espn.com];[2, *.api.espn.com]",
                "certRating": "Secure",
                "tags": "internal",
                "certStatusError": null,
                "certIssues": "IsAliasMatchSAN,CRLDistributionPoints",
                "renewalEmailPreference": true,
                "emailAddresses": "xyz@digicert.com, xy@digicert.com",
                "actions": {
                		"primaryAction": "TRANSFER",
                		"secondaryActions": ["VIEW_ENDPOINT"]},
                "filePath": null,
                "source": "Sensor",
                "serverHost": null,
	        "systemCert": false,
                "selfSignedCaOptIn": true
            }
        ]
    }
}

Request parameters

NameReq/OptTypeDescription
searchCriteriaListoptionalarrayGet records for specified criteria.
.. keyoptionalstringSearch parameter.
Allowed values: cn, org, status, serialNum, securityRating, ca, daysToExpire, tags
.. operationoptionalstringSearch operation.
Allowed value: EQUALS
.. valueoptionalarraySearch values.
accountIdrequiredstringAccount ID.
divisionIdsoptionalarrayDivision IDs.
startIndexoptionalintStart at the specified index.
Default:
1
pageSizeoptionalintNumber of records per page.
Default: 50,
Max: 100
sortedColumnIdoptionalstringSort results by specified parameter.
Allowed values: cn, org, status, serialNum, securityRating, ca, daysToExpire
Default: cn
sortOrderoptionalstringSort direction.
Allowed values: ASC (ascending: 0-9, A-Z), DESC (descending: 9-0, Z-A)
Default: ASC

Response parameters

NameTypeDescription
dataobjectContainer.
.. totalCountintTotal number of records that match search criteria.
.. currentCountintNumber of records on current page.
.. certificateDetailsDTOListarrayContainer for certificate details.
.. .. certIdstringUnique DigiCert-generated ID for the certificate. Use for API requests that require it.
.. .. serialNumstringSerial number assigned to the certificate on issuance.
.. .. validFromintegerValidity start date.
**Format:**epoch in millisecond.
Epoch corresponds to 0 hours, 0 minutes, and 0 seconds (00:00:00) Coordinated Universal Time (UTC) on a specific date, which varies from system to system.
Example: 1855828800000
.. .. expiryDateintegerValidity end date.
**Format:**epoch in millisecond.
Epoch corresponds to 0 hours, 0 minutes, and 0 seconds (00:00:00) Coordinated Universal Time (UTC) on a specific date, which varies from system to system.
Example: 1855828800000
.. .. subjectboolFull certificate distinguished name.
.. .. issuedBystringRoot certificate that the certificate was issued from.
.. .. cnstringCommon name on the certificate.
.. .. castringCertificate Authority that issued the certificate.
.. .. lastDiscoveredDateintegerDate certificate was last found by CertCentral Discovery scan.
.. .. firstDiscoveredDateintegerDate certificate was first found by CertCentral Discovery scan.
**Format:**epoch in millisecond.
Epoch corresponds to 0 hours, 0 minutes, and 0 seconds (00:00:00) Coordinated Universal Time (UTC) on a specific date, which varies from system to system.
Example: 1855828800000
.. .. keyLengthstringEncryption key size for the certificate.
.. .. algoTypestringEncryption algorithm that the certificate uses.
.. .. accountIdstringAccount ID.
.. .. certStatusStringstringStatus of the certificate.
.. .. ownerstringOwner as defined in CertCentral Discovery.
.. .. orgstringOrganization name on the certificate.
.. .. orgunitstringOrganization unit on the certificate.
.. .. citystringCity on the certificate.
.. .. statestringState on the certificate.
.. .. countrystringCountry on the certificate.
.. .. sanCountstringNumber of subject alternative names on the certificate.
.. .. publicKeyAlgostringEncryption algorithm for the certificate’s public key.
.. .. sanstringSubject alternative names on the certificate.
.. .. certRatingstringCertificate security rating, based on industry standards and the certificate’s settings.
.. .. tagsstringCustom tags added by certificate owner, subscriber, or other admin.
.. .. certStatusErrorstringErrors retrieving certificate status.
.. .. certIssuesstringChart data for certificate issues.
.. .. renewalEmailPreferencebooleanWhether renewal email preference is enabled or not.
Default: true
.. .. emailAddressesstringEmail address for the contact associated with the certificate.
.. .. actionsobjectAction performed on the certificate.
.. .. filePathstringFile path of the certificate.
Values are comma-separated.
.. .. sourcestringThe scan used to identify the certificate.
Possible values: sensor, agent
Note:Possible values areManual Upload, Cloud scan for server certificates.
.. .. serverHoststringThe server host associated with the certificate.
Values are comma-separated.
.. .. systemCertbooleanWhether any system certificates are available or not.
.. .. selfSignedCaOptInbooleanWhether email preference enabled for the self-signed certificates.