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.
Creates a custom environment for the current project. Cannot be named 'Production' or 'Preview'.
The unique project identifier or the project name
The Team identifier to perform the request on behalf of.
The Team slug to perform the request on behalf of.
The slug of the custom environment to create.
Description of the custom environment. This is optional.
How we want to determine a matching branch. This is optional.
Where to copy environment variables from. This is optional.
One of the provided values in the request body is invalid. One of the provided values in the request query is invalid.
The account was soft-blocked for an unhandled reason. The account is missing a payment so payment method must be updated
You do not have permission to access this resource.
fetch('https://api.vercel.com/v9/projects/{idOrName}/custom-environments', {
method: 'POST',
headers: {
'Content-Type': 'application/json'
},
body: JSON.stringify({
slug: '',
description: '',
branchMatcher: {
type: 'equals',
pattern: ''
},
copyEnvVarsFrom: ''
})
})
{}Remove a custom environment for the project. Must not be named 'Production' or 'Preview'.
The unique project identifier or the project name
The unique custom environment identifier within the project
The Team identifier to perform the request on behalf of.
The Team slug to perform the request on behalf of.
Delete Environment Variables that are not assigned to any environments.
One of the provided values in the request body is invalid. One of the provided values in the request query is invalid.
You do not have permission to access this resource.
fetch('https://api.vercel.com/v9/projects/{idOrName}/custom-environments/{environmentSlugOrId}', {
method: 'DELETE',
headers: {
'Content-Type': 'application/json'
},
body: JSON.stringify({
deleteUnassignedEnvironmentVariables: true
})
})
{}Retrieve a custom environment for the project. Must not be named 'Production' or 'Preview'.
The unique project identifier or the project name
The unique custom environment identifier within the project
The Team identifier to perform the request on behalf of.
The Team slug to perform the request on behalf of.
One of the provided values in the request query is invalid.
You do not have permission to access this resource.
fetch('https://api.vercel.com/v9/projects/{idOrName}/custom-environments/{environmentSlugOrId}')
{}Retrieve custom environments for the project. Must not be named 'Production' or 'Preview'.
The unique project identifier or the project name
Fetch custom environments for a specific git branch
The Team identifier to perform the request on behalf of.
The Team slug to perform the request on behalf of.
One of the provided values in the request query is invalid.
You do not have permission to access this resource.
fetch('https://api.vercel.com/v9/projects/{idOrName}/custom-environments')
{
"environments": [
{}
]
}Update a custom environment for the project. Must not be named 'Production' or 'Preview'.
The unique project identifier or the project name
The unique custom environment identifier within the project
The Team identifier to perform the request on behalf of.
The Team slug to perform the request on behalf of.
The slug of the custom environment.
Description of the custom environment. This is optional.
One of the provided values in the request body is invalid. One of the provided values in the request query is invalid.
The account was soft-blocked for an unhandled reason. The account is missing a payment so payment method must be updated
You do not have permission to access this resource.
fetch('https://api.vercel.com/v9/projects/{idOrName}/custom-environments/{environmentSlugOrId}', {
method: 'PATCH',
headers: {
'Content-Type': 'application/json'
},
body: JSON.stringify({
slug: '',
description: '',
branchMatcher: {
type: 'equals',
pattern: ''
}
})
})
{}