Skip to main content

actions_v2

GoDaddy Domains v2 API, scoped to a customer: customer_id is resolved from the GODADDY_CUSTOMER_ID environment variable when set, otherwise it is a required parameter (a WHERE value always wins). Accepts a Personal Access Token (Bearer) or a classic sso-key credential.

Overview​

Nameactions_v2
TypeResource
Idgodaddy.domains.actions_v2

Fields​

The following fields are returned by SELECT queries:

Request was successful

NameDatatypeDescription
request_idstringA client provided identifier (via X-Request-Id header) used for tracking individual requests (wire: requestId)
completed_atstring (iso-datetime)Timestamp indicating when the action was completed (wire: completedAt)
created_atstring (iso-datetime)Timestamp indicating when the action was created (wire: createdAt)
modified_atstring (iso-datetime)Timestamp indicating when the action was last modified (wire: modifiedAt)
originationstringThe origination of the action - USER — These are user requests. - SYSTEM — These are system processing actions. (USER, SYSTEM)
reasonobject
started_atstring (iso-datetime)Timestamp indicating when the action was started (wire: startedAt)
statusstringThe current status of the action - ACCEPTED — The action has been queued; processing has not started. - AWAITING — The action is waiting on user input. - CANCELLED — The action has been cancelled by the user. - FAILED — An error occurred while the action was processing; no more processing will be performed. - PENDING — The action is being processed. - SUCCESS — The action has completed; no additional processing is required. (ACCEPTED, AWAITING, CANCELLED, FAILED, PENDING, SUCCESS) (default: ACCEPTED)
typestringThe type of action being performed - AUTH_CODE_PURCHASE — Request for an auth code for a .de domain via POST /v2/customers/{customerId}/domains/{domain}/purchaseAuthCode. - AUTH_CODE_REGENERATE — Request to regenerate the authCode for a domain via POST /v2/customers/{customerId}/domains/{domain}/regenerateAuthCode - AUTO_RENEWAL — A Domain Auto Renew is in progress. - BACKORDER_PURCHASE — Request to purchase a domain backorder via POST /v2/customers/{customerId}/domains/backorders/purchase. - BACKORDER_DELETE — Request to cancel the current domain backorder via DELETE /v2/customers/{customerId}/domains/backorders/{domain}. - BACKORDER_UPDATE — Request update the current domain backorder via PATCH /v2/customers/{customerId}/domains/backorders/{domain}. - CHANGE_OF_REGISTRANT_DELETE — Request to delete a change of registrant request via DELETE /v2/customers/{customerId}/domains/{domain}/changeOfRegistrant. - CONTACT_CREATE — Request to create a contact via POST /v2/customers/{customerId}/domains/contacts. - CONTACT_DELETE — Request to delete a contact via DELETE /v2/customers/{customerId}/domains/contacts/{contactId} - CONTACT_UPDATE — Request to update a contact via PATCH /v2/customers/{customerId}/domains/contacts/{contactId} - DNS_VERIFICATION — Domain requires zone file setup. - DNSSEC_CREATE — Request to create DNSSEC record for the domain via PATCH /v2/customers/{customerId}/domains/{domain}/dnssecRecords. - DNSSEC_DELETE — Request to delete DNSSEC record for the domain via DELETE /v2/customers/{customerId}/domains/{domain}/dnssecRecords. - DOMAIN_DELETE — Request to delete the domain via DELETE /v2/customers/{customerId}/domains/{domain} - DOMAIN_UPDATE — Request to update the domain via PATCH /v2/customers/{customerId}/domains/{domain} - DOMAIN_UPDATE_CONTACTS — Request to update the domain contacts via PATCH /v2/customers/{customerId}/domains/{domain}/contacts - DOMAIN_UPDATE_NAME_SERVERS — Request to update the domain name servers via PUT /v2/customers/{customerId}/domains/{domain}/nameServers - EXPIRY — A Domain Expiration is in progress. - HOST_CREATE — Request to create a hostname via PUT /v2/customers/{customerId}/domains/{domain}/hosts/{hostname} - HOST_DELETE — Request to delete a hostname via DELETE /v2/customers/{customerId}/domains/{domain}/hosts/{hostname} - ICANN_VERIFICATION — Domain requires registrant verification for ICANN. - PREMIUM — Premium Domain domain sale is in progress. - PRIVACY_FORWARDING_UPDATE — Request to update privacy forwarding information via PATCH /v2/customers/{customerId}/domains/{domain}/privacy/forwarding. - PRIVACY_PURCHASE — Request to purchase privacy for a domain via POST /v2/customers/{customerId}/domains/{domain}/privacy/purchase - PRIVACY_DELETE — Request to remove privacy from a domain via DELETE /v2/customers/{customerId}/domains/{domain}/privacy - REDEEM — Request to redeem a domain via POST /v2/customers/{customerId}/domains/{domain}/redeem - REGISTER — Request to register a domain via POST /v2/customers/{customerId}/domains/{domain}/register - RENEW — Request to renew a domain via POST /v2/customers/{customerId}/domains/{domain}/renew - RENEW_UNDO — Request to undo a renewal for a uk domain via POST /v2/customers/{customerId}/domains/{domain}/undoRenew - TRADE — A domain trade request is in progress - TRADE_CANCEL — Request to cancel a trade for a domain via POST /v2/customers/{customerId}/domains/{domain}/tradeCancel - TRADE_PURCHASE — Request to purchase a trade for a domain via POST /v2/customers/{customerId}/domains/{domain}/tradePurchase - TRADE_PURCHASE_AUTH_TEXT_MESSAGE — Request for a trade purchase text message for a domain via POST /v2/customers/{customerId}/domains/{domain}/tradePurchaseAuthorizationTextMessage - TRADE_RESEND_AUTH_EMAIL — Request to resend the trade auth email message for a domain via POST /v2/customers/{customerId}/domains/{domain}/tradeResendAuthorizationEmail - TRANSFER — Request to transfer a domain via POST /v2/customers/{customerId}/domains/{domain}/transfer - TRANSFER_IN — A domain transfer in request is in progress. - TRANSFER_IN_ACCEPT — Request to accept a domain transfer in via POST /v2/customers/{customerId}/domains/{domain}/transferInAccept - TRANSFER_IN_CANCEL — Request to cancel a domain transfer via POST /v2/customers/{customerId}/domains/{domain}/transferInCancel - TRANSFER_IN_RESTART — Request to restart a domain transfer in via POST /v2/customers/{customerId}/domains/{domain}/transferInRestart - TRANSFER_IN_RETRY — Request to retry a domain transfer in via POST /v2/customers/{customerId}/domains/{domain}/transferInRetry - TRANSFER_OUT — A domain transfer out request is in progress. - TRANSFER_OUT_ACCEPT — Request to accept a transfer out request for a domain via POST /v2/customers/{customerId}/domains/{domain}/transferOutAccept - TRANSFER_OUT_REJECT — Request to reject a transfer out request for a domain via POST /v2/customers/{customerId}/domains/{domain}/transferOutReject - TRANSFER_OUT_REQUESTED — Request to transfer out for a domain (.de) via POST /v2/customers/{customerId}/domains/{domain}/transferOut - TRANSIT — Request to transit a de or at domain at the registry via POST /v2/customers/{customerId}/domains/{domain}/transit (AUTH_CODE_PURCHASE, AUTH_CODE_REGENERATE, AUTO_RENEWAL, BACKORDER_PURCHASE, BACKORDER_DELETE, BACKORDER_UPDATE, CHANGE_OF_REGISTRANT_DELETE, CONTACT_CREATE, CONTACT_DELETE, CONTACT_UPDATE, DNS_VERIFICATION, DNSSEC_CREATE, DNSSEC_DELETE, DOMAIN_DELETE, DOMAIN_UPDATE, DOMAIN_UPDATE_CONTACTS, DOMAIN_UPDATE_NAME_SERVERS, EXPIRY, HOST_CREATE, HOST_DELETE, ICANN_VERIFICATION, MIGRATE, MIGRATE_IN, PREMIUM, PRIVACY_PURCHASE, PRIVACY_DELETE, REDEEM, REGISTER, RENEW, RENEW_UNDO, TRADE, TRADE_CANCEL, TRADE_PURCHASE, TRADE_PURCHASE_AUTH_TEXT_MESSAGE, TRADE_RESEND_AUTH_EMAIL, TRANSFER, TRANSFER_IN, TRANSFER_IN_ACCEPT, TRANSFER_IN_CANCEL, TRANSFER_IN_RESTART, TRANSFER_IN_RETRY, TRANSFER_OUT, TRANSFER_OUT_ACCEPT, TRANSFER_OUT_REJECT, TRANSFER_OUT_REQUESTED, TRANSIT)

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectdomain, type, customer_idx_request_idReturns the most recent action of the specified type including status, timestamps, and any error details.
listselectdomain, customer_idx_request_idReturns a paginated list of recent actions for the domain. Use to track long-running operations or audit domain history.
canceldeletedomain, type, customer_idx_request_idCancels the most recent user-initiated action if it is still in a cancellable state. Returns 202 Accepted.

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.

NameDatatypeDescription
customer_idstring (uuid)GoDaddy customer identifier (UUID, not the numeric shopper number). Resolved from the GODADDY_CUSTOMER_ID environment variable when it is set (server variable, x-stackQL-envVar); otherwise required on every method of this resource. A WHERE value always takes precedence over the environment. API resellers acting on behalf of a subaccount pass the subaccount customer identifier.
domainstringDomain whose action is to be cancelled
typestringThe type of action to cancel
x_request_idstringA client provided identifier for tracking this request. (wire: X-Request-Id)

SELECT examples​

Returns the most recent action of the specified type including status, timestamps, and any error details.

SELECT
request_id,
completed_at,
created_at,
modified_at,
origination,
reason,
started_at,
status,
type
FROM godaddy.domains.actions_v2
WHERE domain = '{{ domain }}' -- required
AND customer_id = '{{ customer_id }}' -- required unless GODADDY_CUSTOMER_ID is set
AND type = '{{ type }}' -- required
AND x_request_id = '{{ x_request_id }}'
;

DELETE examples​

Cancels the most recent user-initiated action if it is still in a cancellable state. Returns 202 Accepted.

DELETE FROM godaddy.domains.actions_v2
WHERE domain = '{{ domain }}' --required
AND customer_id = '{{ customer_id }}' -- required unless GODADDY_CUSTOMER_ID is set
AND type = '{{ type }}' --required
AND x_request_id = '{{ x_request_id }}'
;
Last updated on