domains

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

Overview

Name	domains
Type	Resource
Id	vercel.domains_registrar.domains

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
update_auto_renew	exec	domain, autoRenew	teamId	Update the auto-renew setting for a domain
update_nameservers	exec	domain, nameservers	teamId	Update the nameservers for a domain. Pass an empty array to use Vercel's default nameservers.

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
teamId	string

Lifecycle Methods

EXEC variables use wire (API) names.

update_auto_renew

Update the auto-renew setting for a domain

EXEC vercel.domains_registrar.domains.update_auto_renew 
@domain='{{ domain }}' --required, 
@teamId='{{ teamId }}' 
@@json=
'{
"autoRenew": {{ autoRenew }}
}'
;

update_nameservers

Update the nameservers for a domain. Pass an empty array to use Vercel's default nameservers.

EXEC vercel.domains_registrar.domains.update_nameservers 
@domain='{{ domain }}' --required, 
@teamId='{{ teamId }}' 
@@json=
'{
"nameservers": "{{ nameservers }}"
}'
;