List subaccount domains

GET https://www.digicert.com/services/v2/account/subaccount/1234567/domain
Use this endpoint to get details about the domains in a subaccount.

Example requests and responses

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

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

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

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

print(response.text)
package main

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

func main() {

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

		payload := strings.NewReader(``)

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

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

		res, err := client.Do(req)
		if err != nil {
				fmt.Println(err)
				return
		}
		defer res.Body.Close()

		body, err := ioutil.ReadAll(res.Body)
		if err != nil {
				fmt.Println(err)
				return
		}
		fmt.Println(string(body))
}
var request = require('request');
var options = {
  'method': 'GET',
  'url': 'https://www.digicert.com/services/v2/account/subaccount/1234567/domain',
  'headers': {
    'X-DC-DEVKEY': {{api_key}},
    'Content-Type': 'application/json'
  }
};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});

200 OK

{
  "domains": [
    {
      "id": 1111111,
      "is_active": false,
      "name": "first.example.com",
      "last_submitted_datetime": "2022-02-28T08:03:06+00:00",
      "dcv_approval_datetime": "2022-02-24T06:49:33+00:00",
      "date_created": "2021-02-10T08:26:28+00:00",
      "organization": {
        "id": 1381638,
        "status": "active",
        "name": "BTP org",
        "display_name": "BTP 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": "2022-03-10",
        "ov": "2023-05-16"
      },
      "container": {
        "id": 677794,
        "name": "BTP org"
      }
    },
    {},
    {}
  ],
  "page": {
    "total": 3,
    "limit": 1000,
    "offset": 0
  }
}

Path parameters

NameTypeDescription
subaccount_idintID of the subaccount to query.

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
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.
Examples:
sortoptionalstringSorts results by the value of one or more properties.
By default, sorts 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.
Maximum: 1000 (default)
offsetoptionalintIndex of the first result to include in the response.
Default0

Response parameters

NameTypeDescription
domainsarrayList of objects with information about each domain.
.. idintDomain ID.
.. is_activeboolIf true, domain is active. Otherwise, false.
.. namestringDomain name.
.. 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:YYYY-MM-DDThh:mm:ss+TZD
.. last_submitted_datetimestringDate and time (UTC) the domain was last submitted for DCV.
Format:YYYY-MM-DDThh:mm:ss+TZD
Note: Only returned for domains submitted for validation or revalidation after March 3, 2022 .
.. date_createdstringDate and time the domain was created.
Format: YYYY-MM-DDThh:mm:ssTZD UTC time zone and ISO 8601 date
.. organizationobjectObject with information about the organization associated with the domain.
.. .. idintOrganization ID.
.. .. statusstringOrganization validation status.
.. .. namestringOrganization legal name.
.. .. assumed_namestringOrganization assumed name. Also called Doing Business As (DBA) name.
.. .. display_namestringOrganization display name. Constructed using name + assumed_name.
.. .. is_activestringOrganization status.
Possible values: “1” (active) or “0” (inactive)
.. validationsarrayDomain validation details. To see the structure of data objects in the validations array, see Structures – Validations object.
Note: For each domain, the List subaccount domains endpoint only returns validations with an active status.
.. dcv_methodstringDomain control validation (DCV) method used 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:YYYY-MM-DD
.. .. ovstringExpiration date for OV domain validation.
Format:YYYY-MM-DD
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:YYYY-MM-DD
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:YYYY-MM-DD
.. containerobjectContainer associated with the domain.
.. .. idintContainer ID.
.. .. namestringName of the container.
pageobjectObject with pagination details. Modified using URL query strings.

Validation filter values

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

NameDescription
completedDomain validation has been completed at least once. Includes all domains in your account with a completed domain validation, even if the validation is expired.
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.