v2 | GoDaddy Developers

Search for certificate details by entitlement

Query Parameters

entitlementId*string

Entitlement id to lookup

latest?boolean

Fetch only the most recent certificate

Defaulttrue

`application/json`

curl -X GET "https://example.com/v2/certificates?entitlementId=string"

[  {    "certificateId": "string",    "commonName": "string",    "contact": {      "email": "string",      "jobTitle": "string",      "nameFirst": "string",      "nameLast": "string",      "nameMiddle": "string",      "phone": "string",      "suffix": "string"    },    "createdAt": "string",    "deniedReason": "string",    "organization": {      "address": {        "address1": "string",        "address2": "string",        "city": "string",        "country": "AC",        "postalCode": "string",        "state": "string"      },      "assumedName": "string",      "jurisdictionOfIncorporation": {        "city": "string",        "country": "string",        "county": "string",        "state": "string"      },      "name": "string",      "phone": "string",      "registrationAgent": "string",      "registrationNumber": "string"    },    "period": 0,    "productType": "DV_SSL",    "progress": 0,    "revokedAt": "string",    "rootType": "GODADDY_SHA_1",    "serialNumber": "string",    "serialNumberHex": "string",    "slotSize": "FIVE",    "status": "PENDING_ISSUANCE",    "subjectAlternativeNames": [      {        "status": "PENDING",        "subjectAlternativeName": "string"      }    ],    "validEnd": "string",    "validStart": "string"  }]

Create a pending order for certificate

Header Parameters

X-Market-Id?string

Setting locale for communications such as emails and error messages

Default"Default locale for shopper account"

Request Body

application/json

The certificate order information

callbackUrl?string

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

commonName?string

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

certificateId?string

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

contact?

csr?string

Certificate Signing Request

intelVPro?boolean

Only used for OV

Defaultfalse

organization?

period?integer

Number of years for certificate validity period

termType?string

Determines the temporal unit used for period value.

Value in

"YEARS"
"DAYS"

productType?string

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

Value in

"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"

rootType?string

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

Default"STARFIELD_SHA_2"

Value in

"GODADDY_SHA_1"
"GODADDY_SHA_2"
"STARFIELD_SHA_1"
"STARFIELD_SHA_2"

slotSize?string

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

Value in

"FIVE"
"TEN"
"FIFTEEN"
"TWENTY"
"THIRTY"
"FOURTY"
"FIFTY"
"ONE_HUNDRED"

subjectAlternativeNames?array<string>

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

`application/json`

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

{  "certificateId": "string",  "subscriptionId": "string",  "subscriptionCreatedForOrder": true}

Reissue active certificate

Path Parameters

certificateId*string

Certificate id to reissue

Request Body

application/json

The reissue request info

csr?string

Certificate Signing Request.

Default"New CSR, required for rekey only. Changes to common name or subject alternative names will be rejected."

revokeExistingCertificate?boolean

Whether to revoke existing certificate upon issuance of new certificate

Defaultfalse

delayExistingRevoke?integer

In hours, time to delay revoking existing certificate after issuance of new certificate. If revokeExistingCertOnIssuance is enabled, this value will be ignored

Rangevalue <= 168

Default72

forceDomainRevetting?array<string>

Optional field. Domain verification will be required for each domain listed here. Specify a value of * to indicate that all domains associated with the request should have their domain information reverified.

Response Body

`application/json`

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

Empty

Download certificate by entitlement

Query Parameters

entitlementId*string

Entitlement id to download

Response Body

`application/json`

curl -X GET "https://example.com/v2/certificates/download?entitlementId=string"

{  "pems": {    "certificate": "string",    "cross": "string",    "intermediate": "string",    "root": "string"  },  "serialNumber": "string"}

Retrieve customer's certificates

Path Parameters

customerId*string

An identifier for a customer

Query Parameters

offset?integer

Number of results to skip for pagination

Match^[0-9]+$

Formatinteger-positive

limit?integer

Maximum number of items to return

Match^[0-9]+$

Formatinteger-positive

Response Body

`application/json`

`/`

curl -X GET "https://example.com/v2/customers/string/certificates"

{  "certificates": [    {      "certificateId": "string",      "commonName": "string",      "period": 0,      "type": "DV_SSL",      "status": "ISSUED",      "createdAt": "string",      "completedAt": "string",      "validEndAt": "string",      "validStartAt": "string",      "revokedAt": "string",      "renewalAvailable": true,      "serialNumber": "string",      "slotSize": "FIVE",      "subjectAlternativeNames": [        "string"      ]    }  ],  "pagination": {    "first": "string",    "previous": "string",    "next": "string",    "last": "string",    "total": 0  }}

Retrieve individual certificate details

Path Parameters

customerId*string

An identifier for a customer

certificateId*string

Certificate id to lookup

Response Body

`application/json`

`/`

curl -X GET "https://example.com/v2/customers/string/certificates/string"

{  "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": "string",    "jobTitle": "string",    "nameFirst": "string",    "nameLast": "string",    "nameMiddle": "string",    "phone": "string",    "suffix": "string"  },  "organization": {    "address": {      "address1": "string",      "address2": "string",      "city": "string",      "country": "AC",      "postalCode": "string",      "state": "string"    },    "assumedName": "string",    "jurisdictionOfIncorporation": {      "city": "string",      "country": "string",      "county": "string",      "state": "string"    },    "name": "string",    "phone": "string",    "registrationAgent": "string",    "registrationNumber": "string"  },  "csr": "string",  "rootType": "GODADDY_SHA_1",  "deniedReason": "string",  "progress": 0}

Retrieve domain verification status

Path Parameters

customerId*string

An identifier for a customer

certificateId*string

Certificate id to lookup

Response Body

`application/json`

`/`

curl -X GET "https://example.com/v2/customers/string/certificates/string/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

Path Parameters

customerId*string

An identifier for a customer

certificateId*string

Certificate id to lookup

domain*string

A valid domain name in the certificate request

Formatdomain

Response Body

`application/json`

`/`

curl -X GET "https://example.com/v2/customers/string/certificates/string/domainVerifications/string"

{  "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

Path Parameters

customerId*string

An identifier for a customer

Response Body

`application/json`

`/`

curl -X GET "https://example.com/v2/customers/string/certificates/acme/externalAccountBinding"

{  "directoryUrl": "string",  "keyId": "string",  "hmacKey": "string"}

Get a page of subscriptions by domain

Query Parameters

pageSize?integer

The number of records to return per query.

Formatint32

Default"15"

page?integer

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

Formatint32

Range1 <= value

Default"1"

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

The certificate lifecycle stage. Active, Expired, and Revoked are all Issued certificates. Active means the validity period includes today. Expired means the validity period was prior to today. Revoked means that the certificate has been revoked. Pending means that the certificate is still going through the issuance process and has not been signed or issued yet. 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...)

Default"ANY"

Value in

"ANY"
"ACTIVE"
"DENIED"
"EXPIRED"
"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"

Response Body

`application/json`

curl -X GET "https://example.com/v2/certificates/subscriptions/search"

{  "currentPage": "1",  "data": [],  "pageSize": 0,  "total": 0}

GET a page of certificates for a specific domain product

Path Parameters

guid*string

The Subscription GUID containing the certificates being requested.

Default"217c6432-b892-4d74-a75e-0e37b5dc30a0"

Query Parameters

pageSize?integer

The number of records to return per query.

Formatint32

Default"15"

page?integer

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

Formatint32

Range1 <= value

Default"1"

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

Default"ANY"

Value in

"ANY"
"ACTIVE"
"DENIED"
"EXPIRED"
"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"

Response Body

`application/json`

curl -X GET "https://example.com/v2/certificates/subscription/217c6432-b892-4d74-a75e-0e37b5dc30a0"

{  "allowedDomains": [    "example.com"  ],  "domain": "example.com",  "guid": "217c6432-b892-4d74-a75e-0e37b5dc30a0",  "maxDomains": 0,  "subscriptionEndDate": "2019-08-24T14:15:22Z",  "subscriptionStartDate": "2019-08-24T14:15:22Z",  "subscriptionStatus": "ACTIVE",  "currentPage": "1",  "data": [],  "pageSize": 0,  "total": 0}

Last updated on

v2

200application/json

400application/json

401application/json

403application/json

422application/json

500application/json

202application/json

400application/json

401application/json

403application/json

409application/json

422application/json

500application/json

202

400application/json

401application/json

403application/json

404application/json

409application/json

422application/json

500application/json

200application/json

400application/json

401application/json

403application/json

404application/json

409application/json

422application/json

500application/json

200application/json

401*/*

403*/*

422*/*

429*/*

500*/*

200application/json

401*/*

403*/*

404*/*

422*/*

429*/*

500*/*

200application/json

401*/*

403*/*

404*/*

422*/*

429*/*

500*/*

200application/json

401*/*

403*/*

404*/*

422*/*

429*/*

500*/*

200application/json

401*/*

403*/*

404*/*

422*/*

429*/*

500*/*

200application/json

200application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`/`

`/`

`/`

`/`

`/`

`application/json`

`/`

`/`

`/`

`/`

`/`

`/`

`application/json`

`/`

`/`

`/`

`/`

`/`

`/`

`application/json`

`/`

`/`

`/`

`/`

`/`

`/`

`application/json`

`/`

`/`

`/`

`/`

`/`

`/`

`application/json`

`application/json`