Pricing Templates
Log in Sign up
Integrations / Vercel / ...

PATCH /v9/projects/{idOrName}

Update the fields of a project using either its name or id.

Servers

Path parameters

Name Type Required Description
idOrName String Yes

The unique project identifier or the project name

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Query parameters

Name Type Required Description
teamId String No

The Team identifier to perform the request on behalf of.
slug String No

The Team slug to perform the request on behalf of.

Request body fields

Name Type Required Description
rootDirectory String No

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
autoExposeSystemEnvs Boolean No
customerSupportCodeVisibility Boolean No

Specifies whether customer support can see git source for a deployment
gitForkProtection Boolean No

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

Specifies whether the source code and logs of the deployments for this project should be public or not
ssoProtection Object No

Ensures visitors to your Preview Deployments are logged into Vercel and have a minimum of Viewer access on your team
ssoProtection.deploymentType String Yes

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

Possible values:

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

Default value: "preview"
serverlessFunctionRegion String No

The region to deploy Serverless Functions in this project
autoAssignCustomDomainsUpdatedBy String No
enableAffectedProjectsDeployments Boolean No

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

Allows to protect project deployments with a password
passwordProtection.deploymentType String Yes

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

Possible values:

  • "preview"
  • "prod_deployment_urls_and_all_previews"
  • "all"
passwordProtection.password String No

The password that will be used to protect Project Deployments
commandForIgnoringBuildStep String No
sourceFilesOutsideRootDirectory Boolean No

Indicates if there are source files outside of the root directory
oidcTokenConfig Object No

OpenID Connect JSON Web Token generation configuration.
oidcTokenConfig.issuerMode String No

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

Possible values:

  • "global"
  • "team"

Default value: "team"
oidcTokenConfig.enabled Boolean No

Whether or not to generate OpenID Connect JSON Web Tokens.

Default value: true
outputDirectory String No

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

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

Specifies resource override configuration for the project
resourceConfig.buildMachineType String No

Possible values:

  • null
  • "enhanced"
  • "ultra"
resourceConfig.functionZeroConfigFailover No

Specifies whether Zero Config Failover is enabled for this project.
resourceConfig.elasticConcurrencyEnabled Boolean No
resourceConfig.functionDefaultRegions[] Array No

The regions to deploy Vercel Functions to for this project
resourceConfig.functionDefaultTimeout Number No
resourceConfig.functionDefaultMemoryType String No

Possible values:

  • "performance"
  • "standard"
  • "standard_legacy"
resourceConfig.fluid Boolean No
autoAssignCustomDomains Boolean No
skipGitConnectDuringLink Boolean No

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

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

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

Restricts access to deployments based on the incoming request IP address
trustedIps.addresses[] Array Yes
trustedIps.addresses[].note String No

An optional note explaining what the IP address or subnet is used for
trustedIps.addresses[].value String Yes

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

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

Possible values:

  • "preview"
  • "prod_deployment_urls_and_all_previews"
  • "production"
  • "all"
trustedIps.protectionMode String Yes

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)

Possible values:

  • "exclusive"
  • "additional"
enableProductionFeedback Boolean No

Opt-in to production toolbar on the project level
enablePreviewFeedback Boolean No

Opt-in to preview toolbar on the project level
connectConfigurations[] Array No

The list of connections from project environment to Secure Compute network
connectConfigurations[].connectConfigurationId String Yes

The ID of the Secure Compute network
connectConfigurations[].passive Boolean Yes

Whether the configuration should be passive, meaning builds will not run there and only passive Serverless Functions will be deployed
connectConfigurations[].buildsEnabled Boolean Yes

Flag saying if project builds should use Secure Compute
connectConfigurations[].envId String Yes

The ID of the environment
devCommand String No

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

The desired name for the project
optionsAllowlist Object No

Specify a list of paths that should not be protected by Deployment Protection to enable Cors preflight requests
optionsAllowlist.paths[] Array Yes
optionsAllowlist.paths[].value String Yes

The regex path that should not be protected by Deployment Protection
serverlessFunctionZeroConfigFailover No

Specifies whether Zero Config Failover is enabled for this project.
skewProtectionMaxAge Integer No

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

Possible values:

  • "16.x"
  • "20.x"
  • "22.x"
  • "10.x"
  • "12.x"
  • "14.x"
  • "18.x"
gitLFS Boolean No

Specifies whether Git LFS is enabled for this project.
previewDeploymentsDisabled Boolean No

Specifies whether preview deployments are disabled for this project.
framework String No

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

Possible values:

  • "astro"
  • "nextjs"
  • "sanity-v3"
  • "remix"
  • "docusaurus"
  • "jekyll"
  • "brunch"
  • "umijs"
  • "dojo"
  • "parcel"
  • "solidstart-1"
  • "eleventy"
  • "ionic-angular"
  • "create-react-app"
  • "docusaurus-2"
  • "svelte"
  • "middleman"
  • "redwoodjs"
  • "sapper"
  • "angular"
  • "hugo"
  • "hydrogen"
  • "hexo"
  • "polymer"
  • "blitzjs"
  • "ember"
  • "zola"
  • "vue"
  • "sanity"
  • "react-router"
  • "vite"
  • "solidstart"
  • "scully"
  • "sveltekit-1"
  • "gridsome"
  • "stencil"
  • "ionic-react"
  • null
  • "saber"
  • "preact"
  • "gatsby"
  • "nuxtjs"
  • "storybook"
  • "vitepress"
  • "vuepress"
  • "fasthtml"
  • "sveltekit"

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.
All third party trademarks (including logos and icons) are the property of their respective owners, which do not sponsor, authorize, or endorse this website.
Pricing Templates Integrations Blog Contact Us Help
© 2025 SimWorkflow
Terms of Service Privacy Policy