Sign in

v1

latestSwagger 2.02026-07-132946124.7 KB
v2

GET a page of certificates for a specific domain product

get/v2/certificates/subscription/{guid}

Path parameters

guidstring required

The Subscription GUID containing the certificates being requested.

Query parameters

pageSizeinteger

The number of records to return per query.

pageinteger

The page number. <b>(First page is <i>one</i> instead of zero.)</b>

domainstring

Filter by domain name / common name. This will look for the text inside the content of the domain. This is not a "find domains that start with x" search.

status'ANY' | 'ACTIVE' | 'DENIED' | 'EXPIRED' | 'PENDING' | 'REVOKED'

The certificate lifecycle stage. <br> Active, Expired, and Revoked are all Issued certificates. <br> Active means the validity period includes today. <br> Expired means the validity period was prior to today. <br> Revoked means that the certificate has been revoked. <br> Pending means that the certificate is still going through the issuance process and has not been signed or issued yet. <br> Denied means that the certificate went from pending to denied for any valid denial reason. (Customer canceled request, CAA records exist for the domain, fraud, etc...)

type'ANY' | 'SINGLE' | 'UCC' | 'WILDCARD'

The type of certificate in terms of the number of applicable domains.

validation'ANY' | 'DV' | 'EV' | 'OV'

The validation type for the certificate. Standard/Basic Validation (DV). Organizational/Deluxe Vetting (OV). Extended/Premium Validation (EV).

Response

OK

allowedDomainsDomain[] required

The domains that are currently allowed on this subscription.

domainstring required

A domain, subject alternative name, or alias.

guidstring required

A Globally Unique Identifier

maxDomainsinteger required

The maximum number of domains allowed on this subscription.

subscriptionEndDatestring date-time required
subscriptionStartDatestring date-time required
subscriptionStatus'ACTIVE' | 'SUSPENDED' | 'CANCELED' required

The internal representation of the subscription. A reflection of the entitlement status.

currentPageinteger required

The page number.

pageSizeinteger required

The page size.

totalinteger required

The total aggregate count.

Example response

{
  "allowedDomains": [
    "example.com"
  ],
  "domain": "example.com",
  "guid": "217c6432-b892-4d74-a75e-0e37b5dc30a0",
  "data": [
    {
      "domain": "example.com",
      "sans": [
        "example.com"
      ]
    }
  ]
}