Use this endpoint to list all domains in your account.
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);
});
{
"domains": [
{
"id": 2,
"is_active": true,
"name": "underlier-stanislavsky.org",
"date_created": "2018-11-08T23:38:02+00:00",
"organization": {
"id": 516680,
"status": "active",
"name": "Example Company, Inc.",
"display_name": "Example Company, Inc.",
"is_active": "1"
},
"validations": [
{
"type": "ev",
"name": "EV",
"description": "Extended Organization Validation (EV)",
"date_created": "2020-03-11T23:51:24+00:00",
"validated_until": "2021-04-11T06:00:00+00:00",
"status": "active"
},
{
"type": "ov",
"name": "OV",
"description": "Normal Organization Validation",
"date_created": "2020-03-11T23:51:24+00:00",
"validated_until": "2022-06-14T06:00:00+00:00",
"status": "active"
}
],
"dcv_method": "email",
"dcv_expiration": {
"ov": "2021-01-01T23:59:59+00:00"
"ev": "2020-01-01T23:59:59+00:00"
},
"container": {
"id": 93288,
"parent_id": 0,
"name": "DigiCert Inc.",
"is_active": true
}
},
{
"id": 1,
"is_active": true,
"name": "entitative-absurdly.org",
"date_created": "2018-11-01T17:44:31+00:00",
"organization": {
"id": 516681,
"status": "active",
"name": "Lackadaisically Fumiest Inc.",
"assumed_name": "Lackadaisically Fumiest",
"display_name": "Lackadaisically Fumiest Inc. (Lackadaisically Fumiest)",
"is_active": "1"
},
"validations": [
{
"type": "ev",
"name": "EV",
"description": "Extended Organization Validation (EV)",
"date_created": "2020-03-11T23:51:24+00:00",
"validated_until": "2021-04-11T06:00:00+00:00",
"status": "active"
},
{
"type": "ov",
"name": "OV",
"description": "Normal Organization Validation",
"date_created": "2020-03-11T23:51:24+00:00",
"validated_until": "2022-06-14T06:00:00+00:00",
"status": "active"
}
],
"dcv_method": "email",
"dcv_expiration": {
"ov": "2021-01-01T23:59:59+00:00"
"ev": "2020-01-01T23:59:59+00:00"
},
"container": {
"id": 93288,
"parent_id": 0,
"name": "DigiCert Inc.",
"is_active": true
}
}
],
"page": {
"total": 2,
"limit": 1000,
"offset": 0
}
}
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 |
---|---|---|---|
container_id | optional | int | List domains assigned to the specified container. |
filters[{{property_name}} ]
|
optional | string |
Filters results by the specified property. Replace {{property_name}} in your request with the property to use for filtering. This endpoint supports filtering by the following properties:
|
filters[search] | optional | string |
Limits response to results where the value of the name property matches or contains a specific string of characters.To search for values that contain a specific string of characters, prefix the string with a URL encoded (percent-encoded) % character: %25 . To search for values that are an exact match for a string of characters, omit the %25 from the request.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: 1000 (default)
|
offset | optional | int |
Index of the first result to include in the response. Default: 0
|
Name | Type | Description |
---|---|---|
domains | array | List of domains returned by request. |
.. id | int | Domain ID. |
.. is_active | bool | Active status of the domain. |
.. status | string | Validation status of the domain. |
.. name | string | Name of the domain. |
.. date_created | string |
Timestamp of when the domain was added. Format: UTC timezone and ISO 8601 date |
.. 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 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_method | string |
Domain control validation method configured for the domain. See Glossary – DCV methods |
.. dcv_expiration | string |
If the DCV has been completed, this object is returned and contains information about when the validations expire. Only returned if URL query include_validation=true .
|
.. .. ov | string |
Timestamp of when validation expires. Format: UTC time zone and ISO 8601 date |
.. .. ev | string |
Timestamp of when validation expires. Format: UTC time zone and ISO 8601 date |
.. dcv_token | object | If DCV method uses a random value token, this object is returned and contains token information. |
.. .. token | string | Random value used to prove control over the domain. |
.. .. status | string | Status of the domain validation process. |
.. .. expiration_date | string |
Timestamp of when the token will expire. Format: UTC timezone and ISO 8601 date |
.. 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. |
page | object |
Details about results. Modified using URL query strings. |