Domain info

GET
https://www.digicert.com/services/v2/domain/{{domain_id}}

Use this endpoint to get details for a domain.

To get IDs for the domains in your account, use the List domains endpoint.

Example requests and responses

cURL
curl -X GET \
  'https://www.digicert.com/services/v2/domain/{{domain_id}}?include_dcv=true&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/{{domain_id}}"

querystring = {"include_dcv":"true","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)
Go
package main

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

func main() {

	url := "https://www.digicert.com/services/v2/domain/{{domain_id}}?include_dcv=true&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/{{domain_id}}',
  qs: { include_dcv: 'true', 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
{
  "id": 12345678,
  "is_active": true,
  "status": "pending",
  "name": "example.com",
  "date_created": "2021-04-27T14:49:28+00:00",
  "organization": {
    "id": 12345678,
    "status": "active",
    "name": "Example Corp.",
    "display_name": "Example Corp.",
    "is_active": "1"
  },
  "validations": [
    {
      "type": "ov",
      "name": "OV",
      "description": "Normal Organization Validation",
      "validated_until": "2023-07-31T14:51:31+00:00",
      "status": "active",
      "dcv_status": "complete"
    },
    {
      "type": "ev",
      "name": "EV",
      "description": "Extended Organization Validation (EV)",
      "validated_until": "2022-05-27T14:51:31+00:00",
      "status": "active",
      "dcv_status": "complete"
    }
  ],
  "dcv_method": "dns-txt-token",
  "dcv_token": {
    "token": {{dcv_token}},
    "status": "active"
  },
  "dcv_expiration": {
    "ev": "2022-05-27",
    "ov": "2023-07-31"
  },
  "container": {
    "id": 123456,
    "name": "Example Corp."
  }
}

Path parameters

Name Req/Opt Description
domain_id required ID of the domain to query.

URL query strings

Name Req/Opt Type Description
include_dcv optional bool If true, returns domain control validation (DCV) details in the response.
Default: false
include_validation optional bool If true, returns validation details in the response. Validation details are returned in the validations array.
Default: false

Response parameters

Name Type Description
id int Domain ID.
is_active bool Active status of the domain.
status
Deprecated*
string Validation status of the domain.

*DigiCert has deprecated the status response parameter.
  • In integrations that use Domain info response data, you can safely remove or ignore the value of the status parameter.
  • To get a more comprehensive validation status for your domains, include the query parameter include_validation=true when you submit your request. The validations array returns the status for each type of validation on 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 Organization status.
Possible values: active, inactive. For more information, see Glossary - Organization status.
.. 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 objects with details about each type of validation on the domain. For information about the data structure and key/value pairs for objects returned in the validations array, see Structures – Validations object.
Only returned if URL query include_validation=true.
dcv_method string Domain control validation method configured for the domain.
Only returned if URL query include_dcv=true.
See Glossary – DCV methods
dcv_token object If DCV method uses a random value token, this object is returned and contains token information.
Only returned if URL query include_dcv=true.
.. 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
dcv_expiration object If the DCV has been completed, this object is returned and contains information about when the validations expire.
Only returned if URL query include_dcv=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
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.