registrations_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	registrations_v2
Type	Resource
Id	godaddy.registration.registrations_v2

Fields

The following fields are returned by SELECT queries:

SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
create	insert	domain, consent, customer_id	x_request_id	Registers the specified domain. Requires a consent object with TLD agreement keys from the schema endpoint. Charges the account's billing method. Returns 202 - poll GET .../actions/REGISTER until the action reaches a terminal state.
validate	exec	domain, consent, customer_id	x_request_id	Validates the registration request body against the TLD schema with no side effects and no charge. Returns 204 on success.

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.
x_request_id	string	A client provided identifier for tracking this request.
x_request_id	string	A client provided identifier for tracking this request. (wire: X-Request-Id)

INSERT examples

create

Registers the specified domain. Requires a consent object with TLD agreement keys from the schema endpoint. Charges the account's billing method. Returns 202 - poll GET .../actions/REGISTER until the action reaches a terminal state.

INSERT INTO godaddy.registration.registrations_v2 (
domain,
consent,
period,
name_servers,
renew_auto,
privacy,
contacts,
metadata,
x_request_id
)
SELECT 
'{{ domain }}' /* required */,
'{{ consent }}' /* required */,
{{ period }},
'{{ name_servers }}',
{{ renew_auto }},
{{ privacy }},
'{{ contacts }}',
'{{ metadata }}',
'{{ x_request_id }}'
;

Manifest

# Description fields are for documentation purposes
- name: registrations_v2
props:
  - name: domain
    value: "{{ domain }}"
    description: |
      For internationalized domain names with non-ascii characters, the domain name is converted to punycode before format and pattern validation rules are checked
  - name: consent
    value:
      agreementKeys:
        - "{{ agreementKeys }}"
      price: {{ price }}
      currency: "{{ currency }}"
      registryPremiumPricing: {{ registryPremiumPricing }}
      agreedBy: "{{ agreedBy }}"
      agreedAt: "{{ agreedAt }}"
      claimToken: "{{ claimToken }}"
  - name: period
    value: {{ period }}
    default: 1
  - name: name_servers
    value:
      - "{{ name_servers }}"
  - name: renew_auto
    value: {{ renew_auto }}
    default: true
  - name: privacy
    value: {{ privacy }}
    default: false
  - name: contacts
    value:
      admin:
        encoding: "{{ encoding }}"
        nameFirst: "{{ nameFirst }}"
        nameMiddle: "{{ nameMiddle }}"
        nameLast: "{{ nameLast }}"
        organization: "{{ organization }}"
        jobTitle: "{{ jobTitle }}"
        email: "{{ email }}"
        phone: "{{ phone }}"
        fax: "{{ fax }}"
        addressMailing:
          address1: "{{ address1 }}"
          address2: "{{ address2 }}"
          city: "{{ city }}"
          country: "{{ country }}"
          postalCode: "{{ postalCode }}"
          state: "{{ state }}"
        metadata: "{{ metadata }}"
      adminId: "{{ adminId }}"
      billing:
        encoding: "{{ encoding }}"
        nameFirst: "{{ nameFirst }}"
        nameMiddle: "{{ nameMiddle }}"
        nameLast: "{{ nameLast }}"
        organization: "{{ organization }}"
        jobTitle: "{{ jobTitle }}"
        email: "{{ email }}"
        phone: "{{ phone }}"
        fax: "{{ fax }}"
        addressMailing:
          address1: "{{ address1 }}"
          address2: "{{ address2 }}"
          city: "{{ city }}"
          country: "{{ country }}"
          postalCode: "{{ postalCode }}"
          state: "{{ state }}"
        metadata: "{{ metadata }}"
      billingId: "{{ billingId }}"
      registrant:
        encoding: "{{ encoding }}"
        nameFirst: "{{ nameFirst }}"
        nameMiddle: "{{ nameMiddle }}"
        nameLast: "{{ nameLast }}"
        organization: "{{ organization }}"
        jobTitle: "{{ jobTitle }}"
        email: "{{ email }}"
        phone: "{{ phone }}"
        fax: "{{ fax }}"
        addressMailing:
          address1: "{{ address1 }}"
          address2: "{{ address2 }}"
          city: "{{ city }}"
          country: "{{ country }}"
          postalCode: "{{ postalCode }}"
          state: "{{ state }}"
        metadata: "{{ metadata }}"
      registrantId: "{{ registrantId }}"
      tech:
        encoding: "{{ encoding }}"
        nameFirst: "{{ nameFirst }}"
        nameMiddle: "{{ nameMiddle }}"
        nameLast: "{{ nameLast }}"
        organization: "{{ organization }}"
        jobTitle: "{{ jobTitle }}"
        email: "{{ email }}"
        phone: "{{ phone }}"
        fax: "{{ fax }}"
        addressMailing:
          address1: "{{ address1 }}"
          address2: "{{ address2 }}"
          city: "{{ city }}"
          country: "{{ country }}"
          postalCode: "{{ postalCode }}"
          state: "{{ state }}"
        metadata: "{{ metadata }}"
      techId: "{{ techId }}"
  - name: metadata
    value: "{{ metadata }}"
    description: |
      The domain eligibility data fields as specified by GET /v2/customers/{customerId}/domains/register/schema/{tld} (opaque JSON object)
  - name: x_request_id
    value: "{{ x_request_id }}"
    description: A client provided identifier for tracking this request.
    description: A client provided identifier for tracking this request.

Lifecycle Methods

EXEC variables use wire (API) names.

validate

Validates the registration request body against the TLD schema with no side effects and no charge. Returns 204 on success.

EXEC godaddy.registration.registrations_v2.validate 
@customer_id='{{ customer_id }}' --required unless GODADDY_CUSTOMER_ID is set, 
@x_request_id='{{ x_request_id }}', 
@domain='{{ domain }}', 
@consent='{{ consent }}', 
@period='{{ period }}', 
@name_servers='{{ name_servers }}', 
@renew_auto='{{ renew_auto }}', 
@privacy='{{ privacy }}', 
@contacts='{{ contacts }}', 
@metadata='{{ metadata }}'
;