registration_schemas_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

Name	registration_schemas_v2
Type	Resource
Id	godaddy.registration.registration_schemas_v2

Fields

The following fields are returned by SELECT queries:

get

Request was successful

Name	Datatype	Description
id	string
models	array
properties	array
required	array

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	tld, customer_id	x_request_id	Returns the JSON schema for the registration request body for the specified TLD. Fetch before registering to identify required fields and TLD-specific constraints.

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
customer_id	string (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.
tld	string	The Top-Level Domain whose schema should be retrieved
x_request_id	string	A client provided identifier for tracking this request. (wire: X-Request-Id)

SELECT examples

get

Returns the JSON schema for the registration request body for the specified TLD. Fetch before registering to identify required fields and TLD-specific constraints.

SELECT
id,
models,
properties,
required
FROM godaddy.registration.registration_schemas_v2
WHERE tld = '{{ tld }}' -- required
AND customer_id = '{{ customer_id }}' -- required unless GODADDY_CUSTOMER_ID is set
AND x_request_id = '{{ x_request_id }}'
;