Lista de dominios

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

Use this endpoint to list all domains in your account.

Example requests and responses

cURL
curl -X GET \
  'https://www.digicert.com/services/v2/domain' \
  -H 'Content-Type: application/json' \
  -H 'X-DC-DEVKEY: {{api_key}}'
Python
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'))
Go
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))
}
NodeJS
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);
});
200 (include_validation_reuse_status = true)
{
    "domains": [
        {
            "id": 12345,
            "is_active": true,
            "name": "example.org",
            "date_created": "2022-02-10T15:24:08+00:00",
            "last_submitted_datetime": "2022-02-28T08:03:06+00:00",
            "dcv_approval_datetime": "2022-02-24T06:49:33+00:00",
            "organization": {
                "id": 1560288,
                "status": "active",
                "name": "Example Org",
                "display_name": "Example 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": "2023-03-27",
                "ov": "2023-03-27",
                "ov_shortened": "2023-03-27",
                "ov_status": "valid",
                "ev_status": "valid",
                "dcv_approval_date": "2022-02-23"
            },
            "container": {
                "id": 677797,
                "name": "Example Division"
            },
            "base_domain": "example.org"
        }
    ],
    "page": {
        "total": 1,
        "limit": 1000,
        "offset": 0
    }
}

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.

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 the following filters:
  • filters[status] – Use active or inactive.
  • filters[validation] – Validation status for the domain. See Validation filter values.
  • filters[include_validation_reuse_status] – Use true to include the ov_shortened, ov_status, ev_status, and dcv_approval_date parameters in the dcv_expiration object in the response data. To exclude these parameters from the response, omit this filter or use false (default).
  • filters[dcv_method] – Filter by DCV method. Use email, dns-cname-token, dns-txt-token, http-token, or http-token-static.
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:
  • filters[search]=%25example
    Limits response to results where the value of a searched property contains the string example.
  • filters[search]=example.com
    Limits response to results where the value of a searched property is an exact match for the string example.com.
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:
  • id
  • is_active
  • name
  • date_created
  • organization_id
  • organization_name
  • organization_status
  • organization_is_active
  • dcv_method
  • container_id
  • container_name
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

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.
.. name string Name of the domain.
.. dcv_approval_datetime string Completion 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_datetime string Date 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_created string Timestamp of when the domain was added.
Format: UTC timezone and ISO 8601 date
.. domain_locking_status string Domain lock status. Domain locking prevents users in other CertCentral accounts from requesting certificates for the domain.

A domain only returns the domain_locking_status property if domain locking is enabled for the account. For more information, see Domain locking ­– Enable domain locking for your account.

Possible values:
  • disabled: Domain lock disabled. Users in other CertCentral accounts can request certificates for the domain.
  • pending: Domain lock pending. To finish setting up domain locking, place the account token (account_token) on the DNS Certificate Authority Authorization (CAA) resource record for the domain (see Domain locking – Locking a domain, step 6). Then, submit a request to the Check CAA (domain lock) endpoint.
  • enabled: Domain lock enabled. Only users belonging to your CertCentral account can request certificates for the domain.
.. account_token string Account token to use for domain locking.

A domain only returns the account_token parameter if these conditions are met:
  • Domain locking is enabled for the account. See Domain locking ­– Enable domain locking for your account.
  • Domain locking has been activated for the domain at least once. If domain locking has never been activated, no token exists for the domain, and the domain object does not include an account_token parameter.
.. 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 DCV is completed, this object is returned with information about when OV and EV domain validations expire.
.. .. ev string Expiration date for EV domain validation.
Format: YYYY-MM-DD
.. .. ov string Expiration 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_shortened string New 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_status string OV domain validation status. Only returned if request URL includes the query string filters[include_validation_reuse_status]=true.
Possible values:
  • expired – OV domain validation is expired.
  • expiring_soon – OV domain validation expires in the next 60 days.
  • valid – OV domain validation is valid.
  • industry_shortened_expired – On September 27, 2021, OV domain validation will be reduced. The reduced validation period will be expired.
  • industry_shortened_expiring_soon – On September 27, 2021, OV domain validation will be reduced. The reduced validation period will expire before December 1, 2021.
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_status string EV domain validation status. Only returned if request URL includes the query string filters[include_validation_reuse_status]=true
Possible values:
  • expired – EV domain validation is expired.
  • expiring_soon – EV domain validation expires in the next 60 days.
  • valid – EV domain validation is valid.
.. .. dcv_approval_date string Date 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
.. 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.

Validation filter values

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

Name Description
completed Domain validation is complete. Only includes domains with an active OV or EV domain validation status.
ov_expired OV domain validation is expired.
ev_expired EV domain validation is expired.
ov_expiring OV domain validation expires in the next 30 days.
ev_expiring EV domain validation expires in the next 30 days.
shortened_by_industry_changes On 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.
ov_expired_in_last_7_days OV domain validation expired between 7 days ago (inclusive) and today (exclusive).
ov_expiring_within_7_days OV domain validation expires in the next 0 (inclusive) to 7 (inclusive) days.
ov_expiring_within_30_days OV domain validation expires in the next 0 (inclusive) to 30 (inclusive) days.
ov_expiring_from_31_to_60_days OV domain validation expires in the next 31 (inclusive) to 60 (inclusive) days.
ov_expiring_from_61_to_90_days OV domain validation expires in the next 61 (inclusive) to 90 (inclusive) days.
ev_expired_in_last_7_days EV domain validation expired between 7 days ago (inclusive) and today (exclusive).
ev_expiring_within_7_days EV domain validation expires in the next 0 (inclusive) to 7 (inclusive) days.
ev_expiring_within_30_days EV domain validation expires in the next 0 (inclusive) to 30 (inclusive) days.
ev_expiring_from_31_to_60_days EV domain validation expires in the next 31 (inclusive) to 60 (inclusive) days.
ev_expiring_from_61_to_90_days EV domain validation expires in the next 61 (inclusive) to 90 (inclusive) days.