--- title: Registrations --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/python) [Registrar Sandbox](https://developers.cloudflare.com/api/python/resources/registrar_sandbox) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Registrations ##### [Create Registration](https://developers.cloudflare.com/api/python/resources/registrar_sandbox/subresources/registrations/methods/create) registrar\_sandbox.registrations.create(RegistrationCreateParams\*\*kwargs) -> [RegistrationCreateResponse]() POST/accounts/{account\_id}/registrar-sandbox/registrations ##### [List Registrations](https://developers.cloudflare.com/api/python/resources/registrar_sandbox/subresources/registrations/methods/list) registrar\_sandbox.registrations.list(RegistrationListParams\*\*kwargs) -> SyncCursorPagination\[[RegistrationListResponse]()] GET/accounts/{account\_id}/registrar-sandbox/registrations ##### [Get Registration](https://developers.cloudflare.com/api/python/resources/registrar_sandbox/subresources/registrations/methods/get) registrar\_sandbox.registrations.get(strdomain\_name, RegistrationGetParams\*\*kwargs) -> [RegistrationGetResponse]() GET/accounts/{account\_id}/registrar-sandbox/registrations/{domain\_name} ##### [Update Registration](https://developers.cloudflare.com/api/python/resources/registrar_sandbox/subresources/registrations/methods/edit) registrar\_sandbox.registrations.edit(strdomain\_name, RegistrationEditParams\*\*kwargs) -> [RegistrationEditResponse]() PATCH/accounts/{account\_id}/registrar-sandbox/registrations/{domain\_name} ##### ModelsExpand Collapse
class RegistrationCreateResponse: … Status of an async registration workflow. completed: bool 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: datetime formatdate-time Link to this property
links: Links self: str URL to this status resource. Link to this property resource: Optional\[str] URL to the domain resource. Link to this property
Link to this property
state: Literal\["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: datetime formatdate-time Link to this property context: Optional\[Dict\[str, object]] Provides workflow-specific data. For domain-centric workflows, context.domain_name identifies the workflow subject. Link to this property
error: Optional\[Error] 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: str Machine-readable error code identifying the failure reason. Link to this property message: str 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)>)
class RegistrationListResponse: … A domain registration resource representing the current state of a registered domain. auto\_renew: bool Whether automatic renewal occurs before expiration. Link to this property created\_at: datetime When the domain was registered. Present when the registration resource exists. formatdate-time Link to this property domain\_name: str 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: Optional\[datetime] 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: bool Whether the domain is locked for transfer. Link to this property
privacy\_mode: Literal\["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: Literal\["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)>)
class RegistrationGetResponse: … A domain registration resource representing the current state of a registered domain. auto\_renew: bool Whether automatic renewal occurs before expiration. Link to this property created\_at: datetime When the domain was registered. Present when the registration resource exists. formatdate-time Link to this property domain\_name: str 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: Optional\[datetime] 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: bool Whether the domain is locked for transfer. Link to this property
privacy\_mode: Literal\["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: Literal\["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)>)
class RegistrationEditResponse: … Status of an async registration workflow. completed: bool 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: datetime formatdate-time Link to this property
links: Links self: str URL to this status resource. Link to this property resource: Optional\[str] URL to the domain resource. Link to this property
Link to this property
state: Literal\["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: datetime formatdate-time Link to this property context: Optional\[Dict\[str, object]] Provides workflow-specific data. For domain-centric workflows, context.domain_name identifies the workflow subject. Link to this property
error: Optional\[Error] 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: str Machine-readable error code identifying the failure reason. Link to this property message: str 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)>)