PATCH /v9/projects/{idOrName}

The unique project identifier or the project name

Default value: "application/json"

The Team identifier to perform the request on behalf of.

The Team slug to perform the request on behalf of.

Deployment Protection Trusted Sources

The label or description of the trusted source

Optional overrides for the default same-env-by-slug matching.

A set of environments, expressed as explicit slugs, a named preset, or both. At least one of slugs or preset must be set.

Valid values:

• "all-custom"

A set of environments, expressed as explicit slugs, a named preset, or both. At least one of slugs or preset must be set.

Valid values:

• "all-custom"

A set of environments, expressed as explicit slugs, a named preset, or both. At least one of slugs or preset must be set.

Valid values:

• "all-custom"

The label or description of the trusted source

Passport configuration for the project.

Valid values:

• "preview"
• "prod_deployment_urls_and_all_previews"
• "all_except_custom_domains"
• "all"

Default value: "all"

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

Specifies whether customer support can see git source for a deployment

Specifies whether PRs from Git forks should require a team member's authorization before it can be deployed

Specifies whether sourcemaps are protected and require authentication to access.

Deprecated. Accepted for backwards compatibility but ignored.

Ensures visitors to your Preview Deployments are logged into Vercel and have a minimum of Viewer access on your team

Specify if the Vercel Authentication (SSO Protection) will apply to every Deployment Target or just Preview

Valid values:

• "preview"
• "prod_deployment_urls_and_all_previews"
• "all_except_custom_domains"
• "all"

Default value: "preview"

The region to deploy Serverless Functions in this project

Opt-in to skip deployments when there are no changes to the root directory and its dependencies

Allows to protect project deployments with a password

Specify if the password will apply to every Deployment Target or just Preview

Valid values:

• "preview"
• "prod_deployment_urls_and_all_previews"
• "all_except_custom_domains"
• "all"

The password that will be used to protect Project Deployments

Cross-site domains allowed to fetch skew-protected assets (hostnames, optionally with leading wildcard like *.example.com).

Indicates if there are source files outside of the root directory

OpenID Connect JSON Web Token generation configuration.

team: https://oidc.vercel.com/[team_slug] global: https://oidc.vercel.com

Valid values:

• "global"
• "team"

Default value: "team"

Whether or not to generate OpenID Connect JSON Web Tokens.

Default value: true

The output directory of the project. When null is used this value will be automatically detected

Tracing configuration for this project

Comma-separated list of drain endpoint domains

Sampling rules for trace collection

Sampling rate from 0 to 1

Environment to apply sampling to

Valid values:

• "preview"
• "production"

Request path prefix to apply the sampling rule to

Tracing destination this rule applies to. Derived server-side when project tracing is computed; accepted here so a computed config can round-trip through this endpoint.

Valid values:

• "external"
• "internal"

Paths to ignore for tracing

Deployments created before this absolute datetime have Skew Protection disabled. Value is in milliseconds since epoch to match "createdAt" fields.

Custom domain suffix for preview deployments. Takes precedence over team-level suffix. Must be a domain owned by the team.

Specifies resource override configuration for the project

Valid values:

• "elastic"
• null
• "standard"
• "enhanced"
• "turbo"

Specifies whether Zero Config Failover is enabled for this project.

The regions to deploy Vercel Functions to for this project

Valid values:

• "WAIT_FOR_NAMESPACE_QUEUE"
• "SKIP_NAMESPACE_QUEUE"

Valid values:

• "performance"
• "standard"
• "performance_xl"
• "standard_legacy"

Valid values:

• "elastic"
• "fixed"

Opts-out of the message prompting a CLI user to connect a Git repository in vercel link.

The install command for this project. When null is used this value will be automatically detected

Specifies whether external rewrite caching is enabled for this project.

The build command for this project. When null is used this value will be automatically detected

Restricts access to deployments based on the incoming request IP address

An optional note explaining what the IP address or subnet is used for

The IP addresses that are allowlisted. Supports IPv4 addresses and CIDR notations. IPv6 is not supported

Specify if the Trusted IPs will apply to every Deployment Target or just Preview

Valid values:

• "preview"
• "prod_deployment_urls_and_all_previews"
• "all_except_custom_domains"
• "production"
• "all"

exclusive: ip match is enough to bypass deployment protection (regardless of other settings). additional: ip must match + any other protection should be also provided (password, vercel auth, shareable link, automation bypass header, automation bypass query param)

Valid values:

• "exclusive"
• "additional"

Opt-in to production toolbar on the project level

Opt-in to preview toolbar on the project level

The list of connections from project environment to Secure Compute network

The ID of the Secure Compute network

Whether the configuration should be passive, meaning builds will not run there and only passive Serverless Functions will be deployed

Flag saying if project builds should use Secure Compute

The ID of the environment

The dev command for this project. When null is used this value will be automatically detected

The desired name for the project

Specify a list of paths that should not be protected by Deployment Protection to enable Cors preflight requests

The regex path that should not be protected by Deployment Protection

Specifies whether Zero Config Failover is enabled for this project.

Deployments created before this rolling window have Skew Protection disabled. Value is in seconds to match "revalidate" fields.

An array of objects representing a Dismissed Toast in regards to a Project. Objects are either merged with existing toasts (on key match), or added to the dimissedToasts array.`

unix timestamp representing the time the toast was dimissed

Whether the toast was dismissed, the action was accepted, or the dismissal with this key should be removed

Valid values:

• "cancel"
• "delete"
• "accept"

unique identifier for the dismissed toast

Valid values:

• "16.x"
• "20.x"
• "24.x"
• "22.x"
• "10.x"
• "12.x"
• "14.x"
• "18.x"

Manage Static IPs for this project

Opt-in to Static IPs for this project

Specifies whether Git LFS is enabled for this project.

Specifies whether preview deployments are disabled for this project.

The framework that is being used for this project. When null is used no framework is selected

Valid values:

• "ash"
• "axum"
• "docusaurus"
• "jekyll"
• "django"
• "nestjs"
• "dojo"
• "solidstart-1"
• "xmcp"
• "services"
• "docusaurus-2"
• "svelte"
• "middleman"
• "tanstack-start"
• "sapper"
• "angular"
• "fastapi"
• "hydrogen"
• "bun"
• "ember"
• "ruby"
• "sanity"
• "nitro"
• "solidstart"
• "stencil"
• null
• "saber"
• "node"
• "storybook"
• "express"
• "fasthtml"
• "astro"
• "nextjs"
• "h3"
• "remix"
• "brunch"
• "umijs"
• "go"
• "hono"
• "parcel"
• "python"
• "eleventy"
• "ionic-angular"
• "create-react-app"
• "redwoodjs"
• "mastra"
• "hugo"
• "rust"
• "elysia"
• "hexo"
• "polymer"
• "actix-web"
• "blitzjs"
• "sanity-v2"
• "zola"
• "vue"
• "react-router"
• "vite"
• "container"
• "scully"
• "sveltekit-1"
• "gridsome"
• "ionic-react"
• "flask"
• "preact"
• "koa"
• "gatsby"
• "fastify"
• "nuxtjs"
• "vitepress"
• "vuepress"
• "sveltekit"
• "eve"