GoDaddy
Support
API ReferenceSecurity & RiskCertificates APIv2

v2

View as Markdown

Entitlement- and subscription-backed operations. Order and reissue certificates against an entitlement, look certificates up by Automated SSL subscription, check domain verification state, and fetch ACME external account binding credentials.

Create a pending order for certificate

POST
/v2/certificates

Authorization

sso-key
Authorization<token>

Standard GoDaddy developer API key auth header created in https://developer.godaddy.com/keys. Format: sso-key {KEY}:{SECRET}.

In: header

Header Parameters

X-Market-Id?string

Setting locale for communications such as emails and error messages. Defaults to the locale of the shopper account.

Request Body

application/json

The certificate order information

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v2/certificates" \  -H "X-Market-Id: en-US" \  -H "Content-Type: application/json" \  -d '{}'
{  "certificateId": "string",  "subscriptionId": "string",  "subscriptionCreatedForOrder": true}

Reissue active certificate

POST
/v2/certificates/{certificateId}/reissue

Authorization

sso-key
Authorization<token>

Standard GoDaddy developer API key auth header created in https://developer.godaddy.com/keys. Format: sso-key {KEY}:{SECRET}.

In: header

Path Parameters

certificateId*string

The id of the certificate.

Request Body

application/json

The reissue request info

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v2/certificates/qobxspos3s5q6mkzipvpoq4rsd3phkcn/reissue" \  -H "Content-Type: application/json" \  -d '{}'
Empty

Retrieve individual certificate details

GET
/v2/customers/{customerId}/certificates/{certificateId}

Authorization

sso-key
Authorization<token>

Standard GoDaddy developer API key auth header created in https://developer.godaddy.com/keys. Format: sso-key {KEY}:{SECRET}.

In: header

Path Parameters

customerId*string

An identifier for a customer

certificateId*string

The id of the certificate.

Response Body

application/json

*/*

*/*

*/*

*/*

*/*

*/*

curl -X GET "https://example.com/v2/customers/217c6432-b892-4d74-a75e-0e37b5dc30a0/certificates/qobxspos3s5q6mkzipvpoq4rsd3phkcn"
{  "certificateId": "string",  "commonName": "string",  "period": 0,  "type": "DV_SSL",  "status": "PENDING_ISSUANCE",  "createdAt": "string",  "completedAt": "string",  "validEndAt": "string",  "validStartAt": "string",  "revokedAt": "string",  "renewalAvailable": true,  "serialNumber": "string",  "serialNumberHex": "string",  "slotSize": "FIVE",  "subjectAlternativeNames": [    "string"  ],  "contact": {    "email": "admin@example.com",    "jobTitle": "IT Director",    "nameFirst": "Jane",    "nameLast": "Doe",    "nameMiddle": "A",    "phone": "+1.4805058800",    "suffix": "Jr."  },  "organization": {    "address": {      "address1": "100 S Mill Ave",      "address2": "Suite 1600",      "city": "Tempe",      "country": "AC",      "postalCode": "85281",      "state": "Arizona"    },    "assumedName": "string",    "jurisdictionOfIncorporation": {      "city": "string",      "country": "string",      "county": "string",      "state": "string"    },    "name": "string",    "phone": "string",    "registrationAgent": "string",    "registrationNumber": "string"  },  "csr": "string",  "rootType": "GODADDY_R1",  "deniedReason": "string",  "progress": 0}

Retrieve domain verification status

GET
/v2/customers/{customerId}/certificates/{certificateId}/domainVerifications

Authorization

sso-key
Authorization<token>

Standard GoDaddy developer API key auth header created in https://developer.godaddy.com/keys. Format: sso-key {KEY}:{SECRET}.

In: header

Path Parameters

customerId*string

An identifier for a customer

certificateId*string

The id of the certificate.

Response Body

application/json

*/*

*/*

*/*

*/*

*/*

*/*

curl -X GET "https://example.com/v2/customers/217c6432-b892-4d74-a75e-0e37b5dc30a0/certificates/qobxspos3s5q6mkzipvpoq4rsd3phkcn/domainVerifications"
[  {    "domain": "string",    "domainEntityId": 0,    "dceToken": "string",    "status": "COMPLETED",    "createdAt": "string",    "modifiedAt": "string",    "type": "DOMAIN_CONTROL_EMAIL",    "usage": "COMMON_NAME"  }]

Retrieve detailed information for supplied domain

GET
/v2/customers/{customerId}/certificates/{certificateId}/domainVerifications/{domain}

Authorization

sso-key
Authorization<token>

Standard GoDaddy developer API key auth header created in https://developer.godaddy.com/keys. Format: sso-key {KEY}:{SECRET}.

In: header

Path Parameters

customerId*string

An identifier for a customer

certificateId*string

The id of the certificate.

domain*string

A valid domain name in the certificate request

Formatdomain

Response Body

application/json

*/*

*/*

*/*

*/*

*/*

*/*

curl -X GET "https://example.com/v2/customers/217c6432-b892-4d74-a75e-0e37b5dc30a0/certificates/qobxspos3s5q6mkzipvpoq4rsd3phkcn/domainVerifications/example.com"
{  "domain": "string",  "domainEntityId": 0,  "dceToken": "string",  "status": "COMPLETED",  "createdAt": "string",  "modifiedAt": "string",  "type": "DOMAIN_CONTROL_EMAIL",  "usage": "COMMON_NAME",  "certificateAuthorityAuthorization": {    "status": "PENDING",    "queryPaths": [      "string"    ],    "recommendations": [      "ADD_CA_TO_CAA"    ],    "completedAt": "string"  }}

Retrieves the external account binding for the specified customer

GET
/v2/customers/{customerId}/certificates/acme/externalAccountBinding

Authorization

sso-key
Authorization<token>

Standard GoDaddy developer API key auth header created in https://developer.godaddy.com/keys. Format: sso-key {KEY}:{SECRET}.

In: header

Path Parameters

customerId*string

An identifier for a customer

Response Body

application/json

*/*

*/*

*/*

*/*

*/*

*/*

curl -X GET "https://example.com/v2/customers/217c6432-b892-4d74-a75e-0e37b5dc30a0/certificates/acme/externalAccountBinding"
{  "directoryUrl": "string",  "keyId": "string",  "hmacKey": "string"}

Search a customer's certificate credits

GET
/v2/customers/{customerId}/certificates/credits/search

Authorization

sso-key
Authorization<token>

Standard GoDaddy developer API key auth header created in https://developer.godaddy.com/keys. Format: sso-key {KEY}:{SECRET}.

In: header

Path Parameters

customerId*string

An identifier for a customer

Query Parameters

pageSize?integer

The number of records to return per query.

Formatint32
Default15
page?integer

The page number. (First page is one instead of zero.)

Formatint32
Range1 <= value
Default1
domain?string

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?string

Filter credits by the state of the certificate issued against them. ISSUED matches any certificate that was ever issued, expired or not. UNUSED matches credits with no certificate requested yet, USED matches everything except those, and ALL disables the filter.

Value in

  • "ALL"
  • "ACTIVE"
  • "ISSUED"
  • "EXPIRED"
  • "UNUSED"
  • "PENDING"
  • "REVOKED"
  • "DENIED"
  • "USED"
product_type?string

Filter by the purchased product behind the credit.

Value in

  • "OV_SSL"
  • "DV_SSL"
  • "OV_WILDCARD_SSL"
  • "DV_WILDCARD_SSL"
  • "EV_SSL"
  • "UCC_OV_SSL"
  • "UCC_WILDCARD_OV_SSL"
  • "UCC_DV_SSL"
  • "UCC_WILDCARD_DV_SSL"
  • "OV_CS"
  • "OV_DS"
  • "UCC_EV_SSL"
  • "BV_SSL"
  • "UCC_CMC"
  • "UCC_VMC"
  • "CMC"
  • "VMC"
sort_by?string

Field to sort the credit list by. Omit to let the service pick the ordering that suits the filters you supplied.

Value in

  • "CERTIFICATE_ID"
  • "DOMAIN"
  • "REQUEST_STATUS"
  • "PRODUCT_TYPE"
  • "PRODUCT_GUID"
  • "SLOT_SIZE"
  • "REQUEST_DATE"
  • "COMPLETION_DATE"
  • "VALID_START_DATE"
  • "VALID_END_DATE"
  • "REVOCATION_DATE"
  • "SERIAL_NUMBER"
  • "SUBJECT_ALTERNATIVE_NAMES"
  • "RENEW_AVAILABLE"
  • "SUBSCRIPTION_START_DATE"
  • "SUBSCRIPTION_END_DATE"
  • "SUBSCRIPTION_STATUS"
  • "IS_MANAGED_SSL"
sort_direction?string

Sort direction applied to sort_by.

Default"DESC"

Value in

  • "ASC"
  • "DESC"

Response Body

application/json

application/json

*/*

*/*

*/*

*/*

curl -X GET "https://example.com/v2/customers/217c6432-b892-4d74-a75e-0e37b5dc30a0/certificates/credits/search?pageSize=15&page=1&domain=example.com"
{  "currentPage": "1",  "pageSize": 0,  "shopperCerts": [],  "totalCertCount": 0}

List a customer's unused certificate credits

GET
/v2/customers/{customerId}/certificates/credits/available

Authorization

sso-key
Authorization<token>

Standard GoDaddy developer API key auth header created in https://developer.godaddy.com/keys. Format: sso-key {KEY}:{SECRET}.

In: header

Path Parameters

customerId*string

An identifier for a customer

Response Body

application/json

*/*

*/*

*/*

*/*

curl -X GET "https://example.com/v2/customers/217c6432-b892-4d74-a75e-0e37b5dc30a0/certificates/credits/available"
[]

Get aggregate certificate and subscription counts for a customer

GET
/v2/customers/{customerId}/certificates/subscriptions/stats

Authorization

sso-key
Authorization<token>

Standard GoDaddy developer API key auth header created in https://developer.godaddy.com/keys. Format: sso-key {KEY}:{SECRET}.

In: header

Path Parameters

customerId*string

An identifier for a customer

Query Parameters

subscriptionStatus?string

Filter by subscription status. ACTIVE_OR_SUSPENDED matches both of those states and is the default; ANY disables the filter entirely.

Default"ACTIVE_OR_SUSPENDED"

Value in

  • "ANY"
  • "ACTIVE"
  • "SUSPENDED"
  • "ACTIVE_OR_SUSPENDED"
  • "CANCELED"
  • "REMOVED"
bucket?array<>

Repeat this parameter to select which counts to return. Both certificate and SUBSCRIPTION_* buckets are accepted on this endpoint.

Default

[  "ACTIVE",  "DENIED",  "EXPIRING_SOON",  "EXPIRED",  "PENDING",  "REVOKED",  "SINGLE",  "UCC",  "WILDCARD",  "DV",  "EV",  "OV",  "SUBSCRIPTION_TOTAL",  "SUBSCRIPTION_ACTIVE",  "SUBSCRIPTION_SUSPENDED",  "SUBSCRIPTION_PENDING_CANCEL",  "SUBSCRIPTION_CANCELED",  "SUBSCRIPTION_EXPIRING_SOON"]

Response Body

application/json

application/json

*/*

*/*

*/*

*/*

curl -X GET "https://example.com/v2/customers/217c6432-b892-4d74-a75e-0e37b5dc30a0/certificates/subscriptions/stats"
{  "data": [],  "total": 0}

Search the certificates in one subscription

GET
/v2/customers/{customerId}/certificates/subscription/{guid}/search

Authorization

sso-key
Authorization<token>

Standard GoDaddy developer API key auth header created in https://developer.godaddy.com/keys. Format: sso-key {KEY}:{SECRET}.

In: header

Path Parameters

customerId*string

An identifier for a customer

guid*string

The Subscription GUID containing the certificates being requested.

Query Parameters

pageSize?integer

The number of records to return per query.

Formatint32
Default15
page?integer

The page number. (First page is one instead of zero.)

Formatint32
Range1 <= value
Default1
domain?string

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?string

Filter by certificate lifecycle stage. ACTIVE, EXPIRED, and REVOKED are all issued certificates. EXPIRING_SOON is an active certificate close to its end date. PENDING is still going through issuance. DENIED went from pending to denied, for example because the customer canceled or a CAA record blocked issuance.

Default"ANY"

Value in

  • "ANY"
  • "ACTIVE"
  • "DENIED"
  • "EXPIRED"
  • "EXPIRING_SOON"
  • "PENDING"
  • "REVOKED"
type?string

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

Default"ANY"

Value in

  • "ANY"
  • "SINGLE"
  • "UCC"
  • "WILDCARD"
validation?string

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

Default"ANY"

Value in

  • "ANY"
  • "DV"
  • "EV"
  • "OV"
  • "CMC"
  • "VMC"
  • "PRIVATE"
hidden?boolean

Set to true to return only the certificates the customer has hidden. The default, false, returns only the visible ones.

Defaultfalse
sortBy?string

Field to sort the results by.

Default"REQUEST_DATE"

Value in

  • "DOMAIN"
  • "EXPIRATION_DATE"
  • "CERTIFICATE_STATUS"
  • "CERTIFICATE_TYPE"
  • "CERTIFICATE_VALIDATION_TYPE"
  • "REQUEST_DATE"
sortDirection?string

Sort direction applied to sortBy.

Default"DESC"

Value in

  • "ASC"
  • "DESC"

Response Body

application/json

application/json

*/*

*/*

*/*

*/*

*/*

curl -X GET "https://example.com/v2/customers/217c6432-b892-4d74-a75e-0e37b5dc30a0/certificates/subscription/217c6432-b892-4d74-a75e-0e37b5dc30a0/search?pageSize=15&page=1&domain=example.com"
{  "allowedDomains": [],  "certificates": [],  "customerId": "217c6432-b892-4d74-a75e-0e37b5dc30a0",  "domain": "example.com",  "guid": "217c6432-b892-4d74-a75e-0e37b5dc30a0",  "maxDomains": 0,  "page": "1",  "pageSize": 0,  "subscriptionEndDate": "2019-08-24T14:15:22Z",  "subscriptionStartDate": "2019-08-24T14:15:22Z",  "subscriptionStatus": "ACTIVE",  "total": 0}

Get aggregate certificate counts for one subscription

GET
/v2/customers/{customerId}/certificates/subscription/{guid}/stats

Authorization

sso-key
Authorization<token>

Standard GoDaddy developer API key auth header created in https://developer.godaddy.com/keys. Format: sso-key {KEY}:{SECRET}.

In: header

Path Parameters

customerId*string

An identifier for a customer

guid*string

The Subscription GUID containing the certificates being requested.

Query Parameters

bucket?array<>

Repeat this parameter to select which counts to return. SUBSCRIPTION_* buckets are rejected on this endpoint.

Default

[  "ACTIVE",  "DENIED",  "EXPIRING_SOON",  "EXPIRED",  "PENDING",  "REVOKED",  "SINGLE",  "UCC",  "WILDCARD",  "DV",  "EV",  "OV"]

Response Body

application/json

application/json

*/*

*/*

*/*

*/*

*/*

curl -X GET "https://example.com/v2/customers/217c6432-b892-4d74-a75e-0e37b5dc30a0/certificates/subscription/217c6432-b892-4d74-a75e-0e37b5dc30a0/stats"
{  "data": [],  "total": 0}

Get a page of a customer's subscriptions

GET
/v2/customers/{customerId}/certificates/subscriptions

Authorization

sso-key
Authorization<token>

Standard GoDaddy developer API key auth header created in https://developer.godaddy.com/keys. Format: sso-key {KEY}:{SECRET}.

In: header

Path Parameters

customerId*string

An identifier for a customer

Query Parameters

pageSize?integer

The number of records to return per query.

Formatint32
Default15
page?integer

The page number. (First page is one instead of zero.)

Formatint32
Range1 <= value
Default1
domain?string

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.

subscriptionStatus?string

Filter by subscription status. ACTIVE_OR_SUSPENDED matches both of those states and is the default; ANY disables the filter entirely.

Default"ACTIVE_OR_SUSPENDED"

Value in

  • "ANY"
  • "ACTIVE"
  • "SUSPENDED"
  • "ACTIVE_OR_SUSPENDED"
  • "CANCELED"
  • "REMOVED"
type?string

Filter by subscription size. SINGLE matches subscriptions that allow exactly one domain; MULTIPACK matches those that allow more than one.

Default"ANY"

Value in

  • "ANY"
  • "SINGLE"
  • "MULTIPACK"
validation?string

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

Default"ANY"

Value in

  • "ANY"
  • "DV"
  • "EV"
  • "OV"
  • "CMC"
  • "VMC"
  • "PRIVATE"
wildcard?string

Filter by whether the subscription can issue wildcard certificates.

Default"ANY"

Value in

  • "ANY"
  • "WILDCARD_SUPPORTED"
  • "NO_WILDCARD_SUPPORT"
sortBy?string

Field to sort the subscription list by. NEEDS_ATTENTION, the default, orders by subscription status (REMOVED first, ACTIVE last) and then by soonest expiry. DOMAIN_USAGE sorts by allowedDomains / maxDomains.

Default"NEEDS_ATTENTION"

Value in

  • "START_DATE"
  • "END_DATE"
  • "STATUS"
  • "MAX_DOMAINS"
  • "PLAN"
  • "MANAGED"
  • "SUPPORTS_WILDCARD"
  • "DOMAIN_USAGE"
  • "NEEDS_ATTENTION"
sortDirection?string

Sort direction applied to sortBy.

Default"ASC"

Value in

  • "ASC"
  • "DESC"

Response Body

application/json

application/json

*/*

*/*

*/*

*/*

curl -X GET "https://example.com/v2/customers/217c6432-b892-4d74-a75e-0e37b5dc30a0/certificates/subscriptions?pageSize=15&page=1&domain=example.com"
{  "currentPage": "1",  "data": [],  "pageSize": 0,  "total": 0}

Show or hide several certificates

POST
/v2/customers/{customerId}/certificates/visibility

Authorization

sso-key
Authorization<token>

Standard GoDaddy developer API key auth header created in https://developer.godaddy.com/keys. Format: sso-key {KEY}:{SECRET}.

In: header

Path Parameters

customerId*string

An identifier for a customer

Query Parameters

hidden?boolean

The visibility to apply — true hides, false shows.

Defaultfalse

Request Body

application/json

The certificate IDs to show or hide. Duplicates are ignored.

Items1 <= items
[index: integer]?CertificateId

A unique identifier for a certificate request in any stage.

Response Body

application/json

application/json

*/*

*/*

*/*

*/*

curl -X POST "https://example.com/v2/customers/217c6432-b892-4d74-a75e-0e37b5dc30a0/certificates/visibility" \  -H "Content-Type: application/json" \  -d '[    "qobxspos3s5q6mkzipvpoq4rsd3phkcn"  ]'
[]

Check whether a certificate is hidden

GET
/v2/customers/{customerId}/certificate/{certificateId}/visibility

Authorization

sso-key
Authorization<token>

Standard GoDaddy developer API key auth header created in https://developer.godaddy.com/keys. Format: sso-key {KEY}:{SECRET}.

In: header

Path Parameters

customerId*string

An identifier for a customer

certificateId*string

The id of the certificate.

Response Body

application/json

*/*

*/*

*/*

*/*

*/*

curl -X GET "https://example.com/v2/customers/217c6432-b892-4d74-a75e-0e37b5dc30a0/certificate/qobxspos3s5q6mkzipvpoq4rsd3phkcn/visibility"
{  "certificateId": "qobxspos3s5q6mkzipvpoq4rsd3phkcn",  "hidden": true}

Show or hide one certificate

POST
/v2/customers/{customerId}/certificate/{certificateId}/visibility

Authorization

sso-key
Authorization<token>

Standard GoDaddy developer API key auth header created in https://developer.godaddy.com/keys. Format: sso-key {KEY}:{SECRET}.

In: header

Path Parameters

customerId*string

An identifier for a customer

certificateId*string

The id of the certificate.

Query Parameters

hidden?boolean

The visibility to apply — true hides, false shows.

Defaultfalse

Response Body

application/json

*/*

*/*

*/*

*/*

*/*

curl -X POST "https://example.com/v2/customers/217c6432-b892-4d74-a75e-0e37b5dc30a0/certificate/qobxspos3s5q6mkzipvpoq4rsd3phkcn/visibility"
[  {    "certificateId": "qobxspos3s5q6mkzipvpoq4rsd3phkcn",    "hidden": true  }]

Get the issuance checklist for a certificate

GET
/v2/customers/{customerId}/certificate/{certificateId}/checklist

Authorization

sso-key
Authorization<token>

Standard GoDaddy developer API key auth header created in https://developer.godaddy.com/keys. Format: sso-key {KEY}:{SECRET}.

In: header

Path Parameters

customerId*string

An identifier for a customer

certificateId*string

The id of the certificate.

Query Parameters

types?array<>

Repeat this parameter to limit the checklist to specific steps. Defaults to every step.

Default

[  "FRAUD",  "DOMAIN",  "ORGANIZATION",  "AGREEMENT_SIGNING",  "FINAL_REVIEW",  "INSTALLATION"]

Response Body

application/json

*/*

*/*

*/*

*/*

*/*

curl -X GET "https://example.com/v2/customers/217c6432-b892-4d74-a75e-0e37b5dc30a0/certificate/qobxspos3s5q6mkzipvpoq4rsd3phkcn/checklist"
{  "completed": 0,  "data": [],  "pendingAction": 0,  "totalChecks": 0}

Last updated on

How is this guide?