Skip to main content
POST
Start project-scoped Cloudflare DNS authorization

Authorizations

Authorization
string
header
required

WorkOS access JWT or a user-owned WorkOS API key. User keys are bound to one organization and restricted to their enabled product permissions. Session-only onboarding and session revocation require an interactive access JWT. No cookie session is assumed.

Headers

X-Request-Id
string

Optional caller-provided correlation identifier.

Required string length: 1 - 128
Idempotency-Key
string
required

Identifies one mutation and its canonical request payload.

Required string length: 1 - 128

Path Parameters

project_id
string
required

Project identifier.

Pattern: ^[0-9A-HJKMNP-TV-Z]{26}$

Body

application/json
zone
string
required
Required string length: 4 - 253
Pattern: ^(?=.{1,253}$)(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\.)+[a-z]{2,63}$

Response

A short-lived Cloudflare authorization URL.

Short-lived credential-free redirect information for one Cloudflare OAuth authorization.

authorization_id
string
required
Pattern: ^[0-9A-HJKMNP-TV-Z]{26}$
authorization_url
string<uri>
required
Required string length: 20 - 4096
Pattern: ^https://dash\.cloudflare\.com/oauth2/auth\?
expires_at
string<date-time>
required