Actions & Endpoints

Introduction

The Godaddy Integration with Rewst delivers a robust set of actions and endpoints for interacting with Godaddy. Below is a summary of each section, highlighting the diverse capabilities and opportunities provided through the Godaddy Integration:

Actions
Certificates
Domains
Generic Request
Notifications
Shoppers

Actions

List Domain Actions

GET https://api.godaddy.com/v2/customers/{customerId}/domains/{domain}/actions

This endpoint allows you to list the actions performed on a specific domain for a customer

Get Recent Domain Action

GET https://api.godaddy.com/v2/customers/{customerId}/domains/{domain}/actions/{type}

Get the recent action performed on a domain. Requires the customer ID, domain name, and the type of action to retrieve

Cancel User Action

DELETE https://api.godaddy.com/v2/customers/{customerId}/domains/{domain}/actions/{type}

Cancel a specific user action for a domain in GoDaddy. Use the path parameters to specify the customer ID, domain, and the type of action to cancel

Certificates

List Certificates

GET https://api.godaddy.com/v2/customers/{customerId}/certificates

Retrieve a customer's certificate list.

Get Certificate Details

GET https://api.godaddy.com/v2/customers/{customerId}/certificates/{certificateId}

This method checks and retrieves certificate order status and details. Remember, shopperId is a 10-digit number (e.g., 1234567890), while customerId is a UUIDv4 (e.g., 295e3bc3-b3b9-4d95-aae5-ede41a994d13).

Get Domain Verification Status

GET https://api.godaddy.com/v2/customers/{customerId}/certificates/{certificateId}/domainVerifications

Retrieve the domain verification status for a certificate request using the method. shopperId is a 10-digit number, while customerId is a UUIDv4.

Get Domain Details

GET https://api.godaddy.com/v2/customers/{customerId}/certificates/{certificateId}/domainVerifications/{domain}

Get domain information, including verification and CAA details. Note: shopperId (max 10 digits) is different from customerId (UUIDv4 format).

Get External Account Binding

GET https://api.godaddy.com/v2/customers/{customerId}/certificates/acme/externalAccountBinding

Retrieve a key identifier and HMAC key for ACME EAB. Use them with a compatible client (like CertBot) to automate DV SSL certificate issuance and deployment.

Domains

Get Customer Domain Details

GET https://api.godaddy.com/v2/customers/{customerId}/domains/{domain}

Get domain details for a specific customer and domain

Get Domain Privacy Settings

GET https://api.godaddy.com/v2/customers/{customerId}/domains/{domain}/privacy/forwarding

Retrieve the privacy settings for a specific domain owned by a customer

Update Domain Privacy

PATCH https://api.godaddy.com/v2/customers/{customerId}/domains/{domain}/privacy/forwarding

Update the privacy forwarding settings for a specific domain owned by a customer

Purchase Domain Redemption

POST https://api.godaddy.com/v2/customers/{customerId}/domains/{domain}/redeem

Purchase domain redemption for a specific customer and domain

Renew Domain

POST https://api.godaddy.com/v2/customers/{customerId}/domains/{domain}/renew

Renew Domain

Start Transfer Process

POST https://api.godaddy.com/v2/customers/{customerId}/domains/{domain}/transfer

Starts the transfer process for a domain by sending a request to the GoDaddy API

Accept Transfer

POST https://api.godaddy.com/v2/customers/{customerId}/domains/{domain}/transferInAccept

Accepts a transfer request for a domain belonging to a customer

Cancel Transfer

POST https://api.godaddy.com/v2/customers/{customerId}/domains/{domain}/transferInCancel

Cancel the transfer of a domain for a customer

Restart Transfer

POST https://api.godaddy.com/v2/customers/{customerId}/domains/{domain}/transferInRestart

Restart the transfer of a domain for a customer. Requires the customer ID and domain as path parameters

Retry Domain Transfer

POST https://api.godaddy.com/v2/customers/{customerId}/domains/{domain}/transferInRetry

Retry a domain transfer for a specific customer and domain

Initiate Domain Transfer Out

POST https://api.godaddy.com/v2/customers/{customerId}/domains/{domain}/transferOut

Initiate Domain Transfer Out

Accept Transfer Out

POST https://api.godaddy.com/v2/customers/{customerId}/domains/{domain}/transferOutAccept

Accept transfer out for a domain

Reject Transfer Out

POST https://api.godaddy.com/v2/customers/{customerId}/domains/{domain}/transferOutReject

Reject Transfer Out

Get Domain Forwarding

GET https://api.godaddy.com/v2/customers/{customerId}/domains/forwards/{fqdn}

Notes:shopperId is not the same as customerId. shopperId is a number of max length 10 digits (*ex:* 1234567890) whereas customerId is a UUIDv4 (*ex:* 295e3bc3-b3b9-4d95-aae5-ede41a994d13)

Update Forwarding Information

PUT https://api.godaddy.com/v2/customers/{customerId}/domains/forwards/{fqdn}

Notes:shopperId is not the same as customerId. shopperId is a number of max length 10 digits (*ex:* 1234567890) whereas customerId is a UUIDv4 (*ex:* 295e3bc3-b3b9-4d95-aae5-ede41a994d13)

Create Forwarding Configuration

POST https://api.godaddy.com/v2/customers/{customerId}/domains/forwards/{fqdn}

Description coming soon...

Delete Forwarding Cancellation Request

DELETE https://api.godaddy.com/v2/customers/{customerId}/domains/forwards/{fqdn}

Notes:shopperId is not the same as customerId. shopperId is a number of max length 10 digits (*ex:* 1234567890) whereas customerId is a UUIDv4 (*ex:* 295e3bc3-b3b9-4d95-aae5-ede41a994d13)

Create Domain Registration

POST https://api.godaddy.com/v2/customers/{customerId}/domains/register

Create a domain registration for a customer

Get Domain Schema

GET https://api.godaddy.com/v2/customers/{customerId}/domains/register/schema/{tld}

Get the schema for registering a domain with GoDaddy. Requires the `customerId` and `tld` path parameters

Validate Domain Request

POST https://api.godaddy.com/v2/customers/{customerId}/domains/register/validate

Validate a domain registration request for a specific customer

List Upcoming Maintenances

GET https://api.godaddy.com/v2/domains/maintenances

Get a list of upcoming maintenance events for domains. You can filter the list by status, modified date, start date, and limit the number of results

Get System Maintenance

GET https://api.godaddy.com/v2/domains/maintenances/{maintenanceId}

Get system maintenance by maintenance ID

Create Certificate Order

POST https://api.godaddy.com/v1/certificates

For PKI workflow, track certificate order creation through asynchronous methods: 1) Polling at '/v1/certificates/{certificateId}/actions', or 2) WebHook callback at '/v1/certificates/{certificateId}/callback'.

Validate Certificate Order

POST https://api.godaddy.com/v1/certificates/validate

Validate a certificate order by sending a request to the /v1/certificates/validate endpoint with the specified JSON body and headers

Get Certificate Details

GET https://api.godaddy.com/v1/certificates/{certificateId}

Once the certificate order has been created, this method can be used to check the status of the certificate. This method can also be used to retrieve details of the certificate.

List Certificate Actions

GET https://api.godaddy.com/v1/certificates/{certificateId}/actions

This method is used to retrieve all stateful actions relating to a certificate lifecycle.

Resend Email

POST https://api.godaddy.com/v1/certificates/{certificateId}/email/{emailId}/resend

This method can be used to resend emails by providing the certificate id and the email id

Add Alternate Email Address

POST https://api.godaddy.com/v1/certificates/{certificateId}/email/resend/{emailAddress}

This method adds an alternate email address to a certificate order and re-sends all existing request emails to that address.

Resend Email By Certificate Address

POST https://api.godaddy.com/v1/certificates/{certificateId}/email/{emailId}/resend/{emailAddress}

This method can be used to resend emails by providing the certificate id, the email id, and the recipient email address

Get Email History

GET https://api.godaddy.com/v1/certificates/{certificateId}/email/history

This method can be used to retrieve all emails sent for a certificate.

Get Callback URL

GET https://api.godaddy.com/v1/certificates/{certificateId}/callback

This method is used to retrieve the registered callback url for a certificate.

Replace Certificate Callback

PUT https://api.godaddy.com/v1/certificates/{certificateId}/callback

Register/replace URL for stateful certificate lifecycle callbacks. Webhook style pattern receives POST requests with JSON body defined in CertificateAction model. Only one callback URL allowed per certificateId, replacing previous registration.

Delete System Callback

DELETE https://api.godaddy.com/v1/certificates/{certificateId}/callback

Unregister the callback for a particular certificate.

Cancel Certificate Order

POST https://api.godaddy.com/v1/certificates/{certificateId}/cancel

Use the cancel call to cancel a pending certificate order.

Download Certificate

GET https://api.godaddy.com/v1/certificates/{certificateId}/download

Download a certificate by providing the certificate ID as a path parameter

Reissue Certificate

POST https://api.godaddy.com/v1/certificates/{certificateId}/reissue

Re-keying updates keys. Reissuing changes domains on a certificate. New validated certificate with updated names issued. Unlimited reissues possible. Note: Unrelated names delay validation. Call before pending reissue replaces prior request.

Renew Certificate

POST https://api.godaddy.com/v1/certificates/{certificateId}/renew

Renew certificates for extended validity. Edit original order. Approved renewal extends validity. Include subject alt names; new names may delay validation if not sharing base domain.

Revoke Certificate

POST https://api.godaddy.com/v1/certificates/{certificateId}/revoke

Use revoke call to revoke an active certificate, if the certificate has not been issued a 404 response will be returned.

Get Site Seal

GET https://api.godaddy.com/v1/certificates/{certificateId}/siteSeal

Retrieve SSL certificate site seal information, a clickable graphic displaying certificate details, linked via a site seal token on the reseller's website for faster customer page loading.

Check Domain Control

POST https://api.godaddy.com/v1/certificates/{certificateId}/verifyDomainControl

Domain control verifies certificate order domain, aiding reseller domain management. Speeds up verification.

Get Certificate Details By Entitlement

GET https://api.godaddy.com/v2/certificates

Once the certificate order has been created, this method can be used to check the status of the certificate. This method can also be used to retrieve details of the certificates associated to an entitlement.

Get Certificate By Entitlement

GET https://api.godaddy.com/v2/certificates/download

Get certificate by entitlement ID

List Domains

GET https://api.godaddy.com/v1/domains

Retrieve a list of domains for a shopper. Supports filtering by statuses, status groups, limit, marker, includes, and modified date

Get Legal Agreements

GET https://api.godaddy.com/v1/domains/agreements

Get legal agreements for a list of domain names and whether privacy and transfer options are available

Check Domain Availability

GET https://api.godaddy.com/v1/domains/available

Check the availability of a domain. Returns true if the domain is available, false otherwise. Takes domain, checkType, and forTransfer as query parameters

Check Domain Status

POST https://api.godaddy.com/v1/domains/available

Checks the availability of a domain on GoDaddy. Returns information about the availability status of the specified domain

Validate Contact Domains

POST https://api.godaddy.com/v1/domains/contacts/validate

All contacts specified in request will be validated against all domains specified in "domains". As an alternative, you can also pass in tlds, with the exception of `uk`, which requires full domain names

Create Domain Registration

POST https://api.godaddy.com/v1/domains/purchase

Create a new domain registration by making a POST request to the /v1/domains/purchase endpoint with the required parameters and headers in the JSON body

Get Domain Schema By TLD

GET https://api.godaddy.com/v1/domains/purchase/schema/{tld}

Get the schema for purchasing a domain. The schema includes information about the required and optional parameters for purchasing a domain

Validate Domain Purchase

POST https://api.godaddy.com/v1/domains/purchase/validate

Validate domain purchase by sending a request to the /v1/domains/purchase/validate endpoint

Suggest Domain Names

GET https://api.godaddy.com/v1/domains/suggest

This endpoint allows you to request a list of suggested domain names based on specified parameters

List Top Level Domains

GET https://api.godaddy.com/v1/domains/tlds

List all top level domains available for registration on GoDaddy

Get Domain Details By Name

GET https://api.godaddy.com/v1/domains/{domain}

Get the details of a domain by providing the domain name as a path parameter

Cancel Domain Purchase

DELETE https://api.godaddy.com/v1/domains/{domain}

Cancel a domain purchase

Update Domain Details

PATCH https://api.godaddy.com/v1/domains/{domain}

Update the details of a domain in the GoDaddy API

Update Domain

PATCH https://api.godaddy.com/v1/domains/{domain}/contacts

Update the contact information for a domain

Create Privacy Cancellation Request

DELETE https://api.godaddy.com/v1/domains/{domain}/privacy

Create a cancellation request for privacy protection on a domain. This endpoint requires the domain name as a path parameter

Purchase Domain Privacy

POST https://api.godaddy.com/v1/domains/{domain}/privacy/purchase

Purchase domain privacy for a specific domain

Replace DNS Records By Domain

PUT https://api.godaddy.com/v1/domains/{domain}/records

This endpoint replaces the DNS records for a specific domain on the GoDaddy platform

Add DNS Records

PATCH https://api.godaddy.com/v1/domains/{domain}/records

Add DNS records for a domain

Retrieve DNS Records

GET https://api.godaddy.com/v1/domains/{domain}/records/{type}/{name}

Retrieve DNS Records for a specific domain and DNS record type using the GoDaddy API

Replace DNS Records By Record Type

PUT https://api.godaddy.com/v1/domains/{domain}/records/{type}/{name}

Replace DNS Records for a specified domain and record type and name

Delete DNS Records

DELETE https://api.godaddy.com/v1/domains/{domain}/records/{type}/{name}

Delete DNS records for a specific domain and record type

Replace DNS Records

PUT https://api.godaddy.com/v1/domains/{domain}/records/{type}

Replace DNS Records for a specific domain and DNS record type

Renew Domain Name

POST https://api.godaddy.com/v1/domains/{domain}/renew

Renew domain endpoint

Start Transfer Process By Domain

POST https://api.godaddy.com/v1/domains/{domain}/transfer

Starts the transfer process for a domain. Path parameter 'domain' is required.

Resend Email Verification

POST https://api.godaddy.com/v1/domains/{domain}/verifyRegistrantEmail

Re-sends the email verification for a domain registration

Generic Request

GoDaddy API Request

GET/PUT/POST/DELETE https://api.godaddy.com/<url_path>

Generic action for making authenticated requests against the GoDaddy API

Notifications

Get Domain Notification

GET https://api.godaddy.com/v2/customers/{customerId}/domains/notifications

Retrieve domain notification for a specific customer

List Notification Types

GET https://api.godaddy.com/v2/customers/{customerId}/domains/notifications/optIn

Retrieve a list of notification types for a customer's domains

Create Opt-In Notifications

PUT https://api.godaddy.com/v2/customers/{customerId}/domains/notifications/optIn

Create opt-in notifications for a customer's domain. This endpoint requires the customerId path parameter and the types query parameter to be provided

Get Notification Schema

GET https://api.godaddy.com/v2/customers/{customerId}/domains/notifications/schemas/{type}

Get the schema for a specific notification type for a customer's domain

Acknowledge Domain Notification

POST https://api.godaddy.com/v2/customers/{customerId}/domains/notifications/{notificationId}/acknowledge

Acknowledge a domain notification by providing the customer ID and notification ID

Shoppers

Create Sub-account

POST https://api.godaddy.com/v1/shoppers/subaccount

Create a subaccount for a shopper on GoDaddy

Get Shopper Details

GET https://api.godaddy.com/v1/shoppers/{shopperId}

Notes:shopperId is not the same as customerId. shopperId is a number of max length 10 digits (*ex:* 1234567890) whereas customerId is a UUIDv4 (*ex:* 295e3bc3-b3b9-4d95-aae5-ede41a994d13)

Update Shopper Details

POST https://api.godaddy.com/v1/shoppers/{shopperId}

Notes:shopperId is not the same as customerId. shopperId is a number of max length 10 digits (*ex:* 1234567890) whereas customerId is a UUIDv4 (*ex:* 295e3bc3-b3b9-4d95-aae5-ede41a994d13)

Delete Shopper Profile

DELETE https://api.godaddy.com/v1/shoppers/{shopperId}

Notes: Shopper deletion is not supported in OTE. shopperId is not the same as customerId.

Get Shopper Status

GET https://api.godaddy.com/v1/shoppers/{shopperId}/status

Notes:shopperId is not the same as customerId. shopperId is a number of max length 10 digits (*ex:* 1234567890) whereas customerId is a UUIDv4 (*ex:* 295e3bc3-b3b9-4d95-aae5-ede41a994d13)

Set Sub-account Password

PUT https://api.godaddy.com/v1/shoppers/{shopperId}/factors/password

API Resellers can set subaccount passwords. Please note that the shopperId is a 10-digit number (e.g., 1234567890) while the customerId is a UUIDv4 (e.g., 295e3bc3-b3b9-4d95-aae5-ede41a994d13).

Last updated 1 year ago