Skip to main content

List subaccount domains

GET https://www.digicert.com/services/v2/account/subaccount/{{subaccount_id}}/domain

Use this endpoint to get details about the domains in a subaccount.

Example requests and responses

Path parameters

Name

Type

Description

subaccount_id

int

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

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 values 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 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:

  • status

  • organization_id

  • is_active

  • name

  • date_created

  • organization_id

  • organization_name

  • organization_is_active

  • dcv_method

  • container_id

  • container_name

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

Response parameters

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.

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

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

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

Validation filter values

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

Name

Description

completed

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