Sign in

v1

latestSwagger 2.02026-07-132946124.7 KB
v2

Search for certificate details by entitlement

Once the certificate order has been created, this method can be used to check the status of the certificate. This method can also be used to retrieve details of the certificates associated to an entitlement.

get/v2/certificates

Query parameters

entitlementIdstring required

Entitlement id to lookup

latestboolean

Fetch only the most recent certificate

Response

Certificate details retrieved

certificateIdstring required

The unique identifier of the certificate request. Only present if no errors returned

commonNamestring

Common name of certificate

createdAtstring iso-datetime required

The date the certificate was ordered.

deniedReasonstring

Only present if certificate order has been denied

periodinteger required

Validity period of order. Specified in years

productType'DV_SSL' | 'DV_WILDCARD_SSL' | 'EV_SSL' | 'OV_CS' | 'OV_DS' | 'OV_SSL' | 'OV_WILDCARD_SSL' | 'UCC_DV_SSL' | 'UCC_EV_SSL' | 'UCC_OV_SSL' required

Certificate product type

progressinteger

Percentage of completion for certificate vetting

revokedAtstring iso-datetime

The revocation date of certificate (if revoked).

rootType'GODADDY_SHA_1' | 'GODADDY_SHA_2' | 'STARFIELD_SHA_1' | 'STARFIELD_SHA_2'

Root Type

serialNumberstring

Serial number of certificate (if issued or revoked)

serialNumberHexstring

Hexadecmial format for Serial number of certificate(if issued or revoked)

slotSize'FIVE' | 'TEN' | 'FIFTEEN' | 'TWENTY' | 'THIRTY' | 'FOURTY' | 'FIFTY' | 'ONE_HUNDRED'

Number of subject alternative names(SAN) to be included in certificate

status'PENDING_ISSUANCE' | 'ISSUED' | 'REVOKED' | 'CANCELED' | 'DENIED' | 'PENDING_REVOCATION' | 'PENDING_REKEY' | 'UNUSED' | 'EXPIRED' required

Status of certificate

validEndstring iso-datetime

The end date of the certificate's validity (if issued or revoked).

validStartstring iso-datetime

The start date of the certificate's validity (if issued or revoked).