/vercel-projects | Type: Application | PCID required: Yes
Tools
vercel_projects_accept_project_transfer_request
Accept project transfer request Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
code | string | Yes | — | The code of the project transfer request. |
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. |
acceptedPolicies | object | No | — | Accepted Policies |
newProjectName | string | No | — | The desired name for the project |
paidFeatures | object | No | — | Paid Features |
vercel_projects_add_project_domain
Add a domain to a project Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
idOrName | string | Yes | — | The unique project identifier or the project name |
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. |
customEnvironmentId | string | No | — | The unique custom environment identifier within the project |
gitBranch | string | No | — | Git branch to link the project domain |
name | string | Yes | — | The project domain name |
redirect | string | No | — | Target destination domain for redirect |
redirectStatusCode | integer | No | — | Status code for domain redirect |
vercel_projects_add_project_member
Adds a new member to a project. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
idOrName | string | Yes | — | The ID or name of the Project. |
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. |
email | string | No | — | The email of the team member that should be added to this project. |
role | string | Yes | — | The project role of the member that will be added. |
uid | string | No | — | The ID of the team member that should be added to this project. |
username | string | No | — | The username of the team member that should be added to this project. |
vercel_projects_batch_remove_project_env
Batch remove environment variables Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
idOrName | string | Yes | — | The unique project identifier or the project name |
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. |
ids | any[] | Yes | — | Array of environment variable IDs to delete |
vercel_projects_create_custom_environment
Create a custom environment for the current project. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
idOrName | string | Yes | — | The unique project identifier or the project name |
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. |
branchMatcher | object | No | — | How we want to determine a matching branch. This is optional. |
copyEnvVarsFrom | string | No | — | Where to copy environment variables from. This is optional. |
description | string | No | — | Description of the custom environment. This is optional. |
vercel_projects_create_project
Create a new project Parameters:| Parameter | Type | Required | Default | 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. |
buildCommand | string | No | — | The build command for this project. When null is used this value will be automatically detected |
commandForIgnoringBuildStep | string | No | — | Command For Ignoring Build Step |
devCommand | string | No | — | The dev command for this project. When null is used this value will be automatically detected |
enableAffectedProjectsDeployments | boolean | No | — | Opt-in to skip deployments when there are no changes to the root directory and its dependencies |
enablePreviewFeedback | boolean | No | — | Opt-in to preview toolbar on the project level |
enableProductionFeedback | boolean | No | — | Opt-in to production toolbar on the project level |
environmentVariables | any[] | No | — | Collection of ENV Variables the Project will use |
framework | object | No | — | The framework that is being used for this project. When null is used no framework is selected |
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 |
installCommand | string | No | — | The install command for this project. When null is used this value will be automatically detected |
name | string | Yes | — | The desired name for the project |
oidcTokenConfig | object | No | — | OpenID Connect JSON Web Token generation configuration. |
outputDirectory | string | No | — | The output directory of the project. When null is used this value will be automatically detected |
previewDeploymentsDisabled | boolean | No | — | Specifies whether preview deployments are disabled for this project. |
previewDeploymentSuffix | string | No | — | Custom domain suffix for preview deployments. Takes precedence over team-level suffix. Must be a domain owned by the team. |
publicSource | boolean | No | — | Specifies whether the source code and logs of the deployments for this project should be public or not |
resourceConfig | object | No | — | Specifies resource override configuration for the project |
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 |
serverlessFunctionRegion | string | No | — | The region to deploy Serverless Functions in this project |
serverlessFunctionZeroConfigFailover | boolean | No | — | Specifies whether Zero Config Failover is enabled for this project. |
skipGitConnectDuringLink | boolean | No | — | Opts-out of the message prompting a CLI user to connect a Git repository in vercel link. |
ssoProtection | object | No | — | The Vercel Auth setting for the project (historically named “SSO Protection”) |
vercel_projects_create_project_env
Create one or more environment variables Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
idOrName | string | Yes | — | The unique project identifier or the project name |
upsert | string | No | — | Allow override of environment variable if it already exists |
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. |
body | any[] | Yes | — | Request body |
vercel_projects_create_project_transfer_request
Create project transfer request Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
idOrName | string | Yes | — | The ID or name of the project to transfer. |
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. |
callbackSecret | string | No | — | The secret to use to sign the webhook payload with HMAC-SHA256. |
callbackUrl | string | No | — | The URL to send a webhook to when the transfer is accepted. |
vercel_projects_create_shared_env_variable
Create one or more shared environment variables Parameters:| Parameter | Type | Required | Default | 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. |
evs | any[] | Yes | — | The evs value |
projectId | any[] | No | — | Associate a Shared Environment Variable to projects. |
target | any[] | No | — | The target environment of the Shared Environment Variable |
type | string | No | — | The type of environment variable |
vercel_projects_delete_project
Delete a Project Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
idOrName | string | Yes | — | The unique project identifier or the project name |
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. |
vercel_projects_delete_shared_env_variable
Delete one or more Env Var Parameters:| Parameter | Type | Required | Default | 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. |
ids | any[] | Yes | — | IDs of the Shared Environment Variables to delete |
vercel_projects_edit_project_env
Edit an environment variable Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
idOrName | string | Yes | — | The unique project identifier or the project name |
id | string | Yes | — | The unique environment variable identifier |
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. |
comment | string | No | — | A comment to add context on what this env var is for |
customEnvironmentIds | any[] | No | — | The custom environments that the environment variable should be synced to |
gitBranch | string | No | — | If defined, the git branch of the environment variable (must have target=preview) |
key | string | No | — | The name of the environment variable |
target | any[] | No | — | The target environment of the environment variable |
type | string | No | — | The type of environment variable |
value | string | No | — | The value of the environment variable |
vercel_projects_filter_project_envs
Retrieve the environment variables of a project by id or name Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
idOrName | string | Yes | — | The unique project identifier or the project name |
gitBranch | string | No | — | If defined, the git branch of the environment variable to filter the results (must have target=preview) |
decrypt | string | No | — | If true, the environment variable value will be decrypted |
source | string | No | — | The source that is calling the endpoint. |
customEnvironmentId | string | No | — | The unique custom environment identifier within the project |
customEnvironmentSlug | string | No | — | The custom environment slug (name) within the project |
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. |
vercel_projects_get_by_id_or_name_custom_environments
Retrieve custom environments Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
idOrName | string | Yes | — | The unique project identifier or the project name |
gitBranch | string | No | — | Fetch custom environments for a specific git branch |
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. |
vercel_projects_get_custom_environment
Retrieve a custom environment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
idOrName | string | Yes | — | The unique project identifier or the project name |
environmentSlugOrId | string | Yes | — | The unique custom environment identifier within the project |
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. |
vercel_projects_get_project
Find a project by id or name Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
idOrName | object | Yes | — | The unique project identifier or the project name |
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. |
vercel_projects_get_project_domain
Get a project domain Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
idOrName | string | Yes | — | The unique project identifier or the project name |
domain | string | Yes | — | The project domain name |
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. |
vercel_projects_get_project_domains
Retrieve project domains by project by id or name Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
idOrName | string | Yes | — | The unique project identifier or the project name |
production | object | No | — | Filters only production domains when set to true. |
target | string | No | — | Filters on the target of the domain. Can be either “production”, “preview” |
customEnvironmentId | string | No | — | The unique custom environment identifier within the project |
gitBranch | string | No | — | Filters domains based on specific branch. |
redirects | object | No | — | Excludes redirect project domains when “false”. Includes redirect project domains when “true” (default). |
redirect | string | No | — | Filters domains based on their redirect target. |
verified | object | No | — | Filters domains based on their verification status. |
limit | number | No | — | Maximum number of domains to list from a request (max 100). |
since | number | No | — | Get domains created after this JavaScript timestamp. |
until | number | No | — | Get domains created before this JavaScript timestamp. |
order | object | No | — | Domains sort order by createdAt |
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. |
vercel_projects_get_project_env
Retrieve the decrypted value of an environment variable of a project by id Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
idOrName | string | Yes | — | The unique project identifier or the project name |
id | string | Yes | — | The unique ID for the environment variable to get the decrypted value. |
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. |
vercel_projects_get_project_members
List project members Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
idOrName | string | Yes | — | The ID or name of the Project. |
limit | integer | No | — | Limit how many project members should be returned |
since | integer | No | — | Timestamp in milliseconds to only include members added since then. |
until | integer | No | — | Timestamp in milliseconds to only include members added until then. |
search | string | No | — | Search project members by their name, username, and email. |
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. |
vercel_projects_get_projects
Retrieve a list of projects Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
from | string | No | — | Query only projects updated after the given timestamp or continuation token. |
gitForkProtection | string | No | — | Specifies whether PRs from Git forks should require a team member’s authorization before it can be deployed |
limit | string | No | — | Limit the number of projects returned |
search | string | No | — | Search projects by the name field |
repo | string | No | — | Filter results by repo. Also used for project count |
repoId | string | No | — | Filter results by Repository ID. |
repoUrl | string | No | — | Filter results by Repository URL. |
excludeRepos | string | No | — | Filter results by excluding those projects that belong to a repo |
edgeConfigId | string | No | — | Filter results by connected Edge Config ID |
edgeConfigTokenId | string | No | — | Filter results by connected Edge Config Token ID |
deprecated | boolean | No | — | The deprecated value |
elasticConcurrencyEnabled | string | No | — | Filter results by projects with elastic concurrency enabled |
staticIpsEnabled | string | No | — | Filter results by projects with Static IPs enabled |
buildMachineTypes | string | No | — | Filter results by build machine types. Accepts comma-separated values. Use “default” for projects without a build machine type set. |
buildQueueConfiguration | string | No | — | Filter results by build queue configuration. SKIP_NAMESPACE_QUEUE includes projects without a configuration set. |
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. |
vercel_projects_get_shared_env_var
Retrieve the decrypted value of a Shared Environment Variable by id. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The unique ID for the Shared Environment Variable to get the decrypted value. |
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. |
vercel_projects_list_promote_aliases
Gets a list of aliases with status for the current promote Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectId | string | Yes | — | Project Id |
limit | number | No | — | Maximum number of aliases to list from a request (max 100). |
since | number | No | — | Get aliases created after this epoch timestamp. |
until | number | No | — | Get aliases created before this epoch timestamp. |
failedOnly | boolean | No | — | Filter results down to aliases that failed to map to the requested deployment |
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. |
vercel_projects_list_shared_env_variable
Lists all Shared Environment Variables for a team Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
search | string | No | — | The search value |
projectId | string | No | — | Filter SharedEnvVariables that belong to a project |
ids | string | No | — | Filter SharedEnvVariables based on comma separated ids |
exclude_ids | string | No | — | Filter SharedEnvVariables based on comma separated ids |
exclude-ids | string | No | — | Filter SharedEnvVariables based on comma separated ids |
exclude_projectId | string | No | — | Filter SharedEnvVariables that belong to a project |
exclude-projectId | string | No | — | Filter SharedEnvVariables that belong to a project |
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. |
vercel_projects_move_project_domain
Move a project domain Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
idOrName | string | Yes | — | The unique project identifier or the project name |
domain | string | Yes | — | The project domain name |
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. |
gitBranch | string | No | — | Git branch to link the project domain |
projectId | string | Yes | — | The unique target project identifier |
redirect | string | No | — | Target destination domain for redirect |
redirectStatusCode | integer | No | — | Status code for domain redirect |
vercel_projects_pause_project
Pause a project Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectId | string | Yes | — | The unique project identifier |
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. |
vercel_projects_remove_custom_environment
Remove a custom environment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
idOrName | string | Yes | — | The unique project identifier or the project name |
environmentSlugOrId | string | Yes | — | The unique custom environment identifier within the project |
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. |
deleteUnassignedEnvironmentVariables | boolean | No | — | Delete Environment Variables that are not assigned to any environments. |
vercel_projects_remove_project_domain
Remove a domain from a project Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
idOrName | string | Yes | — | The unique project identifier or the project name |
domain | string | Yes | — | The project domain name |
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. |
removeRedirects | boolean | No | — | Whether to remove all domains from this project that redirect to the domain being removed. |
vercel_projects_remove_project_env
Remove an environment variable Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
idOrName | string | Yes | — | The unique project identifier or the project name |
id | string | Yes | — | The unique environment variable identifier |
customEnvironmentId | string | No | — | The unique custom environment identifier within the project |
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. |
vercel_projects_remove_project_member
Remove a Project Member Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
idOrName | string | Yes | — | The ID or name of the Project. |
uid | string | Yes | — | The user ID of the member. |
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. |
vercel_projects_request_promote
Points all production domains for a project to the given deploy Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectId | string | Yes | — | Project Id |
deploymentId | string | Yes | — | Deployment Id |
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. |
vercel_projects_request_rollback
Points all production domains for a project to the given deploy Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectId | string | Yes | — | Project Id |
deploymentId | string | Yes | — | The ID of the deployment to rollback to |
description | string | No | — | The reason for the rollback |
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. |
vercel_projects_unlink_shared_env_variable
Disconnects a shared environment variable for a given project Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The unique ID for the Shared Environment Variable to unlink from the project. |
projectId | string | Yes | — | Project Id |
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. |
vercel_projects_unpause_project
Unpause a project Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectId | string | Yes | — | The unique project identifier |
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. |
vercel_projects_update_custom_environment
Update a custom environment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
idOrName | string | Yes | — | The unique project identifier or the project name |
environmentSlugOrId | string | Yes | — | The unique custom environment identifier within the project |
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. |
branchMatcher | object | No | — | How we want to determine a matching branch. This is optional. |
description | string | No | — | Description of the custom environment. This is optional. |
vercel_projects_update_microfrontends
Update the microfrontends settings Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectId | string | Yes | — | The unique project identifier |
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. |
defaultRoute | string | No | — | The default route used for screenshots and preview links for the project |
doNotRouteWithMicrofrontendsRouting | boolean | No | — | Whether domains in this project should route as a microfrontend. Can only be set for child applications. |
enabled | boolean | No | — | Enable or disable microfrontends for the project |
isDefaultApp | boolean | No | — | Whether the application is the default application for the microfrontends group |
microfrontendsGroupId | string | No | — | The unique group identifier to add this microfrontend to |
routeObservabilityToThisProject | boolean | No | — | Whether observability data should be routed to this project or a root project. Can only be set for child applications. |
vercel_projects_update_project
Update an existing project Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
idOrName | string | Yes | — | The unique project identifier or the project name |
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. |
autoAssignCustomDomains | boolean | No | — | Auto Assign Custom Domains |
autoAssignCustomDomainsUpdatedBy | string | No | — | Auto Assign Custom Domains Updated By |
autoExposeSystemEnvs | boolean | No | — | Auto Expose System Envs |
buildCommand | string | No | — | The build command for this project. When null is used this value will be automatically detected |
commandForIgnoringBuildStep | string | No | — | Command For Ignoring Build Step |
connectConfigurations | any[] | No | — | The list of connections from project environment to Secure Compute network |
customerSupportCodeVisibility | boolean | No | — | Specifies whether customer support can see git source for a deployment |
devCommand | string | No | — | The dev command for this project. When null is used this value will be automatically detected |
directoryListing | boolean | No | — | Directory Listing |
dismissedToasts | any[] | No | — | 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.` |
enableAffectedProjectsDeployments | boolean | No | — | Opt-in to skip deployments when there are no changes to the root directory and its dependencies |
enableExternalRewriteCaching | boolean | No | — | Specifies whether external rewrite caching is enabled for this project. |
enablePreviewFeedback | boolean | No | — | Opt-in to preview toolbar on the project level |
enableProductionFeedback | boolean | No | — | Opt-in to production toolbar on the project level |
framework | string | No | — | The framework that is being used for this project. When null is used no framework is selected |
gitForkProtection | boolean | No | — | Specifies whether PRs from Git forks should require a team member’s authorization before it can be deployed |
gitLFS | boolean | No | — | Specifies whether Git LFS is enabled for this project. |
installCommand | string | No | — | The install command for this project. When null is used this value will be automatically detected |
name | string | No | — | The desired name for the project |
nodeVersion | string | No | — | Node Version |
oidcTokenConfig | object | No | — | OpenID Connect JSON Web Token generation configuration. |
optionsAllowlist | object | No | — | Specify a list of paths that should not be protected by Deployment Protection to enable Cors preflight requests |
outputDirectory | string | No | — | The output directory of the project. When null is used this value will be automatically detected |
passwordProtection | object | No | — | Allows to protect project deployments with a password |
previewDeploymentsDisabled | boolean | No | — | Specifies whether preview deployments are disabled for this project. |
previewDeploymentSuffix | string | No | — | Custom domain suffix for preview deployments. Takes precedence over team-level suffix. Must be a domain owned by the team. |
protectedSourcemaps | boolean | No | — | Specifies whether sourcemaps are protected and require authentication to access. |
publicSource | boolean | No | — | Specifies whether the source code and logs of the deployments for this project should be public or not |
resourceConfig | object | No | — | Specifies resource override configuration for the project |
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 |
serverlessFunctionRegion | string | No | — | The region to deploy Serverless Functions in this project |
serverlessFunctionZeroConfigFailover | boolean | No | — | Specifies whether Zero Config Failover is enabled for this project. |
skewProtectionAllowedDomains | any[] | No | — | Cross-site domains allowed to fetch skew-protected assets (hostnames, optionally with leading wildcard like *.example.com). |
skewProtectionBoundaryAt | integer | No | — | Deployments created before this absolute datetime have Skew Protection disabled. Value is in milliseconds since epoch to match “createdAt” fields. |
skewProtectionMaxAge | integer | No | — | Deployments created before this rolling window have Skew Protection disabled. Value is in seconds to match “revalidate” fields. |
skipGitConnectDuringLink | boolean | No | — | Opts-out of the message prompting a CLI user to connect a Git repository in vercel link. |
sourceFilesOutsideRootDirectory | boolean | No | — | Indicates if there are source files outside of the root directory |
ssoProtection | object | No | — | Ensures visitors to your Preview Deployments are logged into Vercel and have a minimum of Viewer access on your team |
staticIps | object | No | — | Manage Static IPs for this project |
tracing | object | No | — | Tracing configuration for this project |
trustedIps | object | No | — | Restricts access to deployments based on the incoming request IP address |
vercel_projects_update_project_domain
Update a project domain Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
idOrName | string | Yes | — | The unique project identifier or the project name |
domain | string | Yes | — | The project domain name |
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. |
gitBranch | string | No | — | Git branch to link the project domain |
redirect | string | No | — | Target destination domain for redirect |
redirectStatusCode | integer | No | — | Status code for domain redirect |
vercel_projects_update_project_protection_bypass
Update Protection Bypass for Automation Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
idOrName | string | Yes | — | The unique project identifier or the project name |
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. |
generate | object | No | — | Generate a new secret. If neither generate or revoke are provided, a new random secret will be generated. |
revoke | object | No | — | Optional instructions for revoking and regenerating a automation bypass |
update | object | No | — | Update an existing bypass |
vercel_projects_update_projects_by_project_id_rollback_by_deployment_id_update_description
Updates the description for a rollback Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectId | string | Yes | — | Project Id |
deploymentId | string | Yes | — | Deployment Id |
description | string | No | — | The reason for the rollback |
vercel_projects_update_shared_env_variable
Updates one or more shared environment variables Parameters:| Parameter | Type | Required | Default | 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. |
updates | object | Yes | — | An object where each key is an environment variable ID (not the key name) and the value is the update to apply |
vercel_projects_verify_project_domain
Verify project domain Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
idOrName | string | Yes | — | The unique project identifier or the project name |
domain | string | Yes | — | The domain name you want to verify |
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. |

