POST /v11/projects
Allows to create a new project with the provided configuration. It only requires the project name
but more configuration can be provided to override the defaults.
Servers
- https://api.vercel.com
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 |
---|---|---|---|
resourceConfig |
Object | No |
Specifies resource override configuration for the project |
resourceConfig.buildMachineType |
String | No |
Possible values:
|
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:
|
resourceConfig.fluid |
Boolean | No | |
rootDirectory |
String | No |
The name of a directory or relative path to the source code of your project. When |
skipGitConnectDuringLink |
Boolean | No |
Opts-out of the message prompting a CLI user to connect a Git repository in |
installCommand |
String | No |
The install command for this project. When |
publicSource |
Boolean | No |
Specifies whether the source code and logs of the deployments for this project should be public or not |
buildCommand |
String | No |
The build command for this project. When |
environmentVariables[] |
Array | No |
Collection of ENV Variables the Project will use |
environmentVariables[].gitBranch |
String | No |
If defined, the git branch of the environment variable (must have target=preview) |
environmentVariables[].key |
String | Yes |
Name of the ENV variable |
environmentVariables[].target |
Yes |
Deployment Target or Targets in which the ENV variable will be used |
|
environmentVariables[].type |
String | No |
Type of the ENV variable Possible values:
|
environmentVariables[].value |
String | Yes |
Value for the ENV variable |
serverlessFunctionRegion |
String | No |
The region to deploy Serverless Functions in this project |
enableProductionFeedback |
Boolean | No |
Opt-in to production toolbar on the project level |
enablePreviewFeedback |
Boolean | No |
Opt-in to preview toolbar on the project level |
enableAffectedProjectsDeployments |
Boolean | No |
Opt-in to skip deployments when there are no changes to the root directory and its dependencies |
commandForIgnoringBuildStep |
String | No | |
devCommand |
String | No |
The dev command for this project. When |
name |
String | Yes |
The desired name for the project |
serverlessFunctionZeroConfigFailover |
No |
Specifies whether Zero Config Failover is enabled for this project. |
|
oidcTokenConfig |
Object | No |
OpenID Connect JSON Web Token generation configuration. |
oidcTokenConfig.issuerMode |
String | No |
team: Possible values:
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 |
framework |
String | No |
The framework that is being used for this project. When Possible values:
|
gitRepository |
Object | No |
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 |
gitRepository.repo |
String | Yes |
The name of the git repository. For example: "vercel/next.js" |
gitRepository.type |
String | Yes |
The Git Provider of the repository Possible values:
|
How to start integrating
- Add HTTP Task to your workflow definition.
- 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.
- Click Test request to test run your request to the API and see the API's response.