purchase_schemas
GoDaddy Domains v1 API. Accepts a Personal Access Token (Bearer) or a classic sso-key credential.
Overview
| Name | purchase_schemas |
| Type | Resource |
| Id | godaddy.registration.purchase_schemas |
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 | Returns the JSON schema for the domain purchase request body for the specified TLD. Fetch before purchasing 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 |
|---|---|---|
tld | string | The Top-Level Domain whose schema should be retrieved |
SELECT examples
- get
Returns the JSON schema for the domain purchase request body for the specified TLD. Fetch before purchasing to identify required fields and TLD-specific constraints.
SELECT
id,
models,
properties,
required
FROM godaddy.registration.purchase_schemas
WHERE tld = '{{ tld }}' -- required
;