API REFERENCE

Queue validated DNS/NS/Cloudflare/redirect/glue operation

POST/api/v1/domains/{id}/operations

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 POST "${BASE_URL}/api/v1/domains/RESOURCE_ID/operations" \
  --header "Authorization: Bearer $API_KEY" \
  --header "Content-Type: application/json" \
  --header "Idempotency-Key: YOUR_UNIQUE_ACTION_UUID" \
  --data '{"kind": "dns.sync", "payload": {}}'

Headers & parameters

Authorizationrequired

Bearer YOUR_API_KEY

idpath · stringrequired

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

Idempotency-Keyheader · stringrequired

Unique action identifier. Reuse the same value and JSON on retries.

JSON body

Choose one operation. Each variant shows its own fields. Queueing does not mean the provider has applied the change.

dns.add

kindstringrequired

Action type; choose the appropriate variant below.

const: "dns.add"

payloadobjectrequired

Parameters for the selected action.

payload.record_typestringrequired

DNS record type, such as A, AAAA, CNAME, TXT, MX or SRV.

payload.namestringrequired

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

payload.contentstringrequired

Record value matching its type.

payload.ttlinteger

DNS cache lifetime in seconds; 1 means automatic.

payload.priorityinteger

MX priority: lower values are preferred.

payload.proxiedboolean

Proxy a compatible record through Cloudflare.

payload.commentstring

Record note; not published in DNS.

dns.update

kindstringrequired

Action type; choose the appropriate variant below.

const: "dns.update"

payloadobjectrequired

Parameters for the selected action.

payload.record_idintegerrequired

Record ID from GET /domains/{id}/dns.

payload.record_typestringrequired

DNS record type, such as A, AAAA, CNAME, TXT, MX or SRV.

payload.namestringrequired

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

payload.contentstringrequired

Record value matching its type.

payload.ttlinteger

DNS cache lifetime in seconds; 1 means automatic.

payload.priorityinteger

MX priority: lower values are preferred.

payload.proxiedboolean

Proxy a compatible record through Cloudflare.

payload.commentstring

Record note; not published in DNS.

dns.delete

kindstringrequired

Action type; choose the appropriate variant below.

const: "dns.delete"

payloadobjectrequired

Parameters for the selected action.

payload.record_idintegerrequired

Record ID from GET /domains/{id}/dns.

dns.sync

kindstringrequired

Action type; choose the appropriate variant below.

const: "dns.sync"

payloadobjectrequired

Parameters for the selected action.

dns.rrset

kindstringrequired

Action type; choose the appropriate variant below.

const: "dns.rrset"

payloadobjectrequired

Parameters for the selected action.

payload.record_typestringrequired

DNS record type, such as A, AAAA, CNAME, TXT, MX or SRV.

payload.namestringrequired

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

payload.valuesarrayrequired

Complete replacement values for this name and type. An empty array deletes the set.

maxItems: 50

payload.values[].contentstringrequired

Record value matching its type.

payload.values[].ttlinteger

DNS cache lifetime in seconds; 1 means automatic.

payload.values[].priorityinteger

MX priority: lower values are preferred.

payload.values[].proxiedboolean

Proxy a compatible record through Cloudflare.

payload.values[].commentstring

Record note; not published in DNS.

payload.expectedstringrequired

Current RRset signature from GET DNS. Prevents overwriting concurrent changes.

ns.set

kindstringrequired

Action type; choose the appropriate variant below.

const: "ns.set"

payloadobjectrequired

Parameters for the selected action.

payload.nameserversarrayrequired

Nameserver hostnames, not IP addresses.

minItems: 2 · maxItems: 20

native.configure

kindstringrequired

Action type; choose the appropriate variant below.

const: "native.configure"

payloadobjectrequired

Parameters for the selected action.

cloudflare.connect

kindstringrequired

Action type; choose the appropriate variant below.

const: "cloudflare.connect"

payloadobjectrequired

Parameters for the selected action.

payload.ipstring

Your server’s public IPv4 address.

cloudflare.setting

kindstringrequired

Action type; choose the appropriate variant below.

const: "cloudflare.setting"

payloadobjectrequired

Parameters for the selected action.

payload.settingstringrequired

Setting name from cloudflare.available_settings on the domain.

payload.valueobjectrequired

Allowed value for the selected setting from available_settings.

payload.countriesarray

GEO only: ISO 3166-1 alpha-2 country codes, e.g. ["US", "DE"]. Omit to reuse the domain’s saved list.

maxItems: 249

cloudflare.proxy

kindstringrequired

Action type; choose the appropriate variant below.

const: "cloudflare.proxy"

payloadobjectrequired

Parameters for the selected action.

payload.enabledbooleanrequired

Enable or disable the selected feature.

cloudflare.purge

kindstringrequired

Action type; choose the appropriate variant below.

const: "cloudflare.purge"

payloadobjectrequired

Parameters for the selected action.

glue.save

kindstringrequired

Action type; choose the appropriate variant below.

const: "glue.save"

payloadobjectrequired

Parameters for the selected action.

payload.namestringrequired

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

payload.ipstring

Your server’s public IPv4 address.

payload.ip6string

Your server’s public IPv6 address.

glue.delete

kindstringrequired

Action type; choose the appropriate variant below.

const: "glue.delete"

payloadobjectrequired

Parameters for the selected action.

payload.namestringrequired

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

glue.sync

kindstringrequired

Action type; choose the appropriate variant below.

const: "glue.sync"

payloadobjectrequired

Parameters for the selected action.

redirect.save

kindstringrequired

Action type; choose the appropriate variant below.

const: "redirect.save"

payloadobjectrequired

Parameters for the selected action.

payload.slugstringrequired

Redirect identifier used to create or update it.

payload.targetstringrequired

Destination HTTP(S) URL.

payload.status_codeinteger

HTTP status: 301/308 permanent, 302/307 temporary. 307/308 preserve the HTTP method.

payload.preserve_queryboolean

Preserve query parameters in the destination URL.

payload.enabledboolean

Enable or disable the selected feature.

payload.source_patternstring

Source URL pattern for the redirect.

redirect.delete

kindstringrequired

Action type; choose the appropriate variant below.

const: "redirect.delete"

payloadobjectrequired

Parameters for the selected action.

payload.redirect_idintegerrequired

ID from GET /domains/{id}/redirects.

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.

idstringrequired

domain_idinteger

kindstring

Action type; choose the appropriate variant below.

statusstringrequired

Current state. An accepted job does not mean completion.

created_atstring | null

needs_reviewbooleanrequired

An uncertain outcome requires reconciliation, not a repeated operation.

messagestring | null

Response structure example · illustrative values

JSON

{
  "request_id": "00000000-0000-4000-8000-000000000001",
  "id": "00000000-0000-4000-8000-000000000001",
  "domain_id": 1,
  "kind": "string",
  "status": "string",
  "created_at": "2026-10-02T12:00:00Z",
  "needs_review": false,
  "message": "string"
}

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.