API REFERENCE

Cloudflare · connect

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": "cloudflare.connect", "payload": {"ip": "YOUR_PUBLIC_SERVER_IP"}}'

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

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: setup and status

Connect requires Prime for a new connection. Existing connections remain editable after Prime expires. Connection creates the zone, sets up DNS and HTTPS, and changes nameservers. Use a public server IP you control; omit ip if you do not want an initial A record. Certificate issuance and delegation are asynchronous.

Poll GET /operations/{id} for completion. Read GET /domains/{id}: cloudflare.status is the zone state, ssl_status is the visitor certificate, origin_tls_status is origin HTTPS, and checked_at is the last verification. An accepted request is not proof that SSL is active.

cloudflare.proxy changes proxying for eligible DNS records. cloudflare.purge clears the zone cache. These actions do not register or renew a domain and do not guarantee protection against every complaint or attack.

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.