GET /accounts/{account_id}/registrar/registrations/{domain_name}/registration-status

Returns the current status of a domain registration workflow.

Use this endpoint to poll for completion when the POST 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.

Terminal states: succeeded and failed are terminal and always have completed: true.

Non-terminal states:

• action_required has completed: false and will not resolve on its own. The workflow is paused pending user intervention.
• blocked has completed: false and indicates the workflow is waiting on a third party such as the extension registry or losing registrar. Continue polling while informing the user of the delay.

Use increasing backoff between polls. When state: blocked, use a longer polling interval and do not poll indefinitely.

A naive polling loop that only checks completed can run indefinitely when state: action_required. Break explicitly on action_required:

let status;
do {
  await new Promise(r => setTimeout(r, 2000));
  status = await cloudflare.request({
    method: 'GET',
    path: reg.result.links.self,
  });
} while (
  !status.result.completed &&
  status.result.state !== 'action_required'
);

if (status.result.state === 'action_required') {
  // Surface context.action and context.confirmation_sent_to to the user.
  // Do not re-submit the registration request.
}

Servers

• https://api.cloudflare.com/client/v4

Path parameters

How to start integrating

1. Add HTTP Task to your workflow definition.
2. Search for the API you want to integrate with and click on the name.
   • This loads the API reference documentation and prepares the Http request settings.
3. Click Test request to test run your request to the API and see the API's response.