---
title: Get Update Status
---

[Skip to content](#_top)

[API Reference](https://developers.cloudflare.com/api/go)

[Registrar Sandbox](https://developers.cloudflare.com/api/go/resources/registrar_sandbox)

[Update Status](https://developers.cloudflare.com/api/go/resources/registrar_sandbox/subresources/update_status)

Copy Markdown

Open in **Claude**Open in **ChatGPT**Open in **Cursor**

---

**Copy Markdown****View as Markdown**

# Get Update Status

client.RegistrarSandbox.UpdateStatus.Get(ctx, domainName, query) (\*[UpdateStatusGetResponse](<https://developers.cloudflare.com/api/go/resources/registrar_sandbox#(resource)%20registrar_sandbox.update_status%20%3E%20(model)%20UpdateStatusGetResponse%20%3E%20(schema)>), error)

GET/accounts/{account\_id}/registrar-sandbox/registrations/{domain\_name}/update-status

Returns the current status of a domain update workflow.

Use this endpoint to poll for completion when the PATCH response returned `202 Accepted`. The URL is provided in the `links.self` field of the workflow status response.

Poll this endpoint until the workflow reaches a terminal state or a state that requires user attention.

Use increasing backoff between polls. When the workflow remains blocked on a third party, use a longer polling interval and do not poll indefinitely.

##### Security

<details>

<summary>API Token</summary>



The preferred authorization scheme for interacting with the Cloudflare API. <a href="https://developers.cloudflare.com/fundamentals/api/get-started/create-token/">Create a token</a>.

**Example:**<code>Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY</code>

</details>

<details>

<summary>API Email + API Key</summary>



The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

**Example:**<code>X-Auth-Email: user@example.com</code>

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

**Example:**<code>X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194</code>

</details>

##### ParametersExpand Collapse

domainName 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](<#(resource)%20registrar_sandbox.update_status%20%3E%20(method)%20get%20%3E%20(params)%20default%20%3E%20(param)%20domain_name%20%3E%20(schema)>)

<details>

<summary>

query UpdateStatusGetParams

</summary>

AccountID param.Field\[string]

Identifier.

maxLength32

<a href="#(resource)%20registrar_sandbox.update_status%20%3E%20(method)%20get%20%3E%20(params)%20default%20%3E%20(param)%20account_id">Link to this property</a>

</details>

[Link to this property](<#(resource)%20registrar_sandbox.update_status%20%3E%20(method)%20get%20%3E%20(params)%20default>)

##### ReturnsExpand Collapse

<details>

<summary>

type UpdateStatusGetResponse struct{…}

Status of an async registration workflow.

</summary>

Completed bool

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

<a href="#(resource)%20registrar_sandbox.update_status%20%3E%20(model)%20UpdateStatusGetResponse%20%3E%20(schema)%20%3E%20(property)%20completed">Link to this property</a>

CreatedAt Time

formatdate-time

<a href="#(resource)%20registrar_sandbox.update_status%20%3E%20(model)%20UpdateStatusGetResponse%20%3E%20(schema)%20%3E%20(property)%20created_at">Link to this property</a>

<details>

<summary>

Links UpdateStatusGetResponseLinks

</summary>

Self string

URL to this status resource.

<a href="#(resource)%20registrar_sandbox.update_status%20%3E%20(model)%20UpdateStatusGetResponse%20%3E%20(schema)%20%3E%20(property)%20links%20%3E%20(property)%20self">Link to this property</a>

Resource stringOptional

URL to the domain resource.

<a href="#(resource)%20registrar_sandbox.update_status%20%3E%20(model)%20UpdateStatusGetResponse%20%3E%20(schema)%20%3E%20(property)%20links%20%3E%20(property)%20resource">Link to this property</a>

</details>

<a href="#(resource)%20registrar_sandbox.update_status%20%3E%20(model)%20UpdateStatusGetResponse%20%3E%20(schema)%20%3E%20(property)%20links">Link to this property</a>

<details>

<summary>

State UpdateStatusGetResponseState

Describes the workflow lifecycle state.

- <code>pending</code>: The workflow awaits processing.
- <code>in_progress</code>: Processing started. Continue polling <code>links.self</code>. An internal deadline limits the duration of this state.
- <code>action_required</code>: The workflow pauses for user action. See <code>context.action</code> for details. Stop automated polling until the user completes the required action.
- <code>blocked</code>: 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.
- <code>succeeded</code>: Terminal state. The operation completed successfully. <code>completed</code> equals <code>true</code>. For registrations, <code>context.registration</code> contains the resulting registration resource.
- <code>failed</code>: Terminal state. The operation failed. <code>completed</code> equals <code>true</code>. See <code>error.code</code> and <code>error.message</code> for the reason. Require user review before retrying.

</summary>

One of the following:

const UpdateStatusGetResponseStatePending UpdateStatusGetResponseState = "pending"

<a href="#(resource)%20registrar_sandbox.update_status%20%3E%20(model)%20UpdateStatusGetResponse%20%3E%20(schema)%20%3E%20(property)%20state%20%3E%20(member)%200">Link to this property</a>

const UpdateStatusGetResponseStateInProgress UpdateStatusGetResponseState = "in\_progress"

<a href="#(resource)%20registrar_sandbox.update_status%20%3E%20(model)%20UpdateStatusGetResponse%20%3E%20(schema)%20%3E%20(property)%20state%20%3E%20(member)%201">Link to this property</a>

const UpdateStatusGetResponseStateActionRequired UpdateStatusGetResponseState = "action\_required"

<a href="#(resource)%20registrar_sandbox.update_status%20%3E%20(model)%20UpdateStatusGetResponse%20%3E%20(schema)%20%3E%20(property)%20state%20%3E%20(member)%202">Link to this property</a>

const UpdateStatusGetResponseStateBlocked UpdateStatusGetResponseState = "blocked"

<a href="#(resource)%20registrar_sandbox.update_status%20%3E%20(model)%20UpdateStatusGetResponse%20%3E%20(schema)%20%3E%20(property)%20state%20%3E%20(member)%203">Link to this property</a>

const UpdateStatusGetResponseStateSucceeded UpdateStatusGetResponseState = "succeeded"

<a href="#(resource)%20registrar_sandbox.update_status%20%3E%20(model)%20UpdateStatusGetResponse%20%3E%20(schema)%20%3E%20(property)%20state%20%3E%20(member)%204">Link to this property</a>

const UpdateStatusGetResponseStateFailed UpdateStatusGetResponseState = "failed"

<a href="#(resource)%20registrar_sandbox.update_status%20%3E%20(model)%20UpdateStatusGetResponse%20%3E%20(schema)%20%3E%20(property)%20state%20%3E%20(member)%205">Link to this property</a>

</details>

<a href="#(resource)%20registrar_sandbox.update_status%20%3E%20(model)%20UpdateStatusGetResponse%20%3E%20(schema)%20%3E%20(property)%20state">Link to this property</a>

UpdatedAt Time

formatdate-time

<a href="#(resource)%20registrar_sandbox.update_status%20%3E%20(model)%20UpdateStatusGetResponse%20%3E%20(schema)%20%3E%20(property)%20updated_at">Link to this property</a>

Context map\[string, unknown]Optional

Provides workflow-specific data.

For domain-centric workflows, <code>context.domain_name</code> identifies the workflow subject.

<a href="#(resource)%20registrar_sandbox.update_status%20%3E%20(model)%20UpdateStatusGetResponse%20%3E%20(schema)%20%3E%20(property)%20context">Link to this property</a>

<details>

<summary>

Error UpdateStatusGetResponseErrorOptional

Provides error details when a workflow reaches the <code>failed</code> 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 <code>errors[].code</code> values in non-2xx responses. Surface <code>error.message</code> to the user for context.

</summary>

Code string

Machine-readable error code identifying the failure reason.

<a href="#(resource)%20registrar_sandbox.update_status%20%3E%20(model)%20UpdateStatusGetResponse%20%3E%20(schema)%20%3E%20(property)%20error%20%3E%20(property)%20code">Link to this property</a>

Message string

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

<a href="#(resource)%20registrar_sandbox.update_status%20%3E%20(model)%20UpdateStatusGetResponse%20%3E%20(schema)%20%3E%20(property)%20error%20%3E%20(property)%20message">Link to this property</a>

</details>

<a href="#(resource)%20registrar_sandbox.update_status%20%3E%20(model)%20UpdateStatusGetResponse%20%3E%20(schema)%20%3E%20(property)%20error">Link to this property</a>

</details>

[Link to this property](<#(resource)%20registrar_sandbox.update_status%20%3E%20(model)%20UpdateStatusGetResponse%20%3E%20(schema)>)

### Get Update Status

Go

HTTPTypeScriptPythonGoTerraform

```
package main

import (
  "context"
  "fmt"

  "github.com/cloudflare/cloudflare-go"
  "github.com/cloudflare/cloudflare-go/option"
  "github.com/cloudflare/cloudflare-go/registrar_sandbox"
)

func main() {
  client := cloudflare.NewClient(
    option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
  )
  updateStatus, err := client.RegistrarSandbox.UpdateStatus.Get(
    context.TODO(),
    "example.com",
    registrar_sandbox.UpdateStatusGetParams{
      AccountID: cloudflare.F("023e105f4ecef8ad9ca31a8372d0c353"),
    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", updateStatus.Completed)
}
```

200 example

200 example

200 example

4XX example

```
{
  "errors": [],
  "messages": [],
  "result": {
    "completed": true,
    "context": {
      "domain_name": "example.com"
    },
    "created_at": "2025-10-27T10:00:00Z",
    "error": {
      "code": "registry_rejected",
      "message": "Registry rejected the update request."
    },
    "links": {
      "resource": "/accounts/abc/registrar/registrations/example.com",
      "self": "/accounts/abc/registrar/registrations/example.com/update-status"
    },
    "state": "failed",
    "updated_at": "2025-10-27T10:00:45Z"
  },
  "success": true
}
```

```
{
  "errors": [],
  "messages": [],
  "result": {
    "completed": false,
    "context": {
      "domain_name": "example.com",
      "fields_updated": [
        "auto_renew"
      ],
      "pending_registry_confirmation": true
    },
    "created_at": "2025-10-27T10:00:00Z",
    "links": {
      "resource": "/accounts/abc/registrar/registrations/example.com",
      "self": "/accounts/abc/registrar/registrations/example.com/update-status"
    },
    "state": "in_progress",
    "updated_at": "2025-10-27T10:00:05Z"
  },
  "success": true
}
```

```
{
  "errors": [],
  "messages": [],
  "result": {
    "completed": true,
    "context": {
      "domain_name": "example.com",
      "fields_updated": [
        "auto_renew"
      ]
    },
    "created_at": "2025-10-27T10:00:00Z",
    "links": {
      "resource": "/accounts/abc/registrar/registrations/example.com",
      "self": "/accounts/abc/registrar/registrations/example.com/update-status"
    },
    "state": "succeeded",
    "updated_at": "2025-10-27T10:00:30Z"
  },
  "success": true
}
```

```
{
  "errors": [
    {
      "code": 10000,
      "message": "No workflow found for example.com"
    }
  ],
  "messages": [],
  "result": null,
  "success": false
}
```

##### Returns Examples

200 example

200 example

200 example

4XX example

```
{
  "errors": [],
  "messages": [],
  "result": {
    "completed": true,
    "context": {
      "domain_name": "example.com"
    },
    "created_at": "2025-10-27T10:00:00Z",
    "error": {
      "code": "registry_rejected",
      "message": "Registry rejected the update request."
    },
    "links": {
      "resource": "/accounts/abc/registrar/registrations/example.com",
      "self": "/accounts/abc/registrar/registrations/example.com/update-status"
    },
    "state": "failed",
    "updated_at": "2025-10-27T10:00:45Z"
  },
  "success": true
}
```

```
{
  "errors": [],
  "messages": [],
  "result": {
    "completed": false,
    "context": {
      "domain_name": "example.com",
      "fields_updated": [
        "auto_renew"
      ],
      "pending_registry_confirmation": true
    },
    "created_at": "2025-10-27T10:00:00Z",
    "links": {
      "resource": "/accounts/abc/registrar/registrations/example.com",
      "self": "/accounts/abc/registrar/registrations/example.com/update-status"
    },
    "state": "in_progress",
    "updated_at": "2025-10-27T10:00:05Z"
  },
  "success": true
}
```

```
{
  "errors": [],
  "messages": [],
  "result": {
    "completed": true,
    "context": {
      "domain_name": "example.com",
      "fields_updated": [
        "auto_renew"
      ]
    },
    "created_at": "2025-10-27T10:00:00Z",
    "links": {
      "resource": "/accounts/abc/registrar/registrations/example.com",
      "self": "/accounts/abc/registrar/registrations/example.com/update-status"
    },
    "state": "succeeded",
    "updated_at": "2025-10-27T10:00:30Z"
  },
  "success": true
}
```

```
{
  "errors": [
    {
      "code": 10000,
      "message": "No workflow found for example.com"
    }
  ],
  "messages": [],
  "result": null,
  "success": false
}
```