domains
Check a Domain Availability
Check if a domain name is available for purchase.
- namestringrequired
The name of the domain for which we would like to check the status.
Exampleexample.com
- teamIdstring
The Team identifier to perform the request on behalf of.
- slugstring
The Team slug to perform the request on behalf of.
- 400
One of the provided values in the request query is invalid.
- 401
- 403
You do not have permission to access this resource.
- 500
fetch('https://api.vercel.com/v4/domains/status?name=example.com')
{
"available": true
}
Successful response checking if a Domain's name is available.
Check the price for a domain
Check the price to purchase a domain and how long a single purchase period is.
- namestringrequired
The name of the domain for which the price needs to be checked.
Exampleexample.com
- typestring enum
In which status of the domain the price needs to be checked.
Examplenew
- new
- renewal
- transfer
- redemption
- teamIdstring
The Team identifier to perform the request on behalf of.
- slugstring
The Team slug to perform the request on behalf of.
- 400
One of the provided values in the request query is invalid.
- 401
- 403
You do not have permission to access this resource.
fetch('https://api.vercel.com/v4/domains/price?name=example.com')
{
"price": 20,
"period": 1
}
Successful response which returns the price of the domain and the period.
Vercel REST API
The Vercel REST API is a REST-styled API that gives you full control over the entire Vercel platform. You can use it with any programming language or framework that can send HTTP requests. You need to authenticate with a Vercel access token for every request.
Production API
access-groups
- POST/v1/access-groups/{accessGroupIdOrName}/projects
- POST/v1/access-groups
- DELETE/v1/access-groups/{accessGroupIdOrName}/projects/{projectId}
- DELETE/v1/access-groups/{idOrName}
- GET/v1/access-groups
- GET/v1/access-groups/{idOrName}/members
- GET/v1/access-groups/{idOrName}/projects
- GET/v1/access-groups/{idOrName}
- GET/v1/access-groups/{accessGroupIdOrName}/projects/{projectId}
- POST/v1/access-groups/{idOrName}
- PATCH/v1/access-groups/{accessGroupIdOrName}/projects/{projectId}
aliases
artifacts
authentication
Models
idOrName Required |
Accept | */* |
teamId | |
slug |