--- title: Registrar Sandbox --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/typescript) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Registrar Sandbox Use the Registrar Sandbox API to test domain search, availability checks, registration, and domain management flows without buying real domains. **This API is a test environment for the production Registrar API.** ## Prerequisites Before using this API, make sure you have: 1. **Cloudflare account** — the caller must have a valid Cloudflare account. 2. **API authentication** — create an API token with Registrar Sandbox permissions. ## How the Sandbox API differs from the production Registrar API Because the Sandbox API is intended for testing, it behaves differently from the production Registrar API in a few important ways: 1. **No billing** — you will not be charged real money for purchasing a domain. 2. **No real domains** — purchased domains are test records and will not be reachable on the Internet. 3. **No DNS zones** — purchasing a domain does not create a zone resource. 4. **No Registration Express Mode** — you must provide full contact data. Sandbox purchases are still persisted. If you purchase a domain in the sandbox, that domain will not be available for others to purchase in the sandbox. ## Terminology: domain extension Throughout this API, “extension” refers to the domain extension part of a fully qualified domain name — the portion after the registrable label. For example, in `example.co.uk`, the extension is `co.uk` (not just `uk`). This covers both top-level domains like `com` and multi-level extensions like `co.uk`. This is distinct from other uses of the word “extension” (e.g., EPP extensions). ## Supported extensions The Sandbox API currently supports programmatic registration for these extensions: `com`, `net` The production Registrar API supports 40+ extensions. Cloudflare Registrar supports 400+ extensions in the dashboard. Extensions not listed above can be registered at `https://dash.cloudflare.com/{account_id}/domains/registrations`. ## Typical workflow 1. **Search** — call `GET /domain-search?q={keyword}` to discover available domains. 2. **Check** — call `POST /domain-check` with candidate domains to verify real-time availability and pricing. 3. **Review the response** — if `registrable: false`, inspect `reason` to understand whether the domain is unavailable, the extension is not supported by this API, the extension is not supported by Cloudflare Registrar at all, or the extension’s registry has frozen new registrations. 4. **Handle premium domains** — if `tier: premium`, premium registration is not currently supported by this API. The Sandbox API currently supports only `com` and `net`, which do not have premium registrations, but clients should still handle this response for consistency with the production Registrar API. Surface the premium pricing to the user, but do not proceed to `POST /registrations` for that domain. 5. **Observe the registration schema** — call `GET /extensions/:extension_name` to discover the required values for registering this extension. 6. **Register** — call `POST /registrations` with the chosen domain name for supported non-premium registrations. 7. **Confirm completion** — if the response is `201 Created`, registration completed within the default timeout and no polling is needed. 8. **Poll when needed** — if the response is `202 Accepted`, poll `links.self` from the workflow response. 9. **Stop for user action** — if `state: action_required`, stop polling and surface `context.action` to the user. The workflow will not resolve on its own. 10. **Continue when blocked** — if `state: blocked`, continue polling and inform the user that a third party, such as the extension registry or losing registrar, is delaying progress. 11. **Review failures before retrying** — if `state: failed`, review `error.code` and `error.message`, then decide whether user action or a new Check call is needed. ## Default behavior for mutating operations By default, mutating operations such as create and update hold the connection for a bounded, server-defined amount of time while the operation completes. In most cases, the response contains a completed workflow status and no polling is required. - **Completed within the synchronous wait window:** Returns `201` (create) or `200` (update) with a `workflow_status` where `state: succeeded` and `completed: true`. - **Still processing after the synchronous wait window:** Returns `202 Accepted` with a `workflow_status` where `completed: false`. Use the `links.self` URL to poll for completion. ## Non-blocking mode To receive an immediate `202 Accepted` response without waiting, send the `Prefer: respond-async` request header (RFC 7240). The server will acknowledge it with a `Preference-Applied: respond-async` response header. ## Polling When the response is `202`, poll the workflow status endpoint indicated by `links.self` in the response body until the workflow reaches a terminal state or requires user action. ##### [Search for available domains](https://developers.cloudflare.com/api/typescript/resources/registrar_sandbox/methods/search) client.registrarSandbox.search(RegistrarSandboxSearchParams {account\_id, q, extensions, limit } params, RequestOptionsoptions?): [RegistrarSandboxSearchResponse]() {domains } GET/accounts/{account\_id}/registrar-sandbox/domain-search ##### [Check domain availability](https://developers.cloudflare.com/api/typescript/resources/registrar_sandbox/methods/check) client.registrarSandbox.check(RegistrarSandboxCheckParams {account\_id, domains } params, RequestOptionsoptions?): [RegistrarSandboxCheckResponse]() {domains } POST/accounts/{account\_id}/registrar-sandbox/domain-check ##### ModelsExpand Collapse
Registration {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. Link to this property created\_at: string When the domain was registered. Present when the registration resource exists. formatdate-time Link to this property 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. Link to this property expires\_at: string| null When the domain registration expires. Ready registrations include this value; only registration_pending and transfer_pending may return null. formatdate-time Link to this property locked: boolean Whether the domain is locked for transfer. Link to this property
privacy\_mode: "off"| "redaction" Current WHOIS privacy mode for the registration. One of the following: "off" Link to this property "redaction" Link to this property
Link to this property
status: "active"| "registration\_pending"| "transfer\_pending"| 4 more Current registration status. - active: The domain operates with an active registration. - registration_pending: Registration remains in progress. - transfer_pending: Domain transfer is 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" Link to this property "registration\_pending" Link to this property "transfer\_pending" Link to this property "expired" Link to this property "suspended" Link to this property "redemption\_period" Link to this property "pending\_delete" Link to this property
Link to this property
[Link to this property](<#(resource)%20registrar_sandbox%20%3E%20(model)%20registration%20%3E%20(schema)>)
WorkflowStatus {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. Link to this property created\_at: string formatdate-time Link to this property
links: Links {self, resource } self: string URL to this status resource. Link to this property resource?: string URL to the domain resource. Link to this property
Link to this property
state: "pending"| "in\_progress"| "action\_required"| 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" Link to this property "in\_progress" Link to this property "action\_required" Link to this property "blocked" Link to this property "succeeded" Link to this property "failed" Link to this property
Link to this property updated\_at: string formatdate-time Link to this property context?: Record<string, unknown> Provides workflow-specific data. For domain-centric workflows, context.domain_name identifies the workflow subject. Link to this property
error?: Error| null 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. Link to this property message: string Human-readable explanation of the failure. May include registry-specific details. Link to this property
Link to this property
[Link to this property](<#(resource)%20registrar_sandbox%20%3E%20(model)%20workflow_status%20%3E%20(schema)>)
RegistrarSandboxSearchResponse {domains } Contains the search results.
domains: Array<Domain> Lists domain suggestions in relevance order. An empty array indicates that the search criteria matched zero domains. name: string The fully qualified domain name (FQDN) in punycode format for internationalized domain names (IDNs). Link to this property registrable: boolean Indicates domain availability according to potentially stale, non-authoritative search data. - true: The domain appears available. Use POST /domain-check to confirm before registration. - false: Search results mark the domain ineligible for registration through this API. See reason for details. Link to this property
pricing?: Pricing {currency, registration\_cost, renewal\_cost } Provides annual pricing information for a given domain. The API returns all per-year prices as strings to preserve decimal precision. renewal_cost and registration_cost or transfer_cost are frequently the same value, but may differ due to premium rates for certain domains. For a multi-year operations, the operation’s cost applies to the first year and renewal_cost applies to each subsequent year. The values reflect the current registry rate, which can change over time. currency: string ISO-4217 currency code for the prices (e.g., “USD”, “EUR”, “GBP”). Link to this property registration\_cost: string The first-year cost to register this domain. Link to this property renewal\_cost: string Per-year renewal cost for this domain. Applied to each year beyond the first year of a multi-year registration, and to each annual auto-renewal thereafter. May differ from registration_cost, especially for premium domains where initial registration often costs more than renewals. Link to this property
Link to this property
reason?: "extension\_not\_supported\_via\_api"| "extension\_not\_supported"| "extension\_disallows\_registration"| 2 more Appears only when registrable is false and explains the advisory search result. Use POST /domain-check for authoritative status. - extension_not_supported_via_api: Cloudflare Registrar supports this extension in the dashboard but currently excludes it from programmatic registration through this API. - extension_not_supported: Cloudflare Registrar excludes this extension entirely. - extension_disallows_registration: The extension’s registry temporarily or permanently freezes new registrations. - domain_premium: The domain carries premium pricing. This API currently supports standard registrations only. - domain_unavailable: The domain appears unavailable. One of the following: "extension\_not\_supported\_via\_api" Link to this property "extension\_not\_supported" Link to this property "extension\_disallows\_registration" Link to this property "domain\_premium" Link to this property "domain\_unavailable" Link to this property
Link to this property
tier?: "standard"| "premium" The pricing tier for this domain. A registrable value of true always includes this field, which defaults to standard for most domains. A registrable value of false may omit it. - standard: Standard registry pricing. - premium: Premium domain with higher pricing from the registry. One of the following: "standard" Link to this property "premium" Link to this property
Link to this property
Link to this property
[Link to this property](<#(resource)%20registrar_sandbox%20%3E%20(model)%20registrar_sandbox_search_response%20%3E%20(schema)>)
RegistrarSandboxCheckResponse {domains } Contains the availability check results.
domains: Array<Domain> Array of domain availability results. Results for unsupported extensions contain registrable: false and a reason field. The response may omit malformed domain names. name: string The fully qualified domain name (FQDN) in punycode format for internationalized domain names (IDNs). Link to this property registrable: boolean Indicates programmatic registration eligibility according to a real-time registry check. - true: The domain is available for registration. The response includes the pricing object. - false: A restriction prevents registration. See the reason field for details. Some results, such as premium domains, may still include tier. Link to this property
pricing?: Pricing {currency, registration\_cost, renewal\_cost } Provides annual pricing information for a given domain. The API returns all per-year prices as strings to preserve decimal precision. renewal_cost and registration_cost or transfer_cost are frequently the same value, but may differ due to premium rates for certain domains. For a multi-year operations, the operation’s cost applies to the first year and renewal_cost applies to each subsequent year. The values reflect the current registry rate, which can change over time. currency: string ISO-4217 currency code for the prices (e.g., “USD”, “EUR”, “GBP”). Link to this property registration\_cost: string The first-year cost to register this domain. Link to this property renewal\_cost: string Per-year renewal cost for this domain. Applied to each year beyond the first year of a multi-year registration, and to each annual auto-renewal thereafter. May differ from registration_cost, especially for premium domains where initial registration often costs more than renewals. Link to this property
Link to this property
reason?: "extension\_not\_supported\_via\_api"| "extension\_not\_supported"| "extension\_disallows\_registration"| 2 more Appears only when registrable is false and explains the result. - extension_not_supported_via_api: Cloudflare Registrar supports this extension in the dashboard but currently excludes it from programmatic registration through this API. The user can register via https://dash.cloudflare.com/{account_id}/domains/registrations. - extension_not_supported: Cloudflare Registrar excludes this extension entirely. - extension_disallows_registration: The extension’s registry temporarily or permanently freezes new registrations. Registrars currently cannot register domains on this extension. - domain_premium: The domain carries premium pricing. This API currently supports standard registrations only. - domain_unavailable: An existing registration, reservation, or other registry restriction makes the domain unavailable on a supported extension. One of the following: "extension\_not\_supported\_via\_api" Link to this property "extension\_not\_supported" Link to this property "extension\_disallows\_registration" Link to this property "domain\_premium" Link to this property "domain\_unavailable" Link to this property
Link to this property
tier?: "standard"| "premium" The pricing tier for this domain. A registrable value of true always includes this field, which defaults to standard for most domains. A registrable value of false may omit it. - standard: Standard registry pricing. - premium: Premium domain with higher pricing from the registry. One of the following: "standard" Link to this property "premium" Link to this property
Link to this property
Link to this property
[Link to this property](<#(resource)%20registrar_sandbox%20%3E%20(model)%20registrar_sandbox_check_response%20%3E%20(schema)>) #### Registrar SandboxRegistrations ##### [Create Registration](https://developers.cloudflare.com/api/typescript/resources/registrar_sandbox/subresources/registrations/methods/create) client.registrarSandbox.registrations.create(RegistrationCreateParams {account\_id, domain\_name, acknowledgements, 6 more } params, RequestOptionsoptions?): [RegistrationCreateResponse]() {completed, created\_at, links, 4 more } POST/accounts/{account\_id}/registrar-sandbox/registrations ##### [List Registrations](https://developers.cloudflare.com/api/typescript/resources/registrar_sandbox/subresources/registrations/methods/list) client.registrarSandbox.registrations.list(RegistrationListParams {account\_id, cursor, direction, 2 more } params, RequestOptionsoptions?): CursorPagination< [RegistrationListResponse]() {auto\_renew, created\_at, domain\_name, 4 more } > GET/accounts/{account\_id}/registrar-sandbox/registrations ##### [Get Registration](https://developers.cloudflare.com/api/typescript/resources/registrar_sandbox/subresources/registrations/methods/get) client.registrarSandbox.registrations.get(stringdomainName, RegistrationGetParams {account\_id } params, RequestOptionsoptions?): [RegistrationGetResponse]() {auto\_renew, created\_at, domain\_name, 4 more } GET/accounts/{account\_id}/registrar-sandbox/registrations/{domain\_name} ##### [Update Registration](https://developers.cloudflare.com/api/typescript/resources/registrar_sandbox/subresources/registrations/methods/edit) client.registrarSandbox.registrations.edit(stringdomainName, RegistrationEditParams {account\_id, auto\_renew, Prefer } params, RequestOptionsoptions?): [RegistrationEditResponse]() {completed, created\_at, links, 4 more } PATCH/accounts/{account\_id}/registrar-sandbox/registrations/{domain\_name} ##### ModelsExpand Collapse
RegistrationCreateResponse {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. Link to this property created\_at: string formatdate-time Link to this property
links: Links {self, resource } self: string URL to this status resource. Link to this property resource?: string URL to the domain resource. Link to this property
Link to this property
state: "pending"| "in\_progress"| "action\_required"| 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" Link to this property "in\_progress" Link to this property "action\_required" Link to this property "blocked" Link to this property "succeeded" Link to this property "failed" Link to this property
Link to this property updated\_at: string formatdate-time Link to this property context?: Record<string, unknown> Provides workflow-specific data. For domain-centric workflows, context.domain_name identifies the workflow subject. Link to this property
error?: Error| null 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. Link to this property message: string Human-readable explanation of the failure. May include registry-specific details. Link to this property
Link to this property
[Link to this property](<#(resource)%20registrar_sandbox.registrations%20%3E%20(model)%20registration_create_response%20%3E%20(schema)>)
RegistrationListResponse {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. Link to this property created\_at: string When the domain was registered. Present when the registration resource exists. formatdate-time Link to this property 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. Link to this property expires\_at: string| null When the domain registration expires. Ready registrations include this value; only registration_pending and transfer_pending may return null. formatdate-time Link to this property locked: boolean Whether the domain is locked for transfer. Link to this property
privacy\_mode: "off"| "redaction" Current WHOIS privacy mode for the registration. One of the following: "off" Link to this property "redaction" Link to this property
Link to this property
status: "active"| "registration\_pending"| "transfer\_pending"| 4 more Current registration status. - active: The domain operates with an active registration. - registration_pending: Registration remains in progress. - transfer_pending: Domain transfer is 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" Link to this property "registration\_pending" Link to this property "transfer\_pending" Link to this property "expired" Link to this property "suspended" Link to this property "redemption\_period" Link to this property "pending\_delete" Link to this property
Link to this property
[Link to this property](<#(resource)%20registrar_sandbox.registrations%20%3E%20(model)%20registration_list_response%20%3E%20(schema)>)
RegistrationGetResponse {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. Link to this property created\_at: string When the domain was registered. Present when the registration resource exists. formatdate-time Link to this property 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. Link to this property expires\_at: string| null When the domain registration expires. Ready registrations include this value; only registration_pending and transfer_pending may return null. formatdate-time Link to this property locked: boolean Whether the domain is locked for transfer. Link to this property
privacy\_mode: "off"| "redaction" Current WHOIS privacy mode for the registration. One of the following: "off" Link to this property "redaction" Link to this property
Link to this property
status: "active"| "registration\_pending"| "transfer\_pending"| 4 more Current registration status. - active: The domain operates with an active registration. - registration_pending: Registration remains in progress. - transfer_pending: Domain transfer is 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" Link to this property "registration\_pending" Link to this property "transfer\_pending" Link to this property "expired" Link to this property "suspended" Link to this property "redemption\_period" Link to this property "pending\_delete" Link to this property
Link to this property
[Link to this property](<#(resource)%20registrar_sandbox.registrations%20%3E%20(model)%20registration_get_response%20%3E%20(schema)>)
RegistrationEditResponse {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. Link to this property created\_at: string formatdate-time Link to this property
links: Links {self, resource } self: string URL to this status resource. Link to this property resource?: string URL to the domain resource. Link to this property
Link to this property
state: "pending"| "in\_progress"| "action\_required"| 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" Link to this property "in\_progress" Link to this property "action\_required" Link to this property "blocked" Link to this property "succeeded" Link to this property "failed" Link to this property
Link to this property updated\_at: string formatdate-time Link to this property context?: Record<string, unknown> Provides workflow-specific data. For domain-centric workflows, context.domain_name identifies the workflow subject. Link to this property
error?: Error| null 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. Link to this property message: string Human-readable explanation of the failure. May include registry-specific details. Link to this property
Link to this property
[Link to this property](<#(resource)%20registrar_sandbox.registrations%20%3E%20(model)%20registration_edit_response%20%3E%20(schema)>) #### Registrar SandboxRegistration Status ##### [Get Registration Status](https://developers.cloudflare.com/api/typescript/resources/registrar_sandbox/subresources/registration_status/methods/get) client.registrarSandbox.registrationStatus.get(stringdomainName, RegistrationStatusGetParams {account\_id } params, RequestOptionsoptions?): [RegistrationStatusGetResponse]() {completed, created\_at, links, 4 more } GET/accounts/{account\_id}/registrar-sandbox/registrations/{domain\_name}/registration-status ##### ModelsExpand Collapse
RegistrationStatusGetResponse {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. Link to this property created\_at: string formatdate-time Link to this property
links: Links {self, resource } self: string URL to this status resource. Link to this property resource?: string URL to the domain resource. Link to this property
Link to this property
state: "pending"| "in\_progress"| "action\_required"| 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" Link to this property "in\_progress" Link to this property "action\_required" Link to this property "blocked" Link to this property "succeeded" Link to this property "failed" Link to this property
Link to this property updated\_at: string formatdate-time Link to this property context?: Record<string, unknown> Provides workflow-specific data. For domain-centric workflows, context.domain_name identifies the workflow subject. Link to this property
error?: Error| null 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. Link to this property message: string Human-readable explanation of the failure. May include registry-specific details. Link to this property
Link to this property
[Link to this property](<#(resource)%20registrar_sandbox.registration_status%20%3E%20(model)%20registration_status_get_response%20%3E%20(schema)>) #### Registrar SandboxUpdate Status ##### [Get Update Status](https://developers.cloudflare.com/api/typescript/resources/registrar_sandbox/subresources/update_status/methods/get) client.registrarSandbox.updateStatus.get(stringdomainName, UpdateStatusGetParams {account\_id } params, RequestOptionsoptions?): [UpdateStatusGetResponse]() {completed, created\_at, links, 4 more } GET/accounts/{account\_id}/registrar-sandbox/registrations/{domain\_name}/update-status ##### ModelsExpand Collapse
UpdateStatusGetResponse {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. Link to this property created\_at: string formatdate-time Link to this property
links: Links {self, resource } self: string URL to this status resource. Link to this property resource?: string URL to the domain resource. Link to this property
Link to this property
state: "pending"| "in\_progress"| "action\_required"| 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" Link to this property "in\_progress" Link to this property "action\_required" Link to this property "blocked" Link to this property "succeeded" Link to this property "failed" Link to this property
Link to this property updated\_at: string formatdate-time Link to this property context?: Record<string, unknown> Provides workflow-specific data. For domain-centric workflows, context.domain_name identifies the workflow subject. Link to this property
error?: Error| null 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. Link to this property message: string Human-readable explanation of the failure. May include registry-specific details. Link to this property
Link to this property
[Link to this property](<#(resource)%20registrar_sandbox.update_status%20%3E%20(model)%20update_status_get_response%20%3E%20(schema)>) #### Registrar SandboxExtensions ##### [List extensions](https://developers.cloudflare.com/api/typescript/resources/registrar_sandbox/subresources/extensions/methods/list) client.registrarSandbox.extensions.list(ExtensionListParams {account\_id, cursor, direction, 3 more } params, RequestOptionsoptions?): CursorPagination< [ExtensionListResponse]() {metadata, registration\_schema, transfer\_schema } > GET/accounts/{account\_id}/registrar-sandbox/extensions ##### [Get extension](https://developers.cloudflare.com/api/typescript/resources/registrar_sandbox/subresources/extensions/methods/get) client.registrarSandbox.extensions.get(stringextension, ExtensionGetParams {account\_id } params, RequestOptionsoptions?): [ExtensionGetResponse]() {metadata, registration\_schema, transfer\_schema } GET/accounts/{account\_id}/registrar-sandbox/extensions/{extension} ##### ModelsExpand Collapse
ExtensionListResponse {metadata, registration\_schema, transfer\_schema } Extension entry with metadata and JSON Schema documents for registration and transfer operations.
metadata: Metadata {name, tld } Extension metadata. name: string The full name of the extension. For example, “co.uk”, or “uk”. Link to this property tld: string The TLD of the extension. For example, for “co.uk”, it is “uk”. For “uk”, it is “uk”. Link to this property
Link to this property registration\_schema: unknown JSON Schema describing the expected input structure for registration operations on this extension. Link to this property transfer\_schema: unknown JSON Schema describing the expected input structure for transfer operations on this extension. Link to this property
[Link to this property](<#(resource)%20registrar_sandbox.extensions%20%3E%20(model)%20extension_list_response%20%3E%20(schema)>)
ExtensionGetResponse {metadata, registration\_schema, transfer\_schema } Extension entry with metadata and JSON Schema documents for registration and transfer operations.
metadata: Metadata {name, tld } Extension metadata. name: string The full name of the extension. For example, “co.uk”, or “uk”. Link to this property tld: string The TLD of the extension. For example, for “co.uk”, it is “uk”. For “uk”, it is “uk”. Link to this property
Link to this property registration\_schema: unknown JSON Schema describing the expected input structure for registration operations on this extension. Link to this property transfer\_schema: unknown JSON Schema describing the expected input structure for transfer operations on this extension. Link to this property
[Link to this property](<#(resource)%20registrar_sandbox.extensions%20%3E%20(model)%20extension_get_response%20%3E%20(schema)>)