Authorizations
Default authentication mechanism
Path Parameters
The unique project identifier or the project name
"prj_12HKQaOmR5t5Uy6vdcQsNIiZgHGB"
Query Parameters
The Team identifier to perform the request on behalf of.
"team_1a2b3c4d5e6f7g8h9i0j1k2l"
The Team slug to perform the request on behalf of.
"my-team-url-slug"
Body
The build command for this project. When null
is used this value will be automatically detected
256
256
Specifies whether customer support can see git source for a deployment
The dev command for this project. When null
is used this value will be automatically detected
256
The framework that is being used for this project. When null
is used no framework is selected
blitzjs
, nextjs
, gatsby
, remix
, react-router
, astro
, hexo
, eleventy
, docusaurus-2
, docusaurus
, preact
, solidstart-1
, solidstart
, dojo
, ember
, vue
, scully
, ionic-angular
, angular
, polymer
, svelte
, sveltekit
, sveltekit-1
, ionic-react
, create-react-app
, gridsome
, umijs
, sapper
, saber
, stencil
, nuxtjs
, redwoodjs
, hugo
, jekyll
, brunch
, middleman
, zola
, hydrogen
, vite
, vitepress
, vuepress
, parcel
, fastapi
, fasthtml
, sanity-v3
, sanity
, storybook
, nitro
, hono
, express
, h3
, xmcp
Specifies whether PRs from Git forks should require a team member's authorization before it can be deployed
Specifies whether Git LFS is enabled for this project.
The install command for this project. When null
is used this value will be automatically detected
256
The desired name for the project
100
"a-project-name"
22.x
, 20.x
, 18.x
, 16.x
, 14.x
, 12.x
, 10.x
The output directory of the project. When null
is used this value will be automatically detected
256
Specifies whether preview deployments are disabled for this project.
Specifies whether the source code and logs of the deployments for this project should be public or not
Specifies resource override configuration for the project
The name of a directory or relative path to the source code of your project. When null
is used it will default to the project root
256
The region to deploy Serverless Functions in this project
4
Specifies whether Zero Config Failover is enabled for this project.
Deployments created before this absolute datetime have Skew Protection disabled. Value is in milliseconds since epoch to match "createdAt" fields.
x >= 0
Deployments created before this rolling window have Skew Protection disabled. Value is in seconds to match "revalidate" fields.
x >= 0
Opts-out of the message prompting a CLI user to connect a Git repository in vercel link
.
Indicates if there are source files outside of the root directory
Opt-in to preview toolbar on the project level
Opt-in to production toolbar on the project level
Opt-in to skip deployments when there are no changes to the root directory and its dependencies
OpenID Connect JSON Web Token generation configuration.
Allows to protect project deployments with a password
Ensures visitors to your Preview Deployments are logged into Vercel and have a minimum of Viewer access on your team
Restricts access to deployments based on the incoming request IP address
Specify a list of paths that should not be protected by Deployment Protection to enable Cors preflight requests
The list of connections from project environment to Secure Compute network
1
Response
The project was successfully updated
22.x
, 20.x
, 18.x
, 16.x
, 14.x
, 12.x
, 10.x
, 8.10.x
Retention policies for deployments. These are enforced at the project level, but we also maintain an instance of this at the team level as a default policy that gets applied to new projects.
blitzjs
, nextjs
, gatsby
, remix
, react-router
, astro
, hexo
, eleventy
, docusaurus-2
, docusaurus
, preact
, solidstart-1
, solidstart
, dojo
, ember
, vue
, scully
, ionic-angular
, angular
, polymer
, svelte
, sveltekit
, sveltekit-1
, ionic-react
, create-react-app
, gridsome
, umijs
, sapper
, saber
, stencil
, nuxtjs
, redwoodjs
, hugo
, jekyll
, brunch
, middleman
, zola
, hydrogen
, vite
, vitepress
, vuepress
, parcel
, fastapi
, fasthtml
, sanity-v3
, sanity
, storybook
, nitro
, hono
, express
, h3
, xmcp
Description of why a project was rolled back, and by whom. Note that lastAliasRequest contains the from/to details of the rollback.
Project-level rolling release configuration that defines how deployments should be gradually rolled out
standard
, advanced
, critical