Use this endpoint to get details about the domains in a subaccount.
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);
});
{
"domains": [
{
"id": 1111111,
"is_active": false,
"name": "first.example.com",
"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": "2021-02-10T15:28:41+00:00",
"validated_until": "2022-03-10T07:00:00+00:00",
"status": "active"
},
{
"type": "ov",
"name": "OV",
"description": "Normal Organization Validation",
"date_created": "2021-02-10T15:28:41+00:00",
"validated_until": "2023-05-16T06: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
}
}
Name | Type | Description |
---|---|---|
subaccount_id | int | ID of the subaccount to query. |
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 |
---|---|---|---|
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.
Examples:
|
sort | optional | string |
Sorts 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:
|
limit | optional | int |
Total number of results to include in the response. Maximum: 1000 (default)
|
offset | optional | int |
Index of the first result to include in the response. Default 0
|
Name | Type | Description |
---|---|---|
domains | array | List of objects with information about each domain. |
.. id | int | Domain ID. |
.. is_active | bool |
If true , domain is active. Otherwise, false .
|
.. name | string | Domain name. |
.. date_created | string |
Date and time the domain was created. Format: YYYY-MM-DDThh:mm:ssTZD UTC time zone and ISO 8601 date |
.. organization | object | Object with information about the organization associated with the domain. |
.. .. id | int | Organization ID. |
.. .. status | string | Organization validation status. |
.. .. name | string | Organization legal name. |
.. .. assumed_name | string |
Organization assumed name. Also called Doing Business As (DBA) name. |
.. .. display_name | string |
Organization display name. Constructed using name + assumed_name .
|
.. .. is_active | string |
Organization status. Possible values: "1" (active) or "0" (inactive)
|
.. validations | array |
Domain 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_method | string |
Domain control validation (DCV) method used for the domain. See Glossary – DCV methods |
.. dcv_expiration | object |
Object with expiration details for each validation. Only returned if DCV is complete. |
.. .. ov | string |
Date and time OV validation expires. Format: YYYY-MM-DD UTC time zone and ISO 8601 date |
.. .. ev | string |
Date and time EV validation expires. Format: YYYY-MM-DD UTC time zone and ISO 8601 date |
.. container | object | Container associated with the domain. |
.. .. id | int | Container ID. |
.. .. name | string | Name of the container. |
page | object |
Object with pagination details. Modified using URL query strings. |