Sign in

v1

latestSwagger 2.02026-07-132946124.7 KB
v2

Create a pending order for certificate

Creating a certificate order for a subscription can be a long running asynchronous operation in the PKI workflow. The PKI API supports 2 options for getting the completion stateful actions for this asynchronous operations: 1) by polling operations -- see /v1/certificates/{certificateId}/actions 2) via WebHook style callback -- see '/v1/certificates/{certificateId}/callback'.

post/v2/certificates

Headers

X-Market-Idstring

Setting locale for communications such as emails and error messages

Request body

callbackUrlstring

Required if client would like to receive stateful actions via callback during certificate lifecyle

commonNamestring

Name to be secured in certificate. If provided, CN field in CSR will be ignored.

certificateIdstring

Id of the existing certificate to renew. If provided, all other fields will be ignored and copied from the existing certificate.

csrstring

Certificate Signing Request

intelVProboolean

Only used for OV

periodinteger

Number of years for certificate validity period

termType'YEARS' | 'DAYS'

Determines the temporal unit used for period value.

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'

Type of product requesting a certificate. Only required non-renewal

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

Root Type. Depending on certificate expiration date, SHA_1 not be allowed. Will default to SHA_2 if expiration date exceeds sha1 allowed date

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

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

subjectAlternativeNamesstring[]

Subject Alternative names. Collection of subjectAlternativeNames to be included in certificate.

Response

Request was successful

certificateIdstring required

The unique identifier of the certificate request. Only present if verified.

subscriptionIdstring required

The unique identifier of the subscription owning the certificate request.

subscriptionCreatedForOrderboolean required

Was subscription purchased for certificate order.