domain_registry

Creates, updates, deletes, gets or lists a domain_registry resource.

Overview

Name	domain_registry
Type	Resource
Id	vercel.domains.domain_registry

Fields

The following fields are returned by SELECT queries:

get_domain_transfer

Name	Datatype	Description
reason	string	Description associated with transferable state.
status	string	The current state of an ongoing transfer. pending_owner: Awaiting approval by domain's admin contact (every transfer begins with this status). If approval is not given within five days, the transfer is cancelled. pending_admin: Waiting for approval by Vercel Registrar admin. pending_registry: Awaiting registry approval (the transfer completes after 7 days unless it is declined by the current registrar). completed: The transfer completed successfully. cancelled: The transfer was cancelled. undef: No transfer exists for this domain. unknown: This TLD is not supported by Vercel's Registrar.
transferPolicy	string	The domain's transfer policy (depends on TLD requirements). charge-and-renew: transfer will charge for renewal and will renew the existing domain's registration. no-charge-no-change: transfer will have no change to registration period and does not require charge. no-change: transfer charge is required, but no change in registration period. new-term: transfer charge is required and a new registry term is set based on the transfer date. not-supported: transfers are not supported for this domain or TLD. null: This TLD is not supported by Vercel's Registrar.
transferable	boolean	Whether or not the domain is transferable

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_domain_transfer	select	domain, teamId		Fetch domain transfer availability or transfer status if a transfer is in progress.

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
domain	string	The name of the domain.
teamId	string	The Team identifier or slug to perform the request on behalf of.

SELECT examples

get_domain_transfer

Fetch domain transfer availability or transfer status if a transfer is in progress.

SELECT
reason,
status,
transferPolicy,
transferable
FROM vercel.domains.domain_registry
WHERE domain = '{{ domain }}' -- required
AND teamId = '{{ teamId }}' -- required
;