Sign in

v1

latestSwagger 2.02026-07-132946124.7 KB
v2

Get a page of subscriptions by domain

The pagination starts at page 1. Each page contains a page of subscriptions, not certificates. This endpoint is meant for paging the subscriptions under the authorized user's account. Each subscription contains a snapshot of certificates contained within the subscription. To fetch further certificates under a subscription, use the /v2/certificates/subscription/{guid} endpoint with the subscription GUID obtained from this call. If any filtering is applied, subscriptions without any certificates will be omitted.

get/v2/certificates/subscriptions/search

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

currentPageinteger required

The page number.

pageSizeinteger required

The page size.

totalinteger required

The total aggregate count.

Example response

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