Skip to main content

status

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

Overview

Namestatus
TypeResource
Idvercel.domains.status

Fields

The following fields are returned by SELECT queries:

Successful response checking if a Domain's name is available.

NameDatatypeDescription
availableboolean

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
check_domain_statusselectname, teamIdCheck if a domain name is available for purchase.

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.

NameDatatypeDescription
namestringThe name of the domain for which we would like to check the status.
teamIdstringThe Team identifier or slug to perform the request on behalf of.

SELECT examples

Check if a domain name is available for purchase.

SELECT
available
FROM vercel.domains.status
WHERE name = '{{ name }}' -- required
AND teamId = '{{ teamId }}' -- required
;