Manage Domain Settings

Retrieve domain details and manage contacts, nameservers, forwarding rules, privacy forwarding, renewals, and redemption.

Retrieve change of registrant information

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.

domain*string

Domain whose change of registrant information is to 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/string/changeOfRegistrant"

{  "createDate": "string",  "gainingContact": {    "email": "user@example.com",    "firstName": "string",    "lastName": "string",    "organization": "string"  },  "losingContact": {    "email": "user@example.com",    "firstName": "string",    "lastName": "string",    "organization": "string"  },  "otherDomainsAffected": 0,  "shopperEmail": "user@example.com"}

Cancel a pending change of registrant request

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.

domain*string

Domain whose change of registrant is to be cancelled

Header Parameters

X-Request-Id?string

A client provided identifier for tracking this request.

Response Body

`/`

curl -X DELETE "https://example.com/v2/customers/string/domains/string/changeOfRegistrant"

Empty

Replaces the existing name servers on the 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.

domain*string

Domain whose name servers are to be replaced

Header Parameters

X-Request-Id?string

A client provided identifier for tracking this request.

Request Body

application/json

Name server records to replace on the domain

nameServers?array<string>

Fully-qualified domain names for name servers to associate with the domain

Response Body

`application/json`

curl -X PUT "https://example.com/v2/customers/string/domains/string/nameServers" \  -H "Content-Type: application/json" \  -d '{}'

Empty

Retrieve details for 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.

domain*string

Domain name whose details are to be retrieved

Query Parameters

includes?array<>

Optional details to be included in the response

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/string"

{  "domainId": "string",  "domain": "string",  "subaccountId": "string",  "status": "ACTIVE",  "expiresAt": "string",  "expirationProtected": true,  "holdRegistrar": true,  "locked": true,  "privacy": true,  "registrarCreatedAt": "string",  "renewAuto": true,  "renewDeadline": "string",  "transferProtected": true,  "createdAt": "string",  "deletedAt": "string",  "modifiedAt": "string",  "transferAwayEligibleAt": "string",  "authCode": "string",  "nameServers": [    "string"  ],  "hostnames": [    "string"  ],  "renewal": {    "renewable": true,    "price": 0,    "currency": "USD"  },  "verifications": {    "icann": "COMPLETED",    "realName": "APPROVED",    "domainName": "APPROVED"  },  "contacts": {    "registrant": {      "contactId": "string",      "encoding": "ASCII",      "nameFirst": "string",      "nameMiddle": "string",      "nameLast": "string",      "organization": "string",      "jobTitle": "string",      "email": "user@example.com",      "phone": "string",      "fax": "string",      "addressMailing": {        "address1": "string",        "address2": "string",        "city": "string",        "country": "AC",        "postalCode": "string",        "state": "string"      },      "exposeRegistrantOrganization": true,      "exposeWhois": true,      "metadata": {},      "tlds": [        "string"      ],      "_createdAt": "string",      "_modifiedAt": "string",      "_deleted": true,      "_revision": 0    },    "admin": {      "contactId": "string",      "encoding": "ASCII",      "nameFirst": "string",      "nameMiddle": "string",      "nameLast": "string",      "organization": "string",      "jobTitle": "string",      "email": "user@example.com",      "phone": "string",      "fax": "string",      "addressMailing": {        "address1": "string",        "address2": "string",        "city": "string",        "country": "AC",        "postalCode": "string",        "state": "string"      },      "exposeRegistrantOrganization": true,      "exposeWhois": true,      "metadata": {},      "tlds": [        "string"      ],      "_createdAt": "string",      "_modifiedAt": "string",      "_deleted": true,      "_revision": 0    },    "tech": {      "contactId": "string",      "encoding": "ASCII",      "nameFirst": "string",      "nameMiddle": "string",      "nameLast": "string",      "organization": "string",      "jobTitle": "string",      "email": "user@example.com",      "phone": "string",      "fax": "string",      "addressMailing": {        "address1": "string",        "address2": "string",        "city": "string",        "country": "AC",        "postalCode": "string",        "state": "string"      },      "exposeRegistrantOrganization": true,      "exposeWhois": true,      "metadata": {},      "tlds": [        "string"      ],      "_createdAt": "string",      "_modifiedAt": "string",      "_deleted": true,      "_revision": 0    },    "billing": {      "contactId": "string",      "encoding": "ASCII",      "nameFirst": "string",      "nameMiddle": "string",      "nameLast": "string",      "organization": "string",      "jobTitle": "string",      "email": "user@example.com",      "phone": "string",      "fax": "string",      "addressMailing": {        "address1": "string",        "address2": "string",        "city": "string",        "country": "AC",        "postalCode": "string",        "state": "string"      },      "exposeRegistrantOrganization": true,      "exposeWhois": true,      "metadata": {},      "tlds": [        "string"      ],      "_createdAt": "string",      "_modifiedAt": "string",      "_deleted": true,      "_revision": 0    }  },  "actions": [    {      "type": "AUTH_CODE_PURCHASE",      "origination": "USER",      "createdAt": "string",      "startedAt": "string",      "completedAt": "string",      "modifiedAt": "string",      "status": "ACCEPTED",      "reason": {        "code": "string",        "message": "string",        "fields": [          {            "code": "string",            "message": "string",            "path": "string",            "pathRelated": "string"          }        ]      },      "requestId": "string"    }  ],  "dnssecRecords": [    {      "algorithm": "RSAMD5",      "keyTag": 65536,      "digestType": "SHA1",      "digest": "string",      "flags": "ZSK",      "publicKey": "string",      "maxSignatureLife": 0    }  ],  "registryStatusCodes": [    "ADD_PERIOD"  ]}

Retrieve privacy email forwarding settings showing where emails are delivered

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.

domain*string

Domain name whose details are to 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/string/privacy/forwarding"

{  "privateEmail": "string",  "forwardingEmail": "string",  "emailPreference": "EMAIL_FILTER"}

Update privacy email forwarding settings to determine how emails are delivered

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.

domain*string

Domain name whose details are to be retrieved

Header Parameters

X-Request-Id?string

A client provided identifier for tracking this request.

Request Body

application/json

Update privacy email forwarding settings

privateEmailType*string

The private email type

DEFAULT — Use default email address (example: domainname.com@domainsbyproxy.com)
RANDOM — Randomize email address, we’ll create a private email address using random characters to further protect you from unwanted spam. (5f9e6c9368a64565bf2@domainsbyproxy.com)

Value in

"DEFAULT"
"RANDOM"

forwardingEmail?string

The email that it forwards to

emailPreference*string

The email forwarding preference for the domain

EMAIL_FILTER — Filter for spam and forward email.
EMAIL_SEND_ALL — Forward all email.
EMAIL_SEND_NONE — Don't forward email.

Value in

"EMAIL_FILTER"
"EMAIL_SEND_ALL"
"EMAIL_SEND_NONE"

Response Body

`application/json`

curl -X PATCH "https://example.com/v2/customers/string/domains/string/privacy/forwarding" \  -H "Content-Type: application/json" \  -d '{    "privateEmailType": "DEFAULT",    "emailPreference": "EMAIL_FILTER"  }'

Empty

Retrieve the forwarding information for the given fqdn

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.

fqdn*string

The fully qualified domain name whose forwarding details are to be retrieved.

Query Parameters

includeSubs?boolean

Optionally include all sub domains if the fqdn specified is a domain and not a sub domain.

Response Body

`application/json`

curl -X GET "https://example.com/v2/customers/string/domains/forwards/string"

[  {    "fqdn": "string",    "type": "MASKED",    "url": "string",    "mask": {      "title": "string",      "description": "string",      "keywords": "string"    }  }]

Create a new forwarding configuration for the given FQDN

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 you're operating on behalf of; otherwise use your own customer id.

fqdn*string

The fully qualified domain name whose forwarding details are to be modified.

Request Body

application/json

Domain forwarding rule to create for the specified fqdn

type*string

The type of forwarding to implement

MASKED — Prevents the forwarded domain or subdomain URL from displaying in the browser's address bar.
REDIRECT_PERMANENT (default) — Redirects to the url specified in the forwardTo field using a 301 Moved Permanently HTTP response. Tells user-agents (including search engines) that the location has permanently moved.
REDIRECT_TEMPORARY — Redirects to the url specified in the forwardTo field using a 302 Found HTTP response. Tells user-agents (including search engines) that the location has temporarily moved.

Default"REDIRECT_PERMANENT"

Value in

"MASKED"
"REDIRECT_PERMANENT"
"REDIRECT_TEMPORARY"

url*string

Forwards http(s) traffic to this destination url (ex. http://www.somedomain.com/)

Formaturl

mask?

Response Body

`application/json`

curl -X POST "https://example.com/v2/customers/string/domains/forwards/string" \  -H "Content-Type: application/json" \  -d '{    "type": "MASKED",    "url": "string"  }'

Empty

Submit a forwarding cancellation request for the given fqdn

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.

fqdn*string

The fully qualified domain name whose forwarding details are to be deleted.

Response Body

`application/json`

curl -X DELETE "https://example.com/v2/customers/string/domains/forwards/string"

Empty

Modify the forwarding information for the given fqdn

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.

fqdn*string

The fully qualified domain name whose forwarding details are to be modified.

Request Body

application/json

Domain forwarding rule to create or replace on the fqdn

type*string

The type of forwarding to implement

MASKED — Prevents the forwarded domain or subdomain URL from displaying in the browser's address bar.
REDIRECT_PERMANENT (default) — Redirects to the url specified in the forwardTo field using a 301 Moved Permanently HTTP response. Tells user-agents (including search engines) that the location has permanently moved.
REDIRECT_TEMPORARY — Redirects to the url specified in the forwardTo field using a 302 Found HTTP response. Tells user-agents (including search engines) that the location has temporarily moved.

Default"REDIRECT_PERMANENT"

Value in

"MASKED"
"REDIRECT_PERMANENT"
"REDIRECT_TEMPORARY"

url*string

Forwards http(s) traffic to this destination url (ex. http://www.somedomain.com/)

Formaturl

mask?

Response Body

`application/json`

curl -X PUT "https://example.com/v2/customers/string/domains/forwards/string" \  -H "Content-Type: application/json" \  -d '{    "type": "MASKED",    "url": "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

Manage Domain Settings

200application/json

401application/json

403application/json

404application/json

409application/json

422application/json

429application/json

500application/json

502application/json

202

401*/*

403*/*

404*/*

409*/*

422*/*

429*/*

500*/*

502*/*

202

400application/json

401application/json

403application/json

404application/json

409application/json

422application/json

429application/json

500application/json

200application/json

203application/json

401application/json

403application/json

404application/json

422application/json

429application/json

500application/json

200application/json

401application/json

403application/json

404application/json

422application/json

429application/json

500application/json

202

401application/json

403application/json

404application/json

409application/json

422application/json

429application/json

500application/json

200application/json

401application/json

403application/json

404application/json

422application/json

429application/json

500application/json

204

401application/json

403application/json

404application/json

409application/json

422application/json

429application/json

500application/json

204

401application/json

403application/json

404application/json

409application/json

422application/json

429application/json

500application/json

204

401application/json

403application/json

404application/json

409application/json

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

`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`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`