Register Domains

Purchase and register the specified Domain

Authorization

bearerAuth

AuthorizationBearer <token>

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

In: header

Path Parameters

customerId*string

The Customer identifier. Note: For API Resellers, performing actions on behalf of your customers, you need to specify the Subaccount customer identifier you're operating on behalf of.

Header Parameters

X-Request-Id?string

A client provided identifier for tracking this request.

Request Body

application/json

An instance document expected to match the JSON schema returned by ./schema/{tld}

domain*string

For internationalized domain names with non-ascii characters, the domain name is converted to punycode before format and pattern validation rules are checked

Match^[^.]{1,63}.[^.]{2,}$

Formatdomain

consent*

period?integer

Match^[0-9]+$

Formatinteger-positive

Range1 <= value <= 10

Default1

nameServers?array<>

Itemsitems <= 2

renewAuto?boolean

Defaulttrue

privacy?boolean

Defaultfalse

contacts?

metadata?

The domain eligibility data fields as specified by GET /v2/customers/{customerId}/domains/register/schema/{tld}

Response Body

`application/json`

curl -X POST "https://example.com/v2/customers/string/domains/register" \  -H "Content-Type: application/json" \  -d '{    "domain": "string",    "consent": {      "agreementKeys": [        "string"      ],      "price": 0,      "currency": "USD",      "agreedBy": "string",      "agreedAt": "string"    }  }'

Empty

Retrieve the schema to be submitted when registering a Domain for the specified TLD

Authorization

bearerAuth

AuthorizationBearer <token>

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

In: header

Path Parameters

customerId*string

The Customer identifier. Note: For API Resellers, performing actions on behalf of your customers, you need to specify the Subaccount customer identifier you're operating on behalf of.

tld*string

The Top-Level Domain whose schema should be retrieved

Header Parameters

X-Request-Id?string

A client provided identifier for tracking this request.

Response Body

`application/json`

curl -X GET "https://example.com/v2/customers/string/domains/register/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"}

Validate the request body using the Domain Registration Schema for the specified TLD

Authorization

bearerAuth

AuthorizationBearer <token>

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

In: header

Path Parameters

customerId*string

The Customer identifier. Note: For API Resellers, performing actions on behalf of your customers, you need to specify the Subaccount customer identifier you're operating on behalf of.

Header Parameters

X-Request-Id?string

A client provided identifier for tracking this request.

Request Body

application/json

An instance document expected to match the JSON schema returned by ./schema/{tld}

domain*string

For internationalized domain names with non-ascii characters, the domain name is converted to punycode before format and pattern validation rules are checked

Match^[^.]{1,63}.[^.]{2,}$

Formatdomain

consent*

period?integer

Match^[0-9]+$

Formatinteger-positive

Range1 <= value <= 10

Default1

nameServers?array<>

Itemsitems <= 2

renewAuto?boolean

Defaulttrue

privacy?boolean

Defaultfalse

contacts?

metadata?

The domain eligibility data fields as specified by GET /v2/customers/{customerId}/domains/register/schema/{tld}

Response Body

`application/json`

curl -X POST "https://example.com/v2/customers/string/domains/register/validate" \  -H "Content-Type: application/json" \  -d '{    "domain": "string",    "consent": {      "agreementKeys": [        "string"      ],      "price": 0,      "currency": "USD",      "agreedBy": "string",      "agreedAt": "string"    }  }'

Empty

Agent & Automation Notes

Scopes

domains.domain:read, domains.domain:create, domains.domain:update, domains.contact:update, domains.nameserver:update, domains.transfer:execute, domains.transfer:update, domains.forward:update

Rate limit60 req/min per credential

On failureAsync operations return 202 with an Action object. Poll until terminal state. Do not resubmit transfers.

Guides

Concepts

Last updated on

Register Domains

202

400application/json

401application/json

403application/json

409application/json

422application/json

429application/json

500application/json

200application/json

401application/json

403application/json

404application/json

422application/json

429application/json

500application/json

204

400application/json

401application/json

403application/json

404application/json

422application/json

429application/json

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