Registrations

Create Registration

POST/accounts/{account_id}/registrar-sandbox/registrations

List Registrations

GET/accounts/{account_id}/registrar-sandbox/registrations

Get Registration

GET/accounts/{account_id}/registrar-sandbox/registrations/{domain_name}

Update Registration

PATCH/accounts/{account_id}/registrar-sandbox/registrations/{domain_name}

ModelsExpand Collapse

RegistrationCreateResponse object { completed, created_at, links, 4 more }

Status of an async registration workflow.

completed: boolean

Indicates whether the workflow reached a terminal state. A succeeded or failed state returns true; pending, in_progress, action_required, and blocked return false.

created_at: string

formatdate-time

links: object { self, resource }

self: string

URL to this status resource.

resource: optional string

URL to the domain resource.

state: "pending" or "in_progress" or "action_required" or 3 more

Describes the workflow lifecycle state.

pending: The workflow awaits processing.
in_progress: Processing started. Continue polling links.self. An internal deadline limits the duration of this state.
action_required: The workflow pauses for user action. See context.action for details. Stop automated polling until the user completes the required action.
blocked: A third party, such as the domain extension’s registry or a losing registrar, prevents progress. Continue polling because the block may resolve when the third party responds.
succeeded: Terminal state. The operation completed successfully. completed equals true. For registrations, context.registration contains the resulting registration resource.
failed: Terminal state. The operation failed. completed equals true. See error.code and error.message for the reason. Require user review before retrying.

One of the following:

"pending"

"in_progress"

"action_required"

"blocked"

"succeeded"

"failed"

updated_at: string

formatdate-time

context: optional map[unknown]

Provides workflow-specific data.

For domain-centric workflows, context.domain_name identifies the workflow subject.

error: optional object { code, message }

Provides error details when a workflow reaches the failed state. The workflow type (registration, update, etc.) and underlying registry response determine the specific codes and messages. Workflow error codes differ from immediate HTTP error errors[].code values in non-2xx responses. Surface error.message to the user for context.

code: string

Machine-readable error code identifying the failure reason.

message: string

Human-readable explanation of the failure. May include registry-specific details.

RegistrationListResponse object { auto_renew, created_at, domain_name, 4 more }

A domain registration resource representing the current state of a registered domain.

auto_renew: boolean

Whether automatic renewal occurs before expiration.

created_at: string

When the domain was registered. Present when the registration resource exists.

formatdate-time

domain_name: string

Provides a fully qualified domain name (FQDN), including the extension (e.g., example.com, mybrand.app). The domain name uniquely identifies a registration. Cloudflare permits only one registration per domain, making the domain name a natural idempotency key for registration requests.

expires_at: string

When the domain registration expires. Ready registrations include this value; only registration_pending may return null.

formatdate-time

locked: boolean

Whether the domain is locked for transfer.

privacy_mode: "off" or "redaction"

Current WHOIS privacy mode for the registration.

One of the following:

"off"

"redaction"

status: "active" or "registration_pending" or "expired" or 3 more

Current registration status.

active: The domain operates with an active registration.
registration_pending: Registration remains in progress.
expired: The domain registration expired.
suspended: The registry suspended the domain.
redemption_period: The domain entered the redemption grace period.
pending_delete: The registry scheduled the domain for deletion.

One of the following:

"active"

"registration_pending"

"expired"

"suspended"

"redemption_period"

"pending_delete"

RegistrationGetResponse object { auto_renew, created_at, domain_name, 4 more }

A domain registration resource representing the current state of a registered domain.

auto_renew: boolean

Whether automatic renewal occurs before expiration.

created_at: string

When the domain was registered. Present when the registration resource exists.

formatdate-time

domain_name: string

expires_at: string

When the domain registration expires. Ready registrations include this value; only registration_pending may return null.

formatdate-time

locked: boolean

Whether the domain is locked for transfer.

privacy_mode: "off" or "redaction"

Current WHOIS privacy mode for the registration.

One of the following:

"off"

"redaction"

status: "active" or "registration_pending" or "expired" or 3 more

Current registration status.

active: The domain operates with an active registration.
registration_pending: Registration remains in progress.
expired: The domain registration expired.
suspended: The registry suspended the domain.
redemption_period: The domain entered the redemption grace period.
pending_delete: The registry scheduled the domain for deletion.

One of the following:

"active"

"registration_pending"

"expired"

"suspended"

"redemption_period"

"pending_delete"

RegistrationEditResponse object { completed, created_at, links, 4 more }

Status of an async registration workflow.

completed: boolean

Indicates whether the workflow reached a terminal state. A succeeded or failed state returns true; pending, in_progress, action_required, and blocked return false.

created_at: string

formatdate-time

links: object { self, resource }

self: string

URL to this status resource.

resource: optional string

URL to the domain resource.

state: "pending" or "in_progress" or "action_required" or 3 more

Describes the workflow lifecycle state.

pending: The workflow awaits processing.
in_progress: Processing started. Continue polling links.self. An internal deadline limits the duration of this state.
action_required: The workflow pauses for user action. See context.action for details. Stop automated polling until the user completes the required action.
blocked: A third party, such as the domain extension’s registry or a losing registrar, prevents progress. Continue polling because the block may resolve when the third party responds.
succeeded: Terminal state. The operation completed successfully. completed equals true. For registrations, context.registration contains the resulting registration resource.
failed: Terminal state. The operation failed. completed equals true. See error.code and error.message for the reason. Require user review before retrying.

One of the following:

"pending"

"in_progress"

"action_required"

"blocked"

"succeeded"

"failed"

updated_at: string

formatdate-time

context: optional map[unknown]

Provides workflow-specific data.

For domain-centric workflows, context.domain_name identifies the workflow subject.

error: optional object { code, message }

code: string

Machine-readable error code identifying the failure reason.

message: string

Human-readable explanation of the failure. May include registry-specific details.