GoDaddy
Support
API ReferenceDomains & DNSv1 (Legacy)Manage DNS

Manage DNS

View as Markdown

Add the specified DNS Records to the specified Domain

PATCH
/v1/domains/{domain}/records

Authorization

bearerAuth
AuthorizationBearer <token>

Personal Access Token (PAT). Generate one from the developer dashboard. Pass as: Authorization: Bearer .

In: header

Path Parameters

domain*string

Domain whose DNS Records are to be augmented

Header Parameters

X-Shopper-Id?string

Shopper ID which owns the domain. NOTE: This is only required if you are a Reseller managing a domain purchased outside the scope of your reseller account.

Request Body

DNS Records to add to whatever currently exists

[index: integer]?

Response Body

curl -X PATCH "https://example.com/v1/domains/string/records" \  -H "Content-Type: application/json" \  -d '[    {      "data": "string",      "name": "string",      "type": "A"    }  ]'
Empty

Replace all DNS Records for the specified Domain

PUT
/v1/domains/{domain}/records

Authorization

bearerAuth
AuthorizationBearer <token>

Personal Access Token (PAT). Generate one from the developer dashboard. Pass as: Authorization: Bearer .

In: header

Path Parameters

domain*string

Domain whose DNS Records are to be replaced

Header Parameters

X-Shopper-Id?string

Shopper ID which owns the domain. NOTE: This is only required if you are a Reseller managing a domain purchased outside the scope of your reseller account.

Request Body

DNS Records to replace whatever currently exists

[index: integer]?

Response Body

curl -X PUT "https://example.com/v1/domains/string/records" \  -H "Content-Type: application/json" \  -d '[    {      "data": "string",      "name": "string",      "type": "A"    }  ]'
Empty

Retrieve DNS Records for the specified Domain, optionally with the specified Type and/or Name

GET
/v1/domains/{domain}/records/{type}/{name}

Authorization

bearerAuth
AuthorizationBearer <token>

Personal Access Token (PAT). Generate one from the developer dashboard. Pass as: Authorization: Bearer .

In: header

Path Parameters

domain*string

Domain whose DNS Records are to be retrieved

type*string

DNS Record Type for which DNS Records are to be retrieved

Value in

  • "A"
  • "AAAA"
  • "CAA"
  • "CNAME"
  • "MX"
  • "NS"
  • "SOA"
  • "SRV"
  • "TXT"
name*string

DNS Record Name for which DNS Records are to be retrieved

Query Parameters

offset?integer

Number of results to skip for pagination

limit?integer

Maximum number of items to return

Header Parameters

X-Shopper-Id?string

Shopper ID which owns the domain. NOTE: This is only required if you are a Reseller managing a domain purchased outside the scope of your reseller account.

Response Body

curl -X GET "https://example.com/v1/domains/string/records/A/string"
[  {    "data": "string",    "name": "string",    "port": 1,    "priority": 0,    "protocol": "string",    "service": "string",    "ttl": 0,    "type": "A",    "weight": 0  }]

Delete all DNS Records for the specified Domain with the specified Type and Name

DELETE
/v1/domains/{domain}/records/{type}/{name}

Authorization

bearerAuth
AuthorizationBearer <token>

Personal Access Token (PAT). Generate one from the developer dashboard. Pass as: Authorization: Bearer .

In: header

Path Parameters

domain*string

Domain whose DNS Records are to be deleted

type*string

DNS Record Type for which DNS Records are to be deleted

Value in

  • "A"
  • "AAAA"
  • "CAA"
  • "CNAME"
  • "MX"
  • "SRV"
  • "TXT"
name*string

DNS Record Name for which DNS Records are to be deleted

Header Parameters

X-Shopper-Id?string

Shopper ID which owns the domain. NOTE: This is only required if you are a Reseller managing a domain purchased outside the scope of your reseller account.

Response Body

curl -X DELETE "https://example.com/v1/domains/string/records/A/string"
Empty

Replace all DNS Records for the specified Domain with the specified Type and Name

PUT
/v1/domains/{domain}/records/{type}/{name}

Authorization

bearerAuth
AuthorizationBearer <token>

Personal Access Token (PAT). Generate one from the developer dashboard. Pass as: Authorization: Bearer .

In: header

Path Parameters

domain*string

Domain whose DNS Records are to be replaced

type*string

DNS Record Type for which DNS Records are to be replaced

Value in

  • "A"
  • "AAAA"
  • "CAA"
  • "CNAME"
  • "MX"
  • "NS"
  • "SOA"
  • "SRV"
  • "TXT"
name*string

DNS Record Name for which DNS Records are to be replaced

Header Parameters

X-Shopper-Id?string

Shopper ID which owns the domain. NOTE: This is only required if you are a Reseller managing a domain purchased outside the scope of your reseller account.

Request Body

DNS Records to replace whatever currently exists

[index: integer]?

Response Body

curl -X PUT "https://example.com/v1/domains/string/records/A/string" \  -H "Content-Type: application/json" \  -d '[    {      "data": "string"    }  ]'
Empty

Replace all DNS Records for the specified Domain with the specified Type

PUT
/v1/domains/{domain}/records/{type}

Authorization

bearerAuth
AuthorizationBearer <token>

Personal Access Token (PAT). Generate one from the developer dashboard. Pass as: Authorization: Bearer .

In: header

Path Parameters

domain*string

Domain whose DNS Records are to be replaced

type*string

DNS Record Type for which DNS Records are to be replaced

Value in

  • "A"
  • "AAAA"
  • "CAA"
  • "CNAME"
  • "MX"
  • "NS"
  • "SOA"
  • "SRV"
  • "TXT"

Header Parameters

X-Shopper-Id?string

Shopper ID which owns the domain. NOTE: This is only required if you are a Reseller managing a domain purchased outside the scope of your reseller account.

Request Body

DNS Records to replace whatever currently exists

[index: integer]?

Response Body

curl -X PUT "https://example.com/v1/domains/string/records/A" \  -H "Content-Type: application/json" \  -d '[    {      "data": "string",      "name": "string"    }  ]'
Empty

Agent & Automation Notes

Scopesdomains.domain:read, domains.domain:create, domains.domain:delete, domains.domain:update, domains.contact:update, domains.dns:update, domains.transfer:execute
Rate limit60 req/min per credential
On failureGET operations are safe to retry. PUT/PATCH DNS are idempotent by shape. POST purchase is NOT idempotent — verify state before retrying.

Related

Last updated on

How is this guide?