Skip to main content
POST
/
core
/
v1
/
zonecheck
Zone Check
curl --request POST \
  --url https://api.dev.name.com/core/v1/zonecheck \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "domainNames": [
    "<string>"
  ]
}
'
{
  "results": [
    {
      "domainName": "example.com",
      "available": true
    }
  ],
  "total": 5,
  "removed": 1
}

Documentation Index

Fetch the complete documentation index at: https://docs.name.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

Authenticate via HTTP Basic with your account username and API token. Examples use an explicit 'Authorization: Basic <base64(username:token)>' header; 'curl -u username:token' is equivalent. For sandbox, append "-test" to your username and use your sandbox token on api.dev.name.com.

Body

application/json

Request body to check for availability

ZoneCheck request checks DNS zone files for the availability of the specified domains.

domainNames
string[]
required

Array of domain names to check. Each entry is normalized and validated before zone check runs. Entries that are not valid domain strings, that use unsupported TLDs for this service, or that fail other pre-validation rules are omitted from the check; the response removed field reports how many were omitted (not which values).

Valid domain string (after normalization) — for reliable results and to avoid errors once all entries are removed:

  • Allowed characters: ASCII letters (az), digits (09), and hyphens (-).

  • Hyphen rules: A domain (the part between dots) must not start or end with a hyphen (for example, -test.com and test-.com are invalid).

  • Domain length: Each domain must be between 1 and 63 characters.

  • Internationalized domains (IDNs): Non-ASCII characters (for example ö or ñ) should be submitted as Punycode (xn--...) for consistent registry resolution.

Required array length: 1 - 500 elements
Minimum string length: 1
Examples:
["example.com", "example.net", "example.org"]
["test.net"]

Response

Successful response for a DNS zone check.

Response for checking domain availability via DNS zone checks.

results
object[]
required
total
number<int32>
required

Total number of records checked

Example:

5

removed
number<int32>

Number of domain strings removed during pre-validation (invalid format, unsupported TLD for this service, etc.). This is a count only; the response does not list which strings were removed.

Example:

1