operations_v3

GoDaddy Domains v3 API (Personal Access Token only). Mutations are asynchronous and return an operation to poll via domains.operations_v3.

Overview

Name	operations_v3
Type	Resource
Id	godaddy.domains.operations_v3

Fields

The following fields are returned by SELECT queries:

get

Current operation state.

Name	Datatype	Description
operation_id	string (uuid)	A universally unique identifier (UUID) in RFC-4122 format. (example: 9f1c2e7a-4b3d-4e8f-a1c2-3d4e5f6a7b8c) (wire: operationId)
created_at	string	A date and time, in Internet date and time format. Note: The regular expression provides static schematic guidance but does not reject all invalid dates. (pattern: ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])[T,t]([0-1][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]+)?([Zz]|[+-][0-9]{2}:[0-9]{2})$) (wire: createdAt)
domain	string	The domain name this operation applies to. (example: example.com)
error	object	The error information. (title: Error)
links	array	HATEOAS link relations for this operation. rel=self — the canonical URL for this abstract operation view. rel=registration, rel=renewal, or rel=transfer — the same resource viewed through its concrete typed collection. rel=domain — the domain-name resource affected by this operation.
result	object	The terminal success payload for a completed domain operation. Returned on the parent DomainOperation when status is COMPLETED. Absent for non-terminal statuses (CONFIRMED, EXECUTING) and for FAILED operations. Once status reaches COMPLETED it is terminal: result is populated, remains available on subsequent polls, and status does not revert. Interpret the fields present in result using the parent operation's type: REGISTER — expiresAt, orderId. (title: Domain Operation Result)
status	string	The execution state of an asynchronous domain operation. CONFIRMED — operation has been accepted and is queued for execution. EXECUTING — operation is actively being processed by the registry or downstream systems. COMPLETED — operation finished successfully; result data is available. FAILED — operation terminated with an unrecoverable error; error detail is attached. (title: Domain Operation Status)
type	string	The type of asynchronous domain operation. Used to distinguish which workflow is being polled on the /operations/{operationId} endpoint. REGISTER — new domain registration. (title: Domain Operation Type)
updated_at	string	A date and time, in Internet date and time format. Note: The regular expression provides static schematic guidance but does not reject all invalid dates. (pattern: ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])[T,t]([0-1][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]+)?([Zz]|[+-][0-9]{2}:[0-9]{2})$) (wire: updatedAt)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	operation_id	x_request_id	Universal poll endpoint for all asynchronous domain mutations. Returns the current state of the operation. Non-terminal responses include a Retry-After header. Terminal statuses: - COMPLETED — operation succeeded; result contains the final outcome. - FAILED — operation terminated with an error; error contains detail. While status is non-terminal (CONFIRMED, EXECUTING), neither result nor error is present. Poll until a terminal status is reached. The poll URL is provided in the Location header of the initiating 202 response and in links[rel=self]. Clients must not construct this URL independently.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
operation_id	string (uuid)	The server-assigned operation identifier returned in the 202 response of any async domain mutation. (example: 9f1c2e7a-4b3d-4e8f-a1c2-3d4e5f6a7b8c) (wire: operationId)
x_request_id	string (uuid)	Optional client-generated request correlation identifier, propagated across services and returned in the response X-Request-Id header. (wire: X-Request-Id)

SELECT examples

get

Universal poll endpoint for all asynchronous domain mutations. Returns
the current state of the operation. Non-terminal responses include a
Retry-After header.

Terminal statuses:
- COMPLETED — operation succeeded; result contains the final outcome.
- FAILED — operation terminated with an error; error contains detail.

While status is non-terminal (CONFIRMED, EXECUTING), neither
result nor error is present. Poll until a terminal status is reached.

The poll URL is provided in the Location header of the initiating 202
response and in links[rel=self]. Clients must not construct this URL
independently.

SELECT
operation_id,
created_at,
domain,
error,
links,
result,
status,
type,
updated_at
FROM godaddy.domains.operations_v3
WHERE operation_id = '{{ operation_id }}' -- required
AND x_request_id = '{{ x_request_id }}'
;