API REFERENCE

Get domain, delegation and Cloudflare state

GET/api/v1/domains/{id}

Operates on your account only. Send your API key in the Authorization header. Responses use JSON.

Request

Set BASE_URL to this website’s HTTPS origin and API_KEY to your private key. Replace RESOURCE_ID with the ID returned by the API.

cURL

curl --request GET "${BASE_URL}/api/v1/domains/RESOURCE_ID" \
  --header "Authorization: Bearer $API_KEY"

Headers & parameters

Authorizationrequired

Bearer YOUR_API_KEY

idpath · stringrequired

Numeric domain ID; UUID for an order, operation or request.

Response

202 means accepted, not completed. Poll the order or operation. If the outcome is unknown, do not issue another purchase. Amounts are decimal strings in USD; dates use ISO 8601.

request_idstringrequired

Identifier used to recover an outcome after a network failure.

idintegerrequired

namestringrequired

@ for the apex, * for wildcard, or a record name.

categorystring

Pricing category: basic or protected.

expires_atstring | null

autorenewboolean

archivedboolean

nameserversarray

Nameserver hostnames, not IP addresses.

dns_backendstring

delegationstring

renewal_periodsarray

cloudflareobjectrequired

cloudflare.connectedboolean

cloudflare.statusstring

Current state. An accepted job does not mean completion.

cloudflare.ssl_statusstring

Cloudflare visitor-facing certificate state.

cloudflare.origin_tls_statusstring

Separate HTTPS state between Cloudflare and the origin server.

cloudflare.nameserversarray

Nameserver hostnames, not IP addresses.

cloudflare.checked_atstring | null

cloudflare.settingsobject

cloudflare.geo_countriesarray

cloudflare.available_settingsobject

Response structure example · illustrative values

JSON

{
  "request_id": "00000000-0000-4000-8000-000000000001",
  "id": 1,
  "name": "example.com",
  "category": "string",
  "expires_at": "2026-10-02T12:00:00Z",
  "autorenew": false,
  "archived": false,
  "nameservers": [
    "string"
  ],
  "dns_backend": "string",
  "delegation": "string",
  "renewal_periods": [
    1
  ],
  "cloudflare": {
    "connected": false,
    "status": "string",
    "ssl_status": "string",
    "origin_tls_status": "string",
    "nameservers": [
      "string"
    ],
    "checked_at": "2026-10-02T12:00:00Z",
    "settings": {},
    "geo_countries": [
      "string"
    ],
    "available_settings": {}
  }
}

Errors & statuses

error.code · error.message · request_id

401

Invalid or revoked key.

404

Resource not found in your account.

409

Idempotency conflict or request in progress.

422

Invalid parameters or business rule, including balance.

500

Outcome may be uncertain. Poll the request.

503

Temporarily unavailable. Respect Retry-After.