Update Status
Get Update Status
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.
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.
state: "pending" | "in_progress" | "action_required" | 3 moreDescribes 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.
state: "pending" | "in_progress" | "action_required" | 3 more
Describes the workflow lifecycle state.
pending: The workflow awaits processing.in_progress: Processing started. Continue pollinglinks.self. An internal deadline limits the duration of this state.action_required: The workflow pauses for user action. Seecontext.actionfor 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.completedequalstrue. For registrations,context.registrationcontains the resulting registration resource.failed: Terminal state. The operation failed.completedequalstrue. Seeerror.codeanderror.messagefor the reason. Require user review before retrying.
context?: Record<string, unknown>
Provides workflow-specific data.
For domain-centric workflows, context.domain_name identifies the
workflow subject.
error?: Error | nullProvides 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.
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.