Download OpenAPI specification:
Register/Update/Renew Domain Names
{- "name": "John Doe",
- "organization": "Example Inc.",
- "balance": -1000,
- "domains": {
- "total": 10,
- "expireSoon": 0,
- "pendingTransferAway": 0,
- "pendingTransferIncoming": 0,
- "disputed": 0,
- "requireEmailVerification": 2,
- "suspended": 0,
- "redemption": 0
}
}[- {
- "com": {
- "minPeriod": 1,
- "maxPeriod": 10,
- "registrationPrice": 9.99,
- "renewalPrice": 9.99,
- "transferPrice": 9.99,
- "redemptionFee": 50,
- "transferEppAuthCodeRequred": true,
- "currency": "USD"
}
}, - {
- "net": {
- "minPeriod": 1,
- "maxPeriod": 10,
- "registrationPrice": 9.99,
- "renewalPrice": 9.99,
- "transferPrice": 9.99,
- "redemptionFee": 50,
- "transferEppAuthCodeRequred": true,
- "currency": "USD"
}
}
]Get a list of domains on the account
| offset | integer Default: 0 Example: offset=50 The offset number to retrieve. |
| limit | integer <= 500 Default: 50 Example: limit=250 The number of domain results per query. |
| includeHostServers | boolean Default: false Include host servers in the response |
| includeNameServers | boolean Default: false Include name servers in the response |
| pendingEmailVerification | boolean Default: false Only return domains that are pending email verification |
| pendingTransferAway | boolean Default: false Only return domains that are pending transfer away |
[- {
- "domainName": "example.com",
- "created": "2026-01-05",
- "updated": "2026-04-09",
- "suspended": null,
- "expires": "2027-01-04",
- "deactivated": null,
- "lock": true,
- "transfer": [ ]
}, - {
- "domainName": "example.net",
- "created": "2026-02-28",
- "updated": "2026-04-10",
- "suspended": null,
- "expires": "2027-02-27",
- "deactivated": null,
- "lock": false,
- "transfer": {
- "status": "pendingTransfer",
- "date": "2026-04-10",
- "reason": ""
}
}, - {
- "domainName": "example.org",
- "created": "2024-03-15",
- "updated": "2026-04-11",
- "suspended": null,
- "expires": "2026-03-14",
- "deactivated": "2026-04-14",
- "restoreUntil": "2026-05-14",
- "lock": true,
- "transfer": [ ]
}
]Search domain availability for one or more domain names.
| domains | Array of strings (DomainName) |
| premiumDomains | boolean Enable support for premium priced domain names |
| feeType | string (FeeType) Enum: "create" "renew" "transfer" "restore" |
{- "domains": [
- {
- "domainName": "example.com",
- "available": true,
- "reserved": false,
- "error": null,
- "premium": false,
- "fee": 9.99,
- "feeCategory": null
}, - {
- "domainName": "example.net",
- "available": false,
- "reserved": false,
- "error": null,
- "premium": false,
- "fee": null,
- "feeCategory": null
}, - {
- "domainName": "example.org",
- "available": false,
- "reserved": false,
- "error": "Registry backend failure, please try again",
- "premium": false,
- "fee": null,
- "feeCategory": null
}
]
}{- "domains": {
- "domainName": "example.com",
- "available": true,
- "reserved": true,
- "error": "string",
- "premium": true,
- "fee": null,
- "feeType": "create",
- "feeCategory": "string"
}
}Register a new domain name
| domainName required | string (DomainName) Example: example.com Domain Name |
| years required | integer (Years) [ 1 .. 10 ] Number of years to register the domain for |
| nameServers | Array of strings (NameServer) |
required | object (RegistrantContact) Contact details for the registrant |
| redactRegistrantDetails | boolean Default: true Redact contact details from public view |
| autoRenew | boolean Default: false |
| idnLanguage | string |
{- "domainName": "example.com",
- "years": 1,
- "nameServers": [
- "ns1.example.com",
- "ns2.example.net"
], - "registrantContact": {
- "name": "John Doe",
- "email": "user@example.com",
- "phone": "+1.234-567-8910"
}
}{- "domainNameRegistrationId": "3be6453c-03eb-4357-ae5a-984a0e574a54",
- "created": "2025-01-02 03:04:05 GMT",
- "expires": "2026-01-02 03:04:05 GMT",
- "nameServers": [
- "ns1.example.com",
- "ns2.example.net"
], - "registrantContact": {
- "name": "John Doe",
- "email": "user@example.com",
- "phone": "+1.234-567-8910"
}
}Update values on a domain registration
| domainName required | string (DomainName) Example: example.com Domain Name |
| hold | boolean Apply the clientHold flag to the domain, removing it from being published in the root name servers. |
| locked | boolean Apply the clientTransferProhibited flag to the domain, preventing domain registrar transfer requests. |
| autoRenew | boolean |
| nameServers | Array of strings (NameServer) |
Array of objects (dnssec) DNSSEC keys. Send an Empty array to delete existing keys | |
object (RegistrantContact) Contact details for the registrant | |
| redactRegistrantDetails | boolean Redact contact details from public view |
{- "domainName": "example.com",
- "years": 1,
- "nameServers": [
- "ns1.example.com",
- "ns2.example.net"
], - "registrantContact": {
- "name": "John Doe",
- "email": "user@example.com",
- "phone": "+1.234-567-8910"
}
}{- "domainNameRegistrationId": "3be6453c-03eb-4357-ae5a-984a0e574a54",
- "created": "2025-01-02 03:04:05 GMT",
- "expires": "2026-01-02 03:04:05 GMT",
- "nameServers": [
- "ns1.example.com",
- "ns2.example.net"
], - "registrantContact": {
- "name": "John Doe",
- "email": "user@example.com",
- "phone": "+1.234-567-8910"
}
}Get availability and fee of a domain name
| domainName required | string (DomainName) Example: example.com Domain Name |
| feeType | string (FeeType) Enum: "create" "renew" "transfer" "restore" The fee type to retrieve. |
{- "domainName": "example.com",
- "available": true,
- "reserved": true,
- "error": "string",
- "premium": true,
- "fee": null,
- "feeType": "create",
- "feeCategory": "string"
}Get the details of an existing domain name registration
| domainName required | string (DomainName) Example: example.com Domain Name |
{- "domainNameRegistrationId": "a54a57ca-36f8-421b-a6b4-2e8f26858a4c",
- "created": "2023-10-29",
- "updated": "2023-10-29",
- "expires": "2023-10-29",
- "deactivated": "2023-10-29",
- "restoreUntil": "2023-10-29",
- "lock": true,
- "autoRenew": true,
- "nameServers": [
- "ns1.example.com"
], - "hostServers": [
- {
- "host": "string",
- "ipAddress": [
- "1.2.3.4"
]
}
], - "registrantContact": {
- "first_name": "John",
- "last_name": "Doe",
- "company_name": "Example, Inc",
- "street1": "123 Main St",
- "street2": "Suite 456",
- "street3": "string",
- "state": "string",
- "country_id": "US",
- "email_address": "user@example.com",
- "voice_number": "+1(234)-567-8910"
}, - "registrantEmailVerification": {
- "status": "verified",
- "date": "2023-10-29"
}, - "registrantRedacted": true,
- "transfer": {
- "date": "2023-10-29",
- "status": "pending",
- "reason": "string"
}, - "dnssec": [
- {
- "keyTag": 0,
- "algorithm": 3,
- "digestType": 1,
- "digest": "string"
}
]
}Renew a domain name registration
| domainName required | string (DomainName) Example: example.com Domain Name |
| years required | integer (Years) [ 1 .. 10 ] Whole number of years to register/renew |
| newExpiration required | string <date> (Date) |
| amount required | number <float> (Amount) Transaction Amount |
{- "years": 1,
- "newExpiration": "2026-12-13",
- "amount": 43.21
}{- "expires": "2026-12-13",
- "amount": 43.21
}Transfer a domain name
| domainName required | string (DomainName) Example: example.com Domain Name |
| nameServers required | Array of strings (NameServer) |
required | object (RegistrantContact) Contact details for the registrant |
| autoRenew | boolean Default: false |
| idnLanguage | string |
| authCode required | string |
{- "domainName": "example.com",
- "authCode": "abcd1234&*()",
- "nameServers": [
- "ns1.example.com",
- "ns2.example.net"
], - "registrantContact": {
- "name": "John Doe",
- "email": "user@example.com",
- "phone": "+1.234-567-8910"
}
}{- "lang": "en-US",
- "errorCode": 0,
- "title": "string",
- "description": [
- "string"
]
}Update the transfer of a domain to rerequest at the registry and/or update authorization code
| domainName required | string (DomainName) Example: example.com Domain Name |
| authCode | string |
{- "authCode": "1234zyx##"
}{- "lang": "en-US",
- "errorCode": 0,
- "title": "string",
- "description": [
- "string"
]
}Send the Verification email to the registrant contact
| domainName required | string (DomainName) Example: example.com Domain Name |
{- "lang": "en-US",
- "errorCode": 0,
- "title": "string",
- "description": [
- "string"
]
}Check the Auth code for a Domain
| domainName required | string (DomainName) Example: example.com Domain Name |
| authCode | string |
{- "authCode": "string"
}{- "lang": "en-US",
- "errorCode": 0,
- "title": "string",
- "description": [
- "string"
]
}Approve the transfer of a domain name away from the current owner
| domainName required | string (DomainName) Example: example.com Domain Name |
{- "lang": "en-US",
- "errorCode": 0,
- "title": "string",
- "description": [
- "string"
]
}Reject the transfer of a domain name away from the current owner
| domainName required | string (DomainName) Example: example.com Domain Name |
{- "lang": "en-US",
- "errorCode": 0,
- "title": "string",
- "description": [
- "string"
]
}Replace all DNS records on the Domain
| domainName required | string (DomainName) Example: example.com Domain Name |
| name | string | ||||||||||||||||||||||||||||||||||||||
| type | string
| ||||||||||||||||||||||||||||||||||||||
| ttl | integer | ||||||||||||||||||||||||||||||||||||||
| records | Array of strings One or more records for this hostname + type combination. |
[- {
- "name": "string",
- "type": "A",
- "ttl": 0,
- "records": [
- "string"
]
}
]{- "lang": "en-US",
- "errorCode": 0,
- "title": "string",
- "description": [
- "string"
]
}