API ReferenceDomainDomain LifecycleDomains & DNSv1 (Legacy)Register and Renew DomainsGet the registration schema for a TLD GET
Get the registration schema for a TLD
View as MarkdownReturns the JSON schema for the domain purchase request body for the specified TLD.
Full description
Returns the JSON schema for the domain purchase request body for the specified TLD. Fetch before purchasing to identify required fields and TLD-specific constraints.
Authorization
bearerAuth AuthorizationBearer <token>
Personal Access Token (PAT). Generate one from the developer dashboard. Pass as: Authorization: Bearer .
In: header
Path Parameters
tld*string
The Top-Level Domain whose schema should be retrieved
Response Body
curl -X GET "https://example.com/v1/domains/purchase/schema/string"{ "id": "string", "models": [ {} ], "properties": [ { "defaultValue": "string", "format": "string", "items": [ { "format": "string", "pattern": "string", "type": "string" } ], "maxItems": 0, "maximum": 0, "minItems": 0, "minimum": 0, "pattern": "string", "required": true, "type": "string" } ], "required": [ "string" ], "type": "object"}Agent & Automation Notes
Scopes
domains.domain:read, domains.domain:create, domains.domain:delete, domains.domain:update, domains.contact:update, domains.dns:update, domains.transfer:executeRate 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?