CreateProjectRequestBody

August 5, 2026 ยท View on GitHub

Example Usage

import { CreateProjectRequestBody } from "@vercel/sdk/models/createprojectregion.js";

let value: CreateProjectRequestBody = {
  name: "a-project-name",
};

Fields

FieldTypeRequiredDescriptionExample
enablePreviewFeedbackboolean:heavy_minus_sign:Opt-in to preview toolbar on the project level
enableProductionFeedbackboolean:heavy_minus_sign:Opt-in to production toolbar on the project level
previewDeploymentsDisabledboolean:heavy_minus_sign:Specifies whether preview deployments are disabled for this project.
previewDeploymentSuffixstring:heavy_minus_sign:Custom domain suffix for preview deployments. Takes precedence over team-level suffix. Must be a domain owned by the team.
buildCommandstring:heavy_minus_sign:The build command for this project. When null is used this value will be automatically detected
commandForIgnoringBuildStepstring:heavy_minus_sign:N/A
devCommandstring:heavy_minus_sign:The dev command for this project. When null is used this value will be automatically detected
environmentVariablesmodels.EnvironmentVariables[]:heavy_minus_sign:Collection of ENV Variables the Project will use
frameworkmodels.CreateProjectFramework:heavy_minus_sign:The framework that is being used for this project. When null is used no framework is selected
gitRepositorymodels.GitRepository:heavy_minus_sign:The Git Repository that will be connected to the project. When this is defined, any pushes to the specified connected Git Repository will be automatically deployed
installCommandstring:heavy_minus_sign:The install command for this project. When null is used this value will be automatically detected
namestring:heavy_check_mark:The desired name for the projecta-project-name
skipGitConnectDuringLinkboolean:heavy_minus_sign:: warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Opts-out of the message prompting a CLI user to connect a Git repository in vercel link.
ssoProtectionmodels.CreateProjectSsoProtection:heavy_minus_sign:The Vercel Auth setting for the project (historically named "SSO Protection")
outputDirectorystring:heavy_minus_sign:The output directory of the project. When null is used this value will be automatically detected
publicSourceboolean:heavy_minus_sign:: warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Deprecated. Accepted for backwards compatibility but ignored.
rootDirectorystring:heavy_minus_sign: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
serverlessFunctionRegionstring:heavy_minus_sign:The region to deploy Serverless Functions in this project
serverlessFunctionZeroConfigFailoverboolean:heavy_minus_sign:Specifies whether Zero Config Failover is enabled for this project.
oidcTokenConfigmodels.OidcTokenConfig:heavy_minus_sign:OpenID Connect JSON Web Token generation configuration.
enableAffectedProjectsDeploymentsboolean:heavy_minus_sign:Opt-in to skip deployments when there are no changes to the root directory and its dependencies
resourceConfigmodels.CreateProjectResourceConfig:heavy_minus_sign:Specifies resource override configuration for the project