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

POST /v13/deployments

Creates a new deployment for the authenticated team or user. For non-git deployments, upload files first via the file upload API, then reference them here by SHA — or inline small files directly in the request body. To redeploy an existing deployment, provide its deploymentId; all settings are inherited unless explicitly overridden. The deployment begins building immediately and transitions through QUEUED → INITIALIZING → BUILDING before reaching READY or ERROR.

Servers

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.
skipAutoDetectionConfirmation String No

Set to 1 to skip framework auto-detection and proceed without confirmation. By default, if Vercel detects a framework that differs from the project setting, the API returns a 400 asking you to confirm. Use this to suppress that check in automated pipelines.

Valid values:

  • "1"
  • "0"
forceNew String No

Forces a new deployment even if there is a previous similar deployment. Set to 1 to bypass deployment deduplication and always trigger a fresh build.

Valid values:

  • "1"
  • "0"

Request body fields

Name Type Required Description
projectSettings Object No

Project settings that will be applied to the deployment. It is required for the first deployment of a project and will be saved for any following deployments
projectSettings.commandForIgnoringBuildStep String No
projectSettings.devCommand String No

The dev command for this project. When null is used this value will be automatically detected
projectSettings.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
projectSettings.sourceFilesOutsideRootDirectory Boolean No

Indicates if there are source files outside of the root directory, typically used for monorepos
projectSettings.skipGitConnectDuringLink Boolean No

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

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

Override the Node.js version that should be used for this deployment

Valid values:

  • "16.x"
  • "20.x"
  • "24.x"
  • "22.x"
  • "10.x"
  • "12.x"
  • "14.x"
  • "8.10.x"
  • "18.x"
projectSettings.outputDirectory String No

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

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

The region to deploy Serverless Functions in this project
projectSettings.framework String No

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"
  • "services"
  • "solidstart-1"
  • "xmcp"
  • "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"
customEnvironmentSlugOrId String No

The slug or ID of a custom environment to deploy to, overriding the default target environment. When omitted, the deployment targets the environment inferred from the branch (production or preview).
deploymentId String No

The ID of an existing deployment to redeploy. All project settings and environment variables are inherited from the original unless explicitly overridden in this request. The redeployment gets a new ID, URL, and build.
files[] Array No

The files to include in the deployment. Each entry is either an inlined file (with data and encoding) or a reference to a previously uploaded file (with sha and size). Required for non-git deployments. Cannot be used together with gitSource.
name String Yes

A string with the project name used in the deployment URL
target String No

Either not defined, staging, production, or a custom environment identifier. If staging, a staging alias in the format <project>-<team>.vercel.app will be assigned. If production, any aliases defined in alias will be assigned. If omitted, the target will be preview.
meta Object No

An object containing the deployment's metadata. Multiple key-value pairs can be attached to a deployment
withLatestCommit Boolean No

When true and deploymentId is passed in, the sha from the previous deployment's gitSource is removed forcing the latest commit to be used.
gitMetadata Object No

Populates initial git metadata for different git providers.
gitMetadata.commitMessage String No

The commit message
gitMetadata.ciGitProviderUsername String No

The username used for the Git Provider (e.g. GitHub) if their CI (e.g. GitHub Actions) was used, if available
gitMetadata.commitSha String No

The hash of the commit
gitMetadata.dirty Boolean No

Whether or not there have been modifications to the working tree since the latest commit
gitMetadata.commitAuthorName String No

The name of the author of the commit
gitMetadata.ciGitRepoVisibility String No

The visibility of the Git repository if their CI (e.g. GitHub Actions) was used, if available
gitMetadata.ciType String No

The type of CI system used
gitMetadata.ci Boolean No

True if process.env.CI was set when deploying
gitMetadata.remoteUrl String No

The git repository's remote origin url
gitMetadata.commitAuthorEmail String No

The email of the author of the commit
gitMetadata.commitRef String No

The branch on which the commit was made
monorepoManager String No

The monorepo manager that is being used for this deployment. When null is used no monorepo manager is selected
gitSource No

Defines the Git Repository source to be deployed. This property can not be used in combination with files.
project String No

The target project identifier in which the deployment will be created. When defined, this parameter overrides name

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
© 2026 SimWorkflow
Terms of Service Privacy Policy