Skip to main content
GET
Get project-scoped Cloudflare DNS authorization status

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

Path Parameters

project_id
string
required

Project identifier.

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

Response

The current credential-free Cloudflare DNS authorization status.

Credential-free project authorization state. Without an authorization, status is not_authorized, zone and expires_at are null, and scopes is empty. All other states name the actual customer zone; no platform or customer zone is inferred.

status
enum<string>
required
Available options:
not_authorized,
pending,
authorized,
expired,
revoked
zone
string | null
required
Required string length: 4 - 253
Pattern: ^(?=.{1,253}$)(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\.)+[a-z]{2,63}$
scopes
enum<string>[]
required
Maximum array length: 2
Available options:
dns.write,
zone.read
expires_at
string<date-time> | null
required