List domains

GET

https://www.digicert.com/services/v2/domain

Use this endpoint to list all domains in your account.

cURL

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

Python

import requests

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

querystring = {"include_validation":"true"}

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

response = requests.request("GET", url, headers=headers, params=querystring)

print(response.text)

package main

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

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	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))

}

NodeJS

var request = require("request");

var options = { method: 'GET',
  url: 'https://www.digicert.com/services/v2/domain',
  qs: { include_validation: 'true' },
  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

{
  "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
  }
}

URL query strings

Name	Req/Opt	Type	Description
container_id	optional	int	List domains assigned to the specified container.
include_validation	optional	bool	Includes validation info if `true`. Default: `false`
limit	optional	int	Truncate list to the specified number for pagination. Max: `1000` (default)
offset	optional	int	Start list at the specified number for pagination. Default: `0`

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.
.. 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. Only returned if URL query `include_validation=true`. See Structures – Validations object
.. 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.

URL query strings

Response parameters

About