Skip to content

Re-check a hostname's DNS target

POST
/api/zones/{zoneId}/hostnames/{id}/dns-check

Triggers an immediate DNS verification of the hostname. Resets the check counter, updates "dnsTargetStatus" and "dnsObservedValue" from the live lookup, records the check time, and reschedules the next automatic check. Takes no request body and returns the updated hostname with HTTP 200.

The response also carries the DNS setup guidance the customer needs. "isApex" tells the two cases apart: when false (a subdomain such as www.example.com) the customer points a CNAME record named "recordName" (the label, e.g. "www") at "cnameTarget", and "aRecordTargets" is an empty array; when true (the apex/root, e.g. example.com) a CNAME cannot be used, so the customer instead creates A records at the apex ("recordName" is "@") pointing at every IP in "aRecordTargets" (the addresses "cnameTarget" currently resolves to, typically two; empty if it cannot be resolved).

Authorizations

ApiToken

Long-lived API token created via POST /api/api-tokens (returned once in plaintext). A token created with readOnly may only perform safe requests (GET, HEAD, OPTIONS); write requests are rejected on every endpoint.

Type
API Key (header: X-API-TOKEN)
or
JWT

JWT access token obtained via POST /api/auth/login. Send as: Authorization: Bearer .

Type
HTTP (bearer)

Parameters

Path Parameters

zoneId*

Zone identifier

Type
string
Required
id*

hostname identifier

Type
string
Required

Responses

hostname resource created

JSON
{
  
"@context": "string",
  
"@id": "string",
  
"@type": "string",
  
"id": "9f1b2c3d-4e5f-6789-abcd-ef0123456789",
  
"name": "www.example.com",
  
"cnameTarget": "string",
  
"cdnEnabled": false,
  
"dnsTargetStatus": "pending",
  
"dnsObservedValue": "string",
  
"dnsLastCheckedAt": "2026-07-01T12:00:00+00:00",
  
"createdAt": "2026-07-01T12:00:00+00:00",
  
"updatedAt": "2026-07-01T12:00:00+00:00",
  
"aRecordTargets": [
  
],
  
"isApex": false,
  
"recordName": "@"
}

Playground

Authorization
Variables
Key
Value

Samples

Powered by VitePress OpenAPI