List domains
GET https://www.digicert.com/services/v2/domain
Use this endpoint to list all domains in your account.
Example requests and responses
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.
Name | Req/Opt | Type | Description |
---|---|---|---|
include_dcv_expiration_time | optional | boolean | Changes the format and timezone of DCV expiration values returned in the If If |
filters[ | optional | string | Filters results by the specified property. Replace
|
filters[search] | optional | string | Limits response to results where the value of the To search for values that contain a specific string of characters, prefix the string with a URL encoded (percent-encoded) % character: Examples:
|
sort | optional | string | Sorts 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:
|
limit | optional | int | Total number of results to include in the response. Max: |
offset | optional | int | Index of the first result to include in the response. Default: |
Response parameters
Name | Type | Description |
---|---|---|
domains | array | List of domains returned by request. |
.. id | int | Domain ID. |
.. is_active | bool | Active status of the domain. |
.. name | string | Name of the domain. |
.. dcv_approval_datetime | string | Completion 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_datetime | string | Expiration 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_datetime | string | Date 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_created | string | Timestamp of when the domain was added. Format: UTC timezone and ISO 8601 date |
.. domain_locking_status | string | Domain lock status. Domain locking prevents users in other CertCentral accounts from requesting certificates for the domain. A domain only returns the Possible values:
|
.. account_token | string | Account token to use for domain locking. A domain only returns the
|
.. organization | object | Organization attached to the domain. |
.. .. id | int | Organization ID. |
.. .. status | string | Validation status of the organization. |
.. .. name | string | Legal name of the organization. |
.. .. assumed_name | string | Public name of the organization. Also called DBA name. |
.. .. display_name | string | Full name of the organization. Constructed using name + assumed_name. |
.. is_active | string | Active status of the organization. |
.. validations | array | List of validation details for the domain. To see the structure of data objects in the Note: For each domain, the List domains endpoint only returns validations with an |
.. dcv_method | string | Domain control validation method configured for the domain. See Glossary – DCV methods. |
.. dcv_expiration | string | If DCV is completed, this object is returned with information about when OV and EV domain validations expire. |
.. .. ev | string | Expiration date for EV domain validation. Format:
|
.. .. ov | string | Expiration 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_shortened | string | New 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 Format:
Note: After September 27, 2021, the |
.. .. ov_status | string | OV domain validation status. Only returned if request URL includes the query string Possible values:
Note: After September 27, 2021, the |
.. .. ev_status | string | EV domain validation status. Only returned if request URL includes the query string Possible values:
|
.. .. dcv_approval_date | string | Date of the most recent DCV approval for the domain. Only returned if the request URL includes the query string Format:
|
.. container | object | Container the domain is attached to. |
.. .. id | int | Container ID. |
.. .. parent_id | int | ID of the container's parent. |
.. .. name | string | Name of the container. |
.. .. is_active | bool | Active status of the container. |
.. base_domain | string | Base domain of the domain Note: If the domain |
object | Details about results. Modified using URL query strings. |
Validation filter values
This table shows allowed values for the filters[validation]
URL query string.
Name | Description |
---|---|
| Domain validation is complete. Only includes domains with an active OV or EV domain validation status. |
| OV domain validation is expired. |
| EV domain validation is expired. |
| OV domain validation expires in the next 30 days. |
| EV domain validation expires in the next 30 days. |
| On 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 |
| OV domain validation expired between 7 days ago (inclusive) and today (exclusive). |
| OV domain validation expires in the next 0 (inclusive) to 7 (inclusive) days. |
| OV domain validation expires in the next 0 (inclusive) to 30 (inclusive) days. |
| OV domain validation expires in the next 31 (inclusive) to 60 (inclusive) days. |
| OV domain validation expires in the next 61 (inclusive) to 90 (inclusive) days. |
| EV domain validation expired between 7 days ago (inclusive) and today (exclusive). |
| EV domain validation expires in the next 0 (inclusive) to 7 (inclusive) days. |
| EV domain validation expires in the next 0 (inclusive) to 30 (inclusive) days. |
| EV domain validation expires in the next 31 (inclusive) to 60 (inclusive) days. |
| EV domain validation expires in the next 61 (inclusive) to 90 (inclusive) days. |