Support

Check availability of one or more specific domains

View as Markdown

Batch availability check for 1-25 domains.

Full description

Batch availability check for 1-25 domains. Returns one availability result per domain in input order. Domains that cannot be checked carry an error object on that item; the overall request still returns 200. Results are indicative; the authoritative check runs at quote time.

POST
/check-availability

Authorization

bearerAuth
AuthorizationBearer <token>

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

In: header

Header Parameters

X-Request-Id?string

Optional client-generated request correlation identifier, propagated across services and returned in the response X-Request-Id header.

Formatuuid

Request Body

application/json

Request body for the POST /check-availability controller. Specifies the domain names to check and optional parameters that influence how the check is performed. The response returns one Availability result per requested domain in input order. This controller does not persist the check; there is no check identity or poll URL.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/check-availability" \  -H "Content-Type: application/json" \  -d '{    "domains": [      "example.com",      "example.net"    ]  }'
{  "items": [    {      "domain": "example.com",      "available": true,      "definitive": false,      "inventory": "REGISTRY",      "prices": [        {          "term": "YEAR",          "period": 1,          "price": {            "currencyCode": "USD",            "value": 1999          },          "renewalPrice": {            "currencyCode": "USD",            "value": 1999          }        },        {          "term": "YEAR",          "period": 2,          "price": {            "currencyCode": "USD",            "value": 3098          },          "renewalPrice": {            "currencyCode": "USD",            "value": 4598          },          "firstTermPrice": {            "currencyCode": "USD",            "value": 799          }        },        {          "term": "YEAR",          "period": 3,          "price": {            "currencyCode": "USD",            "value": 4599          },          "renewalPrice": {            "currencyCode": "USD",            "value": 6897          },          "firstTermPrice": {            "currencyCode": "USD",            "value": 499          },          "recommended": true        }      ]    },    {      "domain": "invalid..com",      "error": {        "name": "MISMATCH_FORMAT",        "correlationId": "9f1c2e7a-4b3d-4e8f-a1c2-3d4e5f6a7b8c",        "message": "does not conform to the 'domain' format, based on pattern: /^[^.\\s]{1,63}(\\.[^.\\s]{1,63}){1,2}$/"      }    }  ]}

Agent & Automation Notes

Scopesdomains.domain:read, domains.domain:create, domains.dns:update, domains.nameserver:update
Rate limit60 req/min per credential
On failureGET operations are safe to retry. POST registrations use Idempotency-Key. Poll async operations — do not resubmit.

Last updated on

How is this guide?