List domains

GET https://www.digicert.com/services/v2/domain
Use this endpoint to list all domains in your account.

Example requests and responses

curl -X GET \
  'https://www.digicert.com/services/v2/domain' \
  -H 'Content-Type: application/json' \
  -H 'X-DC-DEVKEY: {{api_key}}'
import requests

url = "https://www.digicert.com/services/v2/domain"

headers = {
    'X-DC-DEVKEY': "{{api_key}}",
    'Content-Type': "application/json"
    }

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

print(response.text.encode('utf8'))
package main

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

func main() {

		url := "https://www.digicert.com/services/v2/domain"
		method := "GET"

		client := &http.Client {
		}
		req, err := http.NewRequest(method, url, nil)

		if err != nil {
				fmt.Println(err)
		}
		req.Header.Add("X-DC-DEVKEY", "{{api_key}}")
		req.Header.Add("Content-Type", "application/json")

		res, err := client.Do(req)
		defer res.Body.Close()
		body, err := ioutil.ReadAll(res.Body)

		fmt.Println(string(body))
}
var request = require("request");

var options = {
  method: 'GET',
  url: 'https://www.digicert.com/services/v2/domain',
  headers: {
    'Content-Type': 'application/json',
    'X-DC-DEVKEY': '{{api_key}}'
    }
  };

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

  console.log(body);
});

200 OK (include_validation_reuse_status = true)

{
  "domains": [
    {
      "id": 12345,
      "is_active": true,
      "name": "example.org",
      "date_created": "2022-02-10T15:24:08+00:00",
      "last_submitted_datetime": "2022-02-28T08:03:06+00:00",
      "dcv_approval_datetime": "2022-02-24T06:49:33+00:00",
      "organization": {
        "id": 1560288,
        "status": "active",
        "name": "Example Org",
        "display_name": "Example Org",
        "is_active": "1"
      },
      "validations": [
        {
          "type": "ev",
          "name": "EV",
          "description": "Extended Organization Validation (EV)",
          "date_created": "2022-02-24T06:49:33+00:00",
          "validated_until": "2023-03-27T06:00:00+00:00",
          "status": "active"
        },
        {
          "type": "ov",
          "name": "OV",
          "description": "Normal Organization Validation",
          "date_created": "2022-02-24T06:49:33+00:00",
          "validated_until": "2023-03-27T06:00:00+00:00",
          "status": "active"
        }
      ],
      "dcv_method": "email",
      "dcv_expiration": {
        "ev": "2023-03-27",
        "ov": "2023-03-27",
        "ov_shortened": "2023-03-27",
        "ov_status": "valid",
        "ev_status": "valid",
        "dcv_approval_date": "2022-02-23"
      },
      "container": {
        "id": 677797,
        "name": "Example Division"
      },
      "base_domain": "example.org",
      "dcv_approval_method": "dns-txt-token"
    }
  ],
  "page": {
    "total": 1,
    "limit": 1000,
    "offset": 0
  }
}

Filters and URL query parameters

This endpoint supports filters, sorting, and pagination. For general information and examples of the syntax to use when applying filters and sorting results, see Services API - Filters, sorting, and pagination parameters.

NameReq/OptTypeDescription
include_dcv_expiration_timeoptionalbooleanChanges the format and timezone of DCV expiration values returned in the dcv_expiration object (ev, ov, ov_shortened, and dcv_approval_date).
If true, the dcv_expiration object returns DCV expiration values formatted as a UTC ISO-8601 string. Example: YYYY-MM-DDThh:mm:ss+00:00.
If false (default), the dcv_expiration object returns DCV expiration values in Mountain Time (MT) in YYYY-MM-DD format with no timestamp.
filters[{{property_name}}]optionalstringFilters results by the specified property. Replace {{property_name}} in your request with the property to use for filtering. This endpoint supports the following filters:
filters[search]optionalstringLimits response to results where the value of the name property matches or contains a specific string of characters.
Example:
filters[search]=example
Returns results where the value of the searched property contains the string example.
filters[search_criteria]optionalstringUse filters[search_criteria] to control how the domain search is performed—that is, whether the API returns an exact domain match or a partial (substring) match.
By default, the API returns the partial match of the search term. This default behavior is based on your account configuration.
If you are getting an exact match in your API response and you want to get a partial match response, include the following in your API request: filters[search_criteria]=partial.
Example:
If an account contains the domains domain.com and 123.domain.com, the API returns different results depending on the search criteria:
sortoptionalstringSorts results by the value of one or more properties. By default, sorts results in ascending alphabetical order (0-9, A-Z).
To sort in descending alphabetical order (9-0, Z-A), prefix the property name with a minus (-).
To sort by multiple properties, separate the name of each property with a comma. Sort hierarchy matches the order of properties in this list. This endpoint supports sorting by the following properties:
limitoptionalintTotal number of results to include in the response.
Max:1000 (default)
offsetoptionalintIndex of the first result to include in the response.
Default:0

Response parameters

NameTypeDescription
domainsarrayList of domains returned by request.
.. idintDomain ID.
.. is_activeboolActive status of the domain.
.. namestringName of the domain.
.. dcv_approval_datetimestringCompletion date and time (UTC) of the most recent DCV check for the domain. Returned for all domains you have completed a DCV check for at least once.
Format: UTC timezone and ISO 8601 date
.. dcv_expiration_datetimestringExpiration date and time (UTC) of the most recent DCV check for the domain. Returned for all domains you have completed a DCV check for at least once.
Format: UTC timezone and ISO 8601 date
.. last_submitted_datetimestringDate and time (UTC) the domain was last submitted for DCV.
Format: UTC timezone and ISO 8601 date
Note: Only returned for domains submitted for validation or revalidation after March 3, 2022 .
.. date_createdstringTimestamp of when the domain was added.
Format: UTC timezone and ISO 8601 date
.. domain_locking_statusstringDomain lock status. Domain locking prevents users in other CertCentral accounts from requesting certificates for the domain.
A domain only returns the domain_locking_status property if domain locking is enabled for the account. See Domain locking – Enable domain locking for your account.
Possible values:
.. account_tokenstringAccount token to use for domain locking.
A domain only returns the account_token parameter if these conditions are met:
.. organizationobjectOrganization attached to the domain.
.. .. idintOrganization ID.
.. .. statusstringValidation status of the organization.
.. .. namestringLegal name of the organization.
.. .. assumed_namestringPublic name of the organization. Also called DBA name.
.. .. display_namestringFull name of the organization. Constructed using name + assumed_name.
.. is_activestringActive status of the organization.
.. validationsarrayList of validation details for the domain.
To see the structure of data objects in the validations array, see Structures – Validations object.
Note: For each domain, the List domains endpoint only returns validations with an active status. If a domain has no active validations, we do not return the validations array for that domain. To see all of the validations for a domain (including pending and expired validations), use the Domain info endpoint.
.. dcv_methodstringDomain control validation method configured for the domain. See Glossary – DCV methods.
.. dcv_expirationstringIf DCV is completed, this object is returned with information about when OV and EV domain validations expire.
.. .. evstringExpiration date for EV domain validation.
Format:
.. .. ovstringExpiration date for OV domain validation.
Format:
Note: On September 27, 2021, the expiration date for existing OV domain validations will shorten to 397 days from the date validation was completed. Learn more about this policy change: Domain validation changes in 2021.
.. .. ov_shortenedstringNew expiration date for OV domain validation after industry changes to shorten the domain validation reuse period go into effect on September 27, 2021. Only returned if the request URL includes the query string filters[include_validation_reuse_status]=true.
Format:
Note: After September 27, 2021, the dcv_expiration.ov_shortened parameter will return the same date as the dcv_expiration.ov parameter. Learn more about this policy change: Domain validation changes in 2021.
.. .. ov_statusstringOV domain validation status. Only returned if request URL includes the query string filters[include_validation_reuse_status]=true.
Possible values:
Note: After September 27, 2021, the ov_status parameter will stop returning industry_shortened_expired and industry_shortened_expiring_soon values. Learn more about this policy change: Domain validation changes in 2021.
.. .. ev_statusstringEV domain validation status. Only returned if request URL includes the query string filters[include_validation_reuse_status]=true
Possible values:
.. .. dcv_approval_datestringDate of the most recent DCV approval for the domain. Only returned if the request URL includes the query string filters[include_validation_reuse_status]=true.
Format:
.. containerobjectContainer the domain is attached to.
.. .. idintContainer ID.
.. .. parent_idintID of the container’s parent.
.. .. namestringName of the container.
.. .. is_activeboolActive status of the container.
.. base_domainstringBase domain of the domain name. For example, if the domain name is sub.example.com, the base_domain is example.com.
Note: If the domain name is an IP address, the base_domain is also the IP address.
dcv_approval_methodstringDomain control validation method used to complete the most recent DCV check. See Glossary – DCV methods.
pageobjectDetails about results. Modified using URL query strings.

Validation filter values

This table shows allowed values for the filters[validation] URL query string.

NameDescription
completedDomain validation is complete. Only includes domains with an active OV or EV domain validation status.
ov_expiredOV domain validation is expired.
ev_expiredEV domain validation is expired.
ov_expiringOV domain validation expires in the next 30 days.
ev_expiringEV domain validation expires in the next 30 days.
shortened_by_industry_changesOn September 27, 2021, OV validation for the domain will be reduced. The reduced validation period will have expired or will expire before December 1, 2021.
Note: After September 27, the shortened_by_industry_changes filter value will be ignored. On September 27, 2021, DigiCert shortens the domain validation reuse period for OV certificates to 397 days. Learn more about this policy change: [Domain validation changes in 2021](https://knowledge.digicert.com/alerts/domain-authentication-changes-in-2021.html title=).
ov_expired_in_last_7_daysOV domain validation expired between 7 days ago (inclusive) and today (exclusive).
ov_expiring_within_7_daysOV domain validation expires in the next 0 (inclusive) to 7 (inclusive) days.
ov_expiring_within_30_daysOV domain validation expires in the next 0 (inclusive) to 30 (inclusive) days.
ov_expiring_from_31_to_60_daysOV domain validation expires in the next 31 (inclusive) to 60 (inclusive) days.
ov_expiring_from_61_to_90_daysOV domain validation expires in the next 61 (inclusive) to 90 (inclusive) days.
ev_expired_in_last_7_daysEV domain validation expired between 7 days ago (inclusive) and today (exclusive).
ev_expiring_within_7_daysEV domain validation expires in the next 0 (inclusive) to 7 (inclusive) days.
ev_expiring_within_30_daysEV domain validation expires in the next 0 (inclusive) to 30 (inclusive) days.
ev_expiring_from_31_to_60_daysEV domain validation expires in the next 31 (inclusive) to 60 (inclusive) days.
ev_expiring_from_61_to_90_daysEV domain validation expires in the next 61 (inclusive) to 90 (inclusive) days.