domain_availability
Creates, updates, deletes, gets or lists a domain_availability resource.
Overview
| Name | domain_availability |
| Type | Resource |
| Id | vercel.domains_registrar.domain_availability |
Fields
The following fields are returned by SELECT queries:
- get
| Name | Datatype | Description |
|---|---|---|
available | boolean |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | domain | team_id | Get availability for a specific domain. If the domain is available, it can be purchased using the [Buy a domain](https://vercel.com/docs/rest-api/reference/endpoints/domains-registrar/buy-a-domain) endpoint or the [Buy multiple domains](https://vercel.com/docs/rest-api/reference/endpoints/domains-registrar/buy-multiple-domains) endpoint. |
get_bulk | exec | domains | teamId | Get availability for multiple domains. If the domains are available, they can be purchased using the [Buy a domain](https://vercel.com/docs/rest-api/reference/endpoints/domains-registrar/buy-a-domain) endpoint or the [Buy multiple domains](https://vercel.com/docs/rest-api/reference/endpoints/domains-registrar/buy-multiple-domains) endpoint. |
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 | |
team_id | string | (wire: teamId) |
SELECT examples
- get
Get availability for a specific domain. If the domain is available, it can be purchased using the Buy a domain endpoint or the Buy multiple domains endpoint.
SELECT
available
FROM vercel.domains_registrar.domain_availability
WHERE domain = '{{ domain }}' -- required
AND team_id = '{{ team_id }}'
;
Lifecycle Methods
EXEC variables use wire (API) names.
- get_bulk
Get availability for multiple domains. If the domains are available, they can be purchased using the Buy a domain endpoint or the Buy multiple domains endpoint.
EXEC vercel.domains_registrar.domain_availability.get_bulk
@teamId='{{ teamId }}'
@@json=
'{
"domains": "{{ domains }}"
}'
;