Skip to main content

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

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

boolean

If true, returns domain control validation (DCV) details in the response.

Default:false

include_validation

optional

boolean

If true, returns validation details in the response. Validation details are returned in the validations array.

Default:false

include_validation_reuse_status

optional

boolean

If true, the dcv_expiration object in the response includes ov_shortened, ov_status, ev_status, and dcv_approval_date response parameters.

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.

*Note: 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.

is_pending_validation

bool

Pending 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

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

dcv_approval_datetime

string

Completion date and time (UTC) of the most recent DCV check for the domain. Only returned if the request URL includes the query string include_dcv=true and you have completed a DCV check for the domain at least once.

Format: UTC timezone and ISO 8601 date

dcv_expiration_datetime

string

Expiration date and time (UTC) of the most recent DCV check for the domain. Only returned if the request URL includes the query string include_dcv=true and you have completed a DCV check for the domain at least once.

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. Only returned if URL query include_validation=true.

For information about the data structure and key/value pairs for objects returned in the validations array, see Structures – Validations object.

.. type

string

Type of validation.

.. name

string

Name of validation.

.. description

string

Description of validation.

.. status

string

Status of validation.

.. dcv_status

string

DCV status of validation.

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

string

If DCV is completed, this object is returned with information about when OV and EV domain validations expire. Only returned if the request URL includes the query string include_dcv=true.

.. 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 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 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 stopped 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.

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

base_domain

string

Base domain of the domain.