v1 | GoDaddy Developers

Per-certificate operations. Order a certificate from a CSR, follow it through issuance, then reissue, renew, revoke, or cancel it. Also covers validation emails, domain control checks, action callbacks, downloads, and the site seal.

Create a pending order for certificate

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

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.

contact*

csr*string

Certificate Signing Request

intelVPro?boolean

Only used for OV

Defaultfalse

organization?

period*integer

Number of years for certificate validity period

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 CA that issues the certificate. If omitted, a GoDaddy root is used.

Value in

"GODADDY_R1"
"STARFIELD_R1"

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.

Response Body

`application/json`

curl -X POST "https://example.com/v1/certificates" \  -H "X-Market-Id: en-US" \  -H "Content-Type: application/json" \  -d '{    "contact": {      "email": "admin@example.com",      "nameFirst": "Jane",      "nameLast": "Doe",      "phone": "+1.4805058800"    },    "csr": "-----BEGIN CERTIFICATE REQUEST-----\\nMIICijCCAXICAQAwRTELMAkGA1UEBhMCVVMxEzARBgNVBAgMCkFyaXpvbmExDjAM\\nBgNVBAcMBVRlbXBlMREwDwYDVQQKDAhFeGFtcGxlMRQwEgYDVQQDDAtleGFtcGxl\\n...\\nLmNvbYIPd3d3LmV4YW1wbGUuY29t\\n-----END CERTIFICATE REQUEST-----\\n",    "period": 1,    "productType": "DV_SSL"  }'

{  "certificateId": "string"}

Validate a pending order for certificate

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 info

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.

contact*

csr*string

Certificate Signing Request

intelVPro?boolean

Only used for OV

Defaultfalse

organization?

period*integer

Number of years for certificate validity period

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 CA that issues the certificate. If omitted, a GoDaddy root is used.

Value in

"GODADDY_R1"
"STARFIELD_R1"

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.

Response Body

`application/json`

curl -X POST "https://example.com/v1/certificates/validate" \  -H "X-Market-Id: en-US" \  -H "Content-Type: application/json" \  -d '{    "contact": {      "email": "admin@example.com",      "nameFirst": "Jane",      "nameLast": "Doe",      "phone": "+1.4805058800"    },    "csr": "-----BEGIN CERTIFICATE REQUEST-----\\nMIICijCCAXICAQAwRTELMAkGA1UEBhMCVVMxEzARBgNVBAgMCkFyaXpvbmExDjAM\\nBgNVBAcMBVRlbXBlMREwDwYDVQQKDAhFeGFtcGxlMRQwEgYDVQQDDAtleGFtcGxl\\n...\\nLmNvbYIPd3d3LmV4YW1wbGUuY29t\\n-----END CERTIFICATE REQUEST-----\\n",    "period": 1,    "productType": "DV_SSL"  }'

Empty

Retrieve certificate details

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.

Response Body

`application/json`

curl -X GET "https://example.com/v1/certificates/qobxspos3s5q6mkzipvpoq4rsd3phkcn"

{  "certificateId": "string",  "commonName": "string",  "contact": {    "email": "admin@example.com",    "jobTitle": "IT Director",    "nameFirst": "Jane",    "nameLast": "Doe",    "nameMiddle": "A",    "phone": "+1.4805058800",    "suffix": "Jr."  },  "createdAt": "string",  "deniedReason": "string",  "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"  },  "period": 0,  "productType": "DV_SSL",  "progress": 0,  "revokedAt": "string",  "rootType": "GODADDY_R1",  "serialNumber": "string",  "serialNumberHex": "string",  "slotSize": "FIVE",  "status": "PENDING_ISSUANCE",  "subjectAlternativeNames": [    {      "status": "PENDING",      "subjectAlternativeName": "string"    }  ],  "validEnd": "string",  "validStart": "string"}

Retrieve all certificate actions

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.

Response Body

`application/json`

curl -X GET "https://example.com/v1/certificates/qobxspos3s5q6mkzipvpoq4rsd3phkcn/actions"

[  {    "createdAt": "string",    "type": "CERTIFICATE_ISSUED"  }]

Resend an email

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.

emailId*string

Email id for email to resend

Response Body

`application/json`

curl -X POST "https://example.com/v1/certificates/qobxspos3s5q6mkzipvpoq4rsd3phkcn/email/12345/resend"

Empty

Add alternate email address

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.

emailAddress*string

Specific email address to resend email

Formatemail

Response Body

`application/json`

curl -X POST "https://example.com/v1/certificates/qobxspos3s5q6mkzipvpoq4rsd3phkcn/email/resend/admin@example.com"

{  "id": 0,  "accountId": 0,  "templateType": "string",  "fromType": "string",  "recipients": "string",  "body": "string",  "dateEntered": "string",  "subject": "string"}

Resend email to email address

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.

emailId*string

Email id for email to resend

emailAddress*string

Specific email address to resend email

Formatemail

Response Body

`application/json`

curl -X POST "https://example.com/v1/certificates/qobxspos3s5q6mkzipvpoq4rsd3phkcn/email/12345/resend/admin@example.com"

Empty

Retrieve email history

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.

Response Body

`application/json`

curl -X GET "https://example.com/v1/certificates/qobxspos3s5q6mkzipvpoq4rsd3phkcn/email/history"

{  "id": 0,  "accountId": 0,  "templateType": "string",  "fromType": "string",  "recipients": "string",  "body": "string",  "dateEntered": "string",  "subject": "string"}

Retrieve system stateful action callback url

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.

Response Body

`application/json`

curl -X GET "https://example.com/v1/certificates/qobxspos3s5q6mkzipvpoq4rsd3phkcn/callback"

{  "callbackUrl": "string"}

Unregister system callback

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.

Response Body

`application/json`

curl -X DELETE "https://example.com/v1/certificates/qobxspos3s5q6mkzipvpoq4rsd3phkcn/callback"

Empty

Register of certificate action callback

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.

Query Parameters

callbackUrl*string

Callback url registered/replaced to receive stateful actions

Response Body

`application/json`

curl -X PUT "https://example.com/v1/certificates/qobxspos3s5q6mkzipvpoq4rsd3phkcn/callback?callbackUrl=https%3A%2F%2Fexample.com%2Fcertificate-callback"

Empty

Cancel a pending certificate

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.

Response Body

`application/json`

curl -X POST "https://example.com/v1/certificates/qobxspos3s5q6mkzipvpoq4rsd3phkcn/cancel"

Empty

Download certificate

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.

Response Body

`application/json`

curl -X GET "https://example.com/v1/certificates/qobxspos3s5q6mkzipvpoq4rsd3phkcn/download"

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

Reissue active certificate

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

callbackUrl?string

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

commonName?string

The common name of certificate to be secured. Defaults to the common name of the existing certificate.

csr?string

Certificate Signing Request. Defaults to the CSR of the existing certificate.

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

rootType?string

Root CA that issues the reissued certificate. If omitted, the root of the existing certificate is kept.

Value in

"GODADDY_R1"
"STARFIELD_R1"

subjectAlternativeNames?array<string>

Only used for UCC products. An array of subject alternative names to include in certificate.

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/v1/certificates/qobxspos3s5q6mkzipvpoq4rsd3phkcn/reissue" \  -H "Content-Type: application/json" \  -d '{}'

Empty

Renew active certificate

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 renew request info

callbackUrl?string

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

commonName?string

The common name of certificate to be secured. Defaults to the common name of the existing certificate.

csr?string

Certificate Signing Request. Defaults to the CSR of the existing certificate.

period?integer

Number of years for certificate validity period, if different from previous certificate

Default0

rootType?string

Root CA that issues the renewed certificate. If omitted, the root of the existing certificate is kept.

Value in

"GODADDY_R1"
"STARFIELD_R1"

subjectAlternativeNames?array<string>

Only used for UCC products. An array of subject alternative names to include in certificate. Not including a subject alternative name that was in the previous certificate will remove it from the renewed certificate.

Response Body

`application/json`

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

Empty

Revoke active certificate

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 certificate revocation request

reason*string

Reason for revocation

Value in

"AFFILIATION_CHANGED"
"CESSATION_OF_OPERATION"
"KEY_COMPROMISE"
"PRIVILEGE_WITHDRAWN"
"SUPERSEDED"

Response Body

`application/json`

curl -X POST "https://example.com/v1/certificates/qobxspos3s5q6mkzipvpoq4rsd3phkcn/revoke" \  -H "Content-Type: application/json" \  -d '{    "reason": "AFFILIATION_CHANGED"  }'

Empty

Get Site seal

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.

Query Parameters

theme?string

This value represents the visual theme of the seal. If seal doesn't exist, default values are used if params not present. If seal does exist, default values will not be used to update unless params present.

Default"LIGHT"

Value in

"DARK"
"LIGHT"

locale?string

Determine locale for text displayed in seal image and verification page. If seal doesn't exist, default values are used if params not present. If seal does exist, default values will not be used to update unless params present.

Default"en"

Response Body

`application/json`

curl -X GET "https://example.com/v1/certificates/qobxspos3s5q6mkzipvpoq4rsd3phkcn/siteSeal"

{  "html": "string"}

Check Domain Control

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.

Response Body

`application/json`

curl -X POST "https://example.com/v1/certificates/qobxspos3s5q6mkzipvpoq4rsd3phkcn/verifyDomainControl"

Empty

Last updated on

v1

202application/json

400application/json

401application/json

403application/json

409application/json

422application/json

500application/json

204

400application/json

401application/json

403application/json

409application/json

422application/json

500application/json

200application/json

400application/json

401application/json

403application/json

404application/json

500application/json

200application/json

400application/json

401application/json

403application/json

404application/json

500application/json

204

404application/json

409application/json

500application/json

200application/json

404application/json

409application/json

500application/json

204

404application/json

409application/json

500application/json

200application/json

409application/json

500application/json

200application/json

400application/json

401application/json

403application/json

404application/json

500application/json

204

400application/json

401application/json

403application/json

404application/json

500application/json

204

400application/json

401application/json

403application/json

404application/json

422application/json

500application/json

204

401application/json

403application/json

404application/json

409application/json

500application/json

200application/json

400application/json

401application/json

403application/json

404application/json

409application/json

500application/json

202

400application/json

401application/json

403application/json

404application/json

409application/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`

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

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`