Domains API — Domains. 31 operations. Lead operation: Submit a forwarding cancellation request for the given fqdn. Self-contained Naftiko capability covering one Godaddy business surface.
naftiko: 1.0.0-alpha2
info:
label: Domains API — Domains
description: 'Domains API — Domains. 31 operations. Lead operation: Submit a forwarding cancellation request for the given
fqdn. Self-contained Naftiko capability covering one Godaddy business surface.'
tags:
- Godaddy
- Domains
created: '2026-05-19'
modified: '2026-05-19'
binds:
- namespace: env
keys:
GODADDY_API_KEY: GODADDY_API_KEY
capability:
consumes:
- type: http
namespace: domains-domains
baseUri: https://api.ote-godaddy.com
description: Domains API — Domains business capability. Self-contained, no shared references.
resources:
- name: v2-customers-customerId-domains-forwards-fqdn
path: /v2/customers/{customerId}/domains/forwards/{fqdn}
operations:
- name: domainsforwardsdelete
method: DELETE
description: Submit a forwarding cancellation request for the given fqdn
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: customerId
in: path
type: string
description: 'The Customer identifier<br/> Note: For API Resellers, performing actions on behalf of your customers,
you need to specify the Subaccount you''re operating on beh'
required: true
- name: fqdn
in: path
type: string
description: The fully qualified domain name whose forwarding details are to be deleted.
required: true
- name: domainsforwardsget
method: GET
description: Retrieve the forwarding information for the given fqdn
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: customerId
in: path
type: string
description: 'The Customer identifier<br/> Note: For API Resellers, performing actions on behalf of your customers,
you need to specify the Subaccount you''re operating on beh'
required: true
- name: fqdn
in: path
type: string
description: The fully qualified domain name whose forwarding details are to be retrieved.
required: true
- name: includeSubs
in: query
type: boolean
description: Optionally include all sub domains if the fqdn specified is a domain and not a sub domain.
- name: domainsforwardsput
method: PUT
description: Modify the forwarding information for the given fqdn
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: customerId
in: path
type: string
description: 'The Customer identifier<br/> Note: For API Resellers, performing actions on behalf of your customers,
you need to specify the Subaccount you''re operating on beh'
required: true
- name: fqdn
in: path
type: string
description: The fully qualified domain name whose forwarding details are to be modified.
required: true
- name: body
in: body
type: string
description: Domain forwarding rule to create or replace on the fqdn
required: true
- name: domainsforwardspost
method: POST
description: Create a new forwarding configuration for the given FQDN
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: customerId
in: path
type: string
description: 'The Customer identifier<br/> Note: For API Resellers, performing actions on behalf of your customers,
you need to specify the Subaccount you''re operating on beh'
required: true
- name: fqdn
in: path
type: string
description: The fully qualified domain name whose forwarding details are to be modified.
required: true
- name: body
in: body
type: string
description: Domain forwarding rule to create for the specified fqdn
required: true
- name: v2-customers-customerId-domains-register
path: /v2/customers/{customerId}/domains/register
operations:
- name: post
method: POST
description: Purchase and register the specified Domain
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: X-Request-Id
in: header
type: string
description: A client provided identifier for tracking this request.
- name: customerId
in: path
type: string
description: 'The Customer identifier<br/> Note: For API Resellers, performing actions on behalf of your customers,
you need to specify the Subaccount you''re operating on beh'
required: true
- name: body
in: body
type: string
description: An instance document expected to match the JSON schema returned by `./schema/{tld}`
required: true
- name: v2-customers-customerId-domains-register-schema-tld
path: /v2/customers/{customerId}/domains/register/schema/{tld}
operations:
- name: get
method: GET
description: Retrieve the schema to be submitted when registering a Domain for the specified TLD
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: X-Request-Id
in: header
type: string
description: A client provided identifier for tracking this request.
- name: customerId
in: path
type: string
description: 'The Customer identifier<br/> Note: For API Resellers, performing actions on behalf of your customers,
you need to specify the Subaccount you''re operating on beh'
required: true
- name: tld
in: path
type: string
description: The Top-Level Domain whose schema should be retrieved
required: true
- name: v2-customers-customerId-domains-register-validate
path: /v2/customers/{customerId}/domains/register/validate
operations:
- name: post
method: POST
description: Validate the request body using the Domain Registration Schema for the specified TLD
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: X-Request-Id
in: header
type: string
description: A client provided identifier for tracking this request.
- name: customerId
in: path
type: string
description: 'The Customer identifier<br/> Note: For API Resellers, performing actions on behalf of your customers,
you need to specify the Subaccount you''re operating on beh'
required: true
- name: body
in: body
type: string
description: An instance document expected to match the JSON schema returned by `./schema/{tld}`
required: true
- name: v2-customers-customerId-domains-domain
path: /v2/customers/{customerId}/domains/{domain}
operations:
- name: get
method: GET
description: Retrieve details for the specified Domain
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: X-Request-Id
in: header
type: string
description: A client provided identifier for tracking this request.
- name: customerId
in: path
type: string
description: 'The Customer identifier<br/> Note: For API Resellers, performing actions on behalf of your customers,
you need to specify the Subaccount you''re operating on beh'
required: true
- name: domain
in: path
type: string
description: Domain name whose details are to be retrieved
required: true
- name: includes
in: query
type: array
description: Optional details to be included in the response
- name: v2-customers-customerId-domains-domain-changeOfRegistrant
path: /v2/customers/{customerId}/domains/{domain}/changeOfRegistrant
operations:
- name: delete
method: DELETE
description: Cancels a pending change of registrant request for a given domain
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: X-Request-Id
in: header
type: string
description: A client provided identifier for tracking this request.
- name: customerId
in: path
type: string
description: 'The Customer identifier<br/> Note: For API Resellers, performing actions on behalf of your customers,
you need to specify the Subaccount you''re operating on beh'
required: true
- name: domain
in: path
type: string
description: Domain whose change of registrant is to be cancelled
required: true
- name: get
method: GET
description: Retrieve change of registrant information
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: X-Request-Id
in: header
type: string
description: A client provided identifier for tracking this request.
- name: customerId
in: path
type: string
description: 'The Customer identifier<br/> Note: For API Resellers, performing actions on behalf of your customers,
you need to specify the Subaccount you''re operating on beh'
required: true
- name: domain
in: path
type: string
description: Domain whose change of registrant information is to be retrieved
required: true
- name: v2-customers-customerId-domains-domain-dnssecRecords
path: /v2/customers/{customerId}/domains/{domain}/dnssecRecords
operations:
- name: patch
method: PATCH
description: Add the specifed DNSSEC records to the domain
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: X-Request-Id
in: header
type: string
description: A client provided identifier for tracking this request.
- name: customerId
in: path
type: string
description: 'The Customer identifier<br/> Note: For API Resellers, performing actions on behalf of your customers,
you need to specify the Subaccount you''re operating on beh'
required: true
- name: domain
in: path
type: string
description: Domain to add the DNSSEC record for
required: true
- name: body
in: body
type: array
description: DNSSEC records to add
required: true
- name: delete
method: DELETE
description: Remove the specifed DNSSEC record from the domain
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: X-Request-Id
in: header
type: string
description: A client provided identifier for tracking this request.
- name: customerId
in: path
type: string
description: 'The Customer identifier<br/> Note: For API Resellers, performing actions on behalf of your customers,
you need to specify the Subaccount you''re operating on beh'
required: true
- name: domain
in: path
type: string
description: Domain to delete the DNSSEC record for
required: true
- name: body
in: body
type: array
description: DNSSEC records to remove
required: true
- name: v2-customers-customerId-domains-domain-nameServers
path: /v2/customers/{customerId}/domains/{domain}/nameServers
operations:
- name: put
method: PUT
description: Replaces the existing name servers on the domain.
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: X-Request-Id
in: header
type: string
description: A client provided identifier for tracking this request.
- name: customerId
in: path
type: string
description: 'The Customer identifier<br/> Note: For API Resellers, performing actions on behalf of your customers,
you need to specify the Subaccount you''re operating on beh'
required: true
- name: domain
in: path
type: string
description: Domain whose name servers are to be replaced
required: true
- name: body
in: body
type: string
description: Name server records to replace on the domain
required: true
- name: v2-customers-customerId-domains-domain-privacy-forwarding
path: /v2/customers/{customerId}/domains/{domain}/privacy/forwarding
operations:
- name: get
method: GET
description: Retrieve privacy email forwarding settings showing where emails are delivered
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: X-Request-Id
in: header
type: string
description: A client provided identifier for tracking this request.
- name: customerId
in: path
type: string
description: 'The Customer identifier<br/> Note: For API Resellers, performing actions on behalf of your customers,
you need to specify the Subaccount you''re operating on beh'
required: true
- name: domain
in: path
type: string
description: Domain name whose details are to be retrieved
required: true
- name: patch
method: PATCH
description: Update privacy email forwarding settings to determine how emails are delivered
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: X-Request-Id
in: header
type: string
description: A client provided identifier for tracking this request.
- name: customerId
in: path
type: string
description: 'The Customer identifier<br/> Note: For API Resellers, performing actions on behalf of your customers,
you need to specify the Subaccount you''re operating on beh'
required: true
- name: domain
in: path
type: string
description: Domain name whose details are to be retrieved
required: true
- name: body
in: body
type: string
description: Update privacy email forwarding settings
required: true
- name: v2-customers-customerId-domains-domain-redeem
path: /v2/customers/{customerId}/domains/{domain}/redeem
operations:
- name: post
method: POST
description: Purchase a restore for the given domain to bring it out of redemption
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: X-Request-Id
in: header
type: string
description: A client provided identifier for tracking this request.
- name: customerId
in: path
type: string
description: 'The Customer identifier<br/> Note: For API Resellers, performing actions on behalf of your customers,
you need to specify the Subaccount you''re operating on beh'
required: true
- name: domain
in: path
type: string
description: Domain to request redeem for
required: true
- name: body
in: body
type: string
description: Options for redeeming existing Domain
- name: v2-customers-customerId-domains-domain-regenerateAuthCode
path: /v2/customers/{customerId}/domains/{domain}/regenerateAuthCode
operations:
- name: post
method: POST
description: Regenerate the auth code for the given domain
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: X-Request-Id
in: header
type: string
description: A client provided identifier for tracking this request.
- name: customerId
in: path
type: string
description: 'The Customer identifier<br/> Note: For API Resellers, performing actions on behalf of your customers,
you need to specify the Subaccount you''re operating on beh'
required: true
- name: domain
in: path
type: string
description: Domain to update authcode for
required: true
- name: v2-customers-customerId-domains-domain-renew
path: /v2/customers/{customerId}/domains/{domain}/renew
operations:
- name: post
method: POST
description: Renew the specified Domain
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: X-Request-Id
in: header
type: string
description: A client provided identifier for tracking this request.
- name: customerId
in: path
type: string
description: 'The Customer identifier<br/> Note: For API Resellers, performing actions on behalf of your customers,
you need to specify the Subaccount you''re operating on beh'
required: true
- name: domain
in: path
type: string
description: Domain to be renewed
required: true
- name: body
in: body
type: string
description: Options for renewing existing Domain
required: true
- name: v2-customers-customerId-domains-domain-transfer
path: /v2/customers/{customerId}/domains/{domain}/transfer
operations:
- name: post
method: POST
description: Purchase and start or restart transfer process
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: X-Request-Id
in: header
type: string
description: A client provided identifier for tracking this request.
- name: customerId
in: path
type: string
description: 'The Customer identifier<br/> Note: For API Resellers, performing actions on behalf of your customers,
you need to specify the Subaccount you''re operating on beh'
required: true
- name: domain
in: path
type: string
description: Domain to transfer in
required: true
- name: body
in: body
type: string
description: Details for domain transfer purchase
required: true
- name: get
method: GET
description: Query the current transfer status
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: X-Request-Id
in: header
type: string
description: A client provided identifier for tracking this request.
- name: customerId
in: path
type: string
description: 'The Customer identifier<br/> Note: For API Resellers, performing actions on behalf of your customers,
you need to specify the Subaccount you''re operating on beh'
required: true
- name: domain
in: path
type: string
description: Domain Name
required: true
- name: v2-customers-customerId-domains-domain-transfer-validate
path: /v2/customers/{customerId}/domains/{domain}/transfer/validate
operations:
- name: post
method: POST
description: Validate the request body using the Domain Transfer Schema for the specified TLD
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: X-Request-Id
in: header
type: string
description: A client provided identifier for tracking this request.
- name: customerId
in: path
type: string
description: 'The Customer identifier<br/> Note: For API Resellers, performing actions on behalf of your customers,
you need to specify the Subaccount you''re operating on beh'
required: true
- name: domain
in: path
type: string
description: Domain to transfer in
required: true
- name: body
in: body
type: string
description: Details for domain transfer purchase
required: true
- name: v2-customers-customerId-domains-domain-transferInAccept
path: /v2/customers/{customerId}/domains/{domain}/transferInAccept
operations:
- name: post
method: POST
description: Accepts the transfer in
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: X-Request-Id
in: header
type: string
description: A client provided identifier for tracking this request.
- name: customerId
in: path
type: string
description: 'The Customer identifier<br/> Note: For API Resellers, performing actions on behalf of your customers,
you need to specify the Subaccount you''re operating on beh'
required: true
- name: domain
in: path
type: string
description: Domain to accept the transfer in for
required: true
- name: body
in: body
type: string
description: An Authorization code for transferring the Domain
required: true
- name: v2-customers-customerId-domains-domain-transferInCancel
path: /v2/customers/{customerId}/domains/{domain}/transferInCancel
operations:
- name: post
method: POST
description: Cancels the transfer in
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: X-Request-Id
in: header
type: string
description: A client provided identifier for tracking this request.
- name: customerId
in: path
type: string
description: 'The Customer identifier<br/> Note: For API Resellers, performing actions on behalf of your customers,
you need to specify the Subaccount you''re operating on beh'
required: true
- name: domain
in: path
type: string
description: Domain to cancel the transfer in for
required: true
- name: v2-customers-customerId-domains-domain-transferInRestart
path: /v2/customers/{customerId}/domains/{domain}/transferInRestart
operations:
- name: post
method: POST
description: Restarts transfer in request from the beginning
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: X-Request-Id
in: header
type: string
description: A client provided identifier for tracking this request.
- name: customerId
in: path
type: string
description: 'The Customer identifier<br/> Note: For API Resellers, performing actions on behalf of your customers,
you need to specify the Subaccount you''re operating on beh'
required: true
- name: domain
in: path
type: string
description: Domain to restart the transfer in
required: true
- name: v2-customers-customerId-domains-domain-transferInRetry
path: /v2/customers/{customerId}/domains/{domain}/transferInRetry
operations:
- name: post
method: POST
description: Retries the current transfer in request with supplied Authorization code
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: X-Request-Id
in: header
type: string
description: A client provided identifier for tracking this request.
- name: customerId
in: path
type: string
description: 'The Customer identifier<br/> Note: For API Resellers, performing actions on behalf of your customers,
you need to specify the Subaccount you''re operating on beh'
required: true
- name: domain
in: path
type: string
description: Domain to retry the transfer in
required: true
- name: body
in: body
type: string
description: An Authorization code for transferring the Domain
required: true
- name: v2-customers-customerId-domains-domain-transferOut
path: /v2/customers/{customerId}/domains/{domain}/transferOut
operations:
- name: post
method: POST
description: Initiate transfer out to another registrar for a .uk domain.
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: X-Request-Id
in: header
type: string
description: A client provided identifier for tracking this request.
- name: customerId
in: path
type: string
description: 'The Customer identifier<br/> Note: For API Resellers, performing actions on behalf of your customers,
you need to specify the Subaccount you''re operating on beh'
required: true
- name: domain
in: path
type: string
description: Domain to initiate the transfer out for
required: true
- name: registrar
in: query
type: string
description: Registrar tag to push transfer to
required: true
- name: v2-customers-customerId-domains-domain-transferOutAccept
path: /v2/customers/{customerId}/domains/{domain}/transferOutAccept
operations:
- name: post
method: POST
description: Accept transfer out
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: X-Request-Id
in: header
type: string
description: A client provided identifier for tracking this request.
- name: customerId
in: path
type: string
description: 'The Customer identifier<br/> Note: For API Resellers, performing actions on behalf of your customers,
you need to specify the Subaccount you''re operating on beh'
required: true
- name: domain
in: path
type: string
description: Domain to accept the transfer out for
required: true
- name: v2-customers-customerId-domains-domain-transferOutReject
path: /v2/customers/{customerId}/domains/{domain}/transferOutReject
operations:
- name: post
method: POST
description: Reject transfer out
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: X-Request-Id
in: header
type: string
description: A client provided identifier for tracking this request.
- name: customerId
in: path
type: string
description: 'The Customer identifier<br/> Note: For API Resellers, performing actions on behalf of your customers,
you need to specify the Subaccount you''re operating on beh'
required: true
- name: domain
in: path
type: string
description: Domain to reject the transfer out for
required: true
- name: reason
in: query
type: string
description: Transfer out reject reason
- name: v2-domains-maintenances
path: /v2/domains/maintenances
operations:
- name: get
method: GET
description: Retrieve a list of upcoming system Maintenances
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: X-Request-Id
in: header
type: string
description: A client provided identifier for tracking this request.
- name: status
in: query
type: string
description: 'Only include results with the selected `status` value. Returns all results if omitted<br/><ul><li><strong
style=''margin-left: 12px;''>ACTIVE</strong> - The upco'
- name: modifiedAtAfter
in: query
type: string
description: Only include results with `modifiedAt` after the supplied date
- name: startsAtAfter
in: query
type: string
description: Only include results with `startsAt` after the supplied date
- name: limit
in: query
type: integer
description: Maximum number of results to return
- name: v2-domains-maintenances-maintenanceId
path: /v2/domains/maintenances/{maintenanceId}
operations:
- name: get
method: GET
description: Retrieve the details for an upcoming system Maintenances
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: X-Request-Id
in: header
type: string
description: A client provided identifier for tracking this request.
- name: maintenanceId
in: path
type: string
description: The identifier for the system maintenance
required: true
- name: v2-domains-usage-yyyymm
path: /v2/domains/usage/{yyyymm}
operations:
- name: get
method: GET
description: Retrieve api usage request counts for a specific year/month. The data is retained for a period of three
months.
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: X-Request-Id
in: header
type: string
description: A client provided identifier for tracking this request.
- name: yyyymm
in: path
type: string
description: The year/month timeframe for the request counts (in the format yyyy-mm)
required: true
- name: includes
in: query
type: array
description: Determines if the detail records (grouped by request path) are included in the response
exposes:
- type: rest
namespace: domains-domains-rest
port: 8080
# --- truncated at 32 KB (62 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/godaddy/refs/heads/main/capabilities/domains-domains.yaml