Records

CRUD operations on DNS records within the GoDaddy-managed zone. Sub-collection of /zones/{zone}. Changes are applied synchronously.

List DNS records in a zone

Authorization

bearerAuth

AuthorizationBearer <token>

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

In: header

Path Parameters

zone*string

The domain name in punycode A-label form (for example, example.com). For IDNs, use the punycode representation.

Query Parameters

page?integer

One-based page number for offset-based pagination. Defaults to 1.

Range1 <= value

Default1

pageSize?integer

Maximum number of items to return per page.

Range1 <= value <= 100

Default25

totalRequired?boolean

When true, the response includes totalItems and totalPages for the current filter when at least one record matches. Both are omitted when the result set is empty. Defaults to false; omitting totals avoids the cost of a count query on large collections.

Defaultfalse

fields?string

Comma-separated list of fields to include in each item of the response. Omitted fields are excluded from the payload. When absent, all fields are returned. Field names must match properties defined on the item schema for the operation; any unknown or invalid name returns 400 Bad Request.

type?DNS Record Type

Filter results to records of this DNS type.

Value in

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

name?string

Filter results to records with this host name relative to the zone. Use @ for the zone apex.

Header Parameters

X-Request-Id?string

Optional client-generated request correlation identifier, propagated across services and returned in the response X-Request-Id header.

Formatuuid

Response Body

`application/json`

curl -X GET "https://example.com/zones/example.com/dns-records?page=2&pageSize=25&totalRequired=true&fields=name%2Ctype%2Cdata%2Cttl&type=A&name=app2"

{  "items": [    {      "recordId": "Aad7oqdXCms9mlJvm_m6UFYqmwjyP20H2KBmQHgttK9kGbF_TuI3knsocArQqIv5I0Kq5C0",      "name": "@",      "type": "A",      "data": "192.0.2.1",      "ttl": 3600    },    {      "recordId": "ARZaSm3N9qvJemM6yBmuXIO6F_YIfqSiZcaHhHFozlDsDhdOr1njlXc09TAPJlm8dXqGttRrjRKIgiXpXVm9fms",      "name": "app2",      "type": "A",      "data": "192.0.2.2",      "ttl": 3600    }  ],  "totalItems": 150,  "totalPages": 6,  "links": [    {      "rel": "self",      "href": "https://api.godaddy.com/v3/domains/zones/example.com/dns-records?type=A&name=app2&page=2&pageSize=25&totalRequired=true"    },    {      "rel": "first",      "href": "https://api.godaddy.com/v3/domains/zones/example.com/dns-records?type=A&name=app2&page=1&pageSize=25&totalRequired=true"    },    {      "rel": "last",      "href": "https://api.godaddy.com/v3/domains/zones/example.com/dns-records?type=A&name=app2&page=6&pageSize=25&totalRequired=true"    },    {      "rel": "next",      "href": "https://api.godaddy.com/v3/domains/zones/example.com/dns-records?type=A&name=app2&page=3&pageSize=25&totalRequired=true"    },    {      "rel": "prev",      "href": "https://api.godaddy.com/v3/domains/zones/example.com/dns-records?type=A&name=app2&page=1&pageSize=25&totalRequired=true"    }  ]}

Create a DNS record for a zone

Authorization

bearerAuth

AuthorizationBearer <token>

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

In: header

Path Parameters

zone*string

The domain name in punycode A-label form (for example, example.com). For IDNs, use the punycode representation.

Header Parameters

X-Request-Id?string

Optional client-generated request correlation identifier, propagated across services and returned in the response X-Request-Id header.

Formatuuid

Request Body

application/json

A single DNS resource record within a zone.

name*string

The DNS record name relative to the zone apex. Use @ to represent the zone apex itself (e.g. the bare domain example.com).

Length1 <= length <= 255

type*DNS Record Type

Value in

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

data*string

The record value. Format is type-specific — for example, an IPv4 address for A records, or a hostname for CNAME and MX records.

Length1 <= length <= 512

ttl*integer

Time-to-live in seconds. Controls how long resolvers cache this record.

Range600 <= value <= 86400

priority?integer

Priority value for MX and SRV records. Lower values are preferred.

Range0 <= value <= 65535

service?string

Service label for SRV records (e.g. _http).

port?integer

Port number for SRV records.

Range0 <= value <= 65535

weight?integer

Weight for SRV load balancing among records with equal priority. Higher weight increases the probability of selection.

Range0 <= value <= 65535

protocol?string

Protocol identifier for SRV records (e.g. _tcp, _udp).

flag?integer

Flag byte for CAA records. 0 indicates non-critical; 128 indicates critical (the issuer must understand the tag property to proceed).

Range0 <= value <= 255

tag?string

Tag property for CAA records. Common values: issue, issuewild, iodef.

Response Body

`application/json`

curl -X POST "https://example.com/zones/example.com/dns-records" \  -H "Content-Type: application/json" \  -d '{    "name": "@",    "type": "A",    "data": "192.0.2.1",    "ttl": 3600  }'

{  "recordId": "string",  "name": "string",  "type": "A",  "data": "string",  "ttl": 600,  "priority": 0,  "service": "string",  "port": 0,  "weight": 0,  "protocol": "string",  "flag": 0,  "tag": "string"}

Replace a DNS record

Authorization

bearerAuth

AuthorizationBearer <token>

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

In: header

Path Parameters

zone*string

The domain name in punycode A-label form (for example, example.com). For IDNs, use the punycode representation.

recordId*string

Server-assigned DNS record identifier within the zone.

Header Parameters

X-Request-Id?string

Optional client-generated request correlation identifier, propagated across services and returned in the response X-Request-Id header.

Formatuuid

Request Body

application/json

A single DNS resource record within a zone.

name*string

The DNS record name relative to the zone apex. Use @ to represent the zone apex itself (e.g. the bare domain example.com).

Length1 <= length <= 255

type*DNS Record Type

Value in

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

data*string

The record value. Format is type-specific — for example, an IPv4 address for A records, or a hostname for CNAME and MX records.

Length1 <= length <= 512

ttl*integer

Time-to-live in seconds. Controls how long resolvers cache this record.

Range600 <= value <= 86400

priority?integer

Priority value for MX and SRV records. Lower values are preferred.

Range0 <= value <= 65535

service?string

Service label for SRV records (e.g. _http).

port?integer

Port number for SRV records.

Range0 <= value <= 65535

weight?integer

Weight for SRV load balancing among records with equal priority. Higher weight increases the probability of selection.

Range0 <= value <= 65535

protocol?string

Protocol identifier for SRV records (e.g. _tcp, _udp).

flag?integer

Flag byte for CAA records. 0 indicates non-critical; 128 indicates critical (the issuer must understand the tag property to proceed).

Range0 <= value <= 255

tag?string

Tag property for CAA records. Common values: issue, issuewild, iodef.

Response Body

`application/json`

curl -X PUT "https://example.com/zones/example.com/dns-records/Aad7oqdXCms9mlJvm_m6UFYqmwjyP20H2KBmQHgttK9kGbF_TuI3knsocArQqIv5I0Kq5C0" \  -H "Content-Type: application/json" \  -d '{    "name": "@",    "type": "A",    "data": "192.0.2.1",    "ttl": 3600  }'

{  "recordId": "string",  "name": "string",  "type": "A",  "data": "string",  "ttl": 600,  "priority": 0,  "service": "string",  "port": 0,  "weight": 0,  "protocol": "string",  "flag": 0,  "tag": "string"}

Delete a DNS record

Authorization

bearerAuth

AuthorizationBearer <token>

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

In: header

Path Parameters

zone*string

The domain name in punycode A-label form (for example, example.com). For IDNs, use the punycode representation.

recordId*string

Server-assigned DNS record identifier within the zone.

Header Parameters

X-Request-Id?string

Optional client-generated request correlation identifier, propagated across services and returned in the response X-Request-Id header.

Formatuuid

Response Body

`application/json`

curl -X DELETE "https://example.com/zones/example.com/dns-records/Aad7oqdXCms9mlJvm_m6UFYqmwjyP20H2KBmQHgttK9kGbF_TuI3knsocArQqIv5I0Kq5C0"

Empty

Agent & Automation Notes

Scopesdomains.domain:read, domains.domain:create, domains.dns:update, domains.nameserver:update

Rate limit60 req/min per credential

On failureGET operations are safe to retry. POST registrations use Idempotency-Key. Poll async operations — do not resubmit.

Guides

Concepts

Last updated on

Records

200application/json

400application/json

401application/json

403application/json

404application/json

429application/json

201application/json

400application/json

401application/json

403application/json

404application/json

409application/json

422application/json

429application/json

200application/json

400application/json

401application/json

403application/json

404application/json

409application/json

422application/json

429application/json

204

400application/json

401application/json

403application/json

404application/json

409application/json

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