Domain Management
View as MarkdownNon-commercial async mutations on owned domain instances: contacts, nameservers, privacy, auto-renew, and transfer-lock. All sub-resources of /domain-names/{domain-name}. All mutations return a DomainOperation for polling.
Replace the nameservers for a domain
Authorization
bearerAuth AuthorizationBearer <token>
Personal Access Token (PAT). Generate one from the developer dashboard. Pass as: Authorization: Bearer <token>.
In: header
Path Parameters
domain-name*string
The domain name in punycode A-label form (e.g., 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.
Format
uuidIdempotency-Key*string
Client-generated unique key (UUID recommended). Retrying a mutating request with the same Idempotency-Key returns the original response without creating a duplicate side effect. Required on all execute endpoints.
Length
16 <= length <= 64Request Body
application/json
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X PUT "https://api.godaddy.com/v3/domains/domain-names/example.com/nameservers" \ -H "Idempotency-Key: 9f1c2e7a-4b3d-4e8f-a1c2-3d4e5f6a7b8c" \ -H "Content-Type: application/json" \ -d '[ "ns1.example.com", "ns2.example.com" ]'{
"operationId": "9f1c2e7a-4b3d-4e8f-a1c2-3d4e5f6a7b8c",
"type": "string",
"domain": "example.com",
"status": "string",
"result": {
"expiresAt": "string",
"orderId": "ord_abc123",
"updatedAt": "string"
},
"error": {
"name": "string",
"correlationId": "string",
"message": "string",
"informationLink": "string",
"details": [
{
"field": "string",
"value": "string",
"location": "body",
"issue": "string",
"description": "string"
}
],
"links": [
{
"href": "http://example.com",
"rel": "string",
"title": "string",
"targetMediaType": "string",
"targetSchema": null,
"method": "string",
"submissionMediaType": "application/json",
"submissionSchema": null
}
]
},
"links": [
{
"href": "http://example.com",
"rel": "string",
"title": "string",
"targetMediaType": "string",
"targetSchema": null,
"method": "string",
"submissionMediaType": "application/json",
"submissionSchema": null
}
],
"createdAt": "string",
"updatedAt": "string"
}{
"name": "string",
"correlationId": "string",
"message": "string",
"informationLink": "string",
"details": [
{
"field": "string",
"value": "string",
"location": "body",
"issue": "string",
"description": "string"
}
],
"links": [
{
"href": "http://example.com",
"rel": "string",
"title": "string",
"targetMediaType": "string",
"targetSchema": null,
"method": "string",
"submissionMediaType": "application/json",
"submissionSchema": null
}
]
}{
"name": "string",
"correlationId": "string",
"message": "string",
"informationLink": "string",
"details": [
{
"field": "string",
"value": "string",
"location": "body",
"issue": "string",
"description": "string"
}
],
"links": [
{
"href": "http://example.com",
"rel": "string",
"title": "string",
"targetMediaType": "string",
"targetSchema": null,
"method": "string",
"submissionMediaType": "application/json",
"submissionSchema": null
}
]
}{
"name": "string",
"correlationId": "string",
"message": "string",
"informationLink": "string",
"details": [
{
"field": "string",
"value": "string",
"location": "body",
"issue": "string",
"description": "string"
}
],
"links": [
{
"href": "http://example.com",
"rel": "string",
"title": "string",
"targetMediaType": "string",
"targetSchema": null,
"method": "string",
"submissionMediaType": "application/json",
"submissionSchema": null
}
]
}{
"name": "string",
"correlationId": "string",
"message": "string",
"informationLink": "string",
"details": [
{
"field": "string",
"value": "string",
"location": "body",
"issue": "string",
"description": "string"
}
],
"links": [
{
"href": "http://example.com",
"rel": "string",
"title": "string",
"targetMediaType": "string",
"targetSchema": null,
"method": "string",
"submissionMediaType": "application/json",
"submissionSchema": null
}
]
}{
"name": "string",
"correlationId": "string",
"message": "string",
"informationLink": "string",
"details": [
{
"field": "string",
"value": "string",
"location": "body",
"issue": "string",
"description": "string"
}
],
"links": [
{
"href": "http://example.com",
"rel": "string",
"title": "string",
"targetMediaType": "string",
"targetSchema": null,
"method": "string",
"submissionMediaType": "application/json",
"submissionSchema": null
}
]
}{
"name": "string",
"correlationId": "string",
"message": "string",
"informationLink": "string",
"details": [
{
"field": "string",
"value": "string",
"location": "body",
"issue": "string",
"description": "string"
}
],
"links": [
{
"href": "http://example.com",
"rel": "string",
"title": "string",
"targetMediaType": "string",
"targetSchema": null,
"method": "string",
"submissionMediaType": "application/json",
"submissionSchema": null
}
]
}Agent & Automation Notes
Scopes
domains.domain:read, domains.domain:create, domains.dns:update, domains.nameserver:updateRate limit60 req/min per credential
On failureGET operations are safe to retry. POST registrations use Idempotency-Key. Poll async operations — do not resubmit.
Related
Last updated on
How is this guide?