v1 | GoDaddy Developers

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.

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 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/v1/certificates" \  -H "Content-Type: application/json" \  -d '{    "contact": {      "email": "string",      "nameFirst": "string",      "nameLast": "string",      "phone": "string"    },    "csr": "string",    "period": 0,    "productType": "DV_SSL"  }'

{  "certificateId": "string"}

Validate 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 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 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/v1/certificates/validate" \  -H "Content-Type: application/json" \  -d '{    "contact": {      "email": "string",      "nameFirst": "string",      "nameLast": "string",      "phone": "string"    },    "csr": "string",    "period": 0,    "productType": "DV_SSL"  }'

Empty

Retrieve certificate details

Path Parameters

certificateId*string

Certificate id to lookup

`application/json`

curl -X GET "https://example.com/v1/certificates/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"}

Retrieve all certificate actions

Path Parameters

certificateId*string

Certificate id to register for callback

`application/json`

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

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

Add alternate email address

Path Parameters

certificateId*string

Certificate id to resend emails

emailAddress*string

Specific email address to resend email

`application/json`

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

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

Retrieve email history

Path Parameters

certificateId*string

Certificate id to retrieve email history

`application/json`

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

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

Retrieve system stateful action callback url

Path Parameters

certificateId*string

Certificate id to register for stateful action callback

`application/json`

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

{  "callbackUrl": "string"}

Register of certificate action callback

Path Parameters

certificateId*string

Certificate id to register/replace for callback

Query Parameters

callbackUrl*string

Callback url registered/replaced to receive stateful actions

`application/json`

curl -X PUT "https://example.com/v1/certificates/string/callback?callbackUrl=string"

Empty

Download certificate

Path Parameters

certificateId*string

Certificate id to download

`application/json`

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

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

Reissue active certificate

Path Parameters

certificateId*string

Certificate id to reissue

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

Default"Existing common name"

csr?string

Certificate Signing Request.

Default"Existing CSR"

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 Type. Depending on certificate expiration date, SHA_1 not be allowed. Will default to SHA_2 if expiration date exceeds sha1 allowed date

Default"GODADDY_SHA_1"

Value in

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

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

Empty

Renew active certificate

Path Parameters

certificateId*string

Certificate id to renew

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

Default"Existing common name"

csr?string

Certificate Signing Request.

Default"Existing CSR"

period?integer

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

Default0

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

Value in

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

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/string/renew" \  -H "Content-Type: application/json" \  -d '{}'

Empty

Revoke active certificate

Path Parameters

certificateId*string

Certificate id to revoke

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/string/revoke" \  -H "Content-Type: application/json" \  -d '{    "reason": "AFFILIATION_CHANGED"  }'

Empty

Get Site seal

Path Parameters

certificateId*string

Certificate id

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/string/siteSeal"

{  "html": "string"}

`application/json`

curl -X POST "https://example.com/v1/certificates/string/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`

`application/json`

`application/json`

`application/json`

`application/json`