/vercel-deployments | Type: Application | PCID required: Yes
Tools
vercel_deployments_approve_rolling_release_stage
Update the active rolling release to the next stage for a project Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
idOrName | string | Yes | — | Project ID or project name (URL-encoded) |
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. |
canaryDeploymentId | string | Yes | — | The id of the canary deployment to approve for the next stage |
nextStageIndex | number | Yes | — | The index of the stage to transition to |
vercel_deployments_cancel_deployment
Cancel a deployment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The unique identifier of the 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_deployments_complete_rolling_release
Complete the rolling release for the project Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
idOrName | string | Yes | — | Project ID or project name (URL-encoded) |
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. |
canaryDeploymentId | string | Yes | — | The ID of the canary deployment to complete |
vercel_deployments_create_deployment
Create a new deployment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
forceNew | object | No | — | Forces a new deployment even if there is a previous similar deployment |
skipAutoDetectionConfirmation | object | No | — | Allows to skip framework detection so the API would not fail to ask for confirmation |
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. |
customEnvironmentSlugOrId | string | No | — | Deploy to a custom environment, which will override the default environment |
deploymentId | string | No | — | An deployment id for an existing deployment to redeploy |
files | any[] | No | — | A list of objects with the files to be deployed |
gitMetadata | object | No | — | Populates initial git metadata for different git providers. |
gitSource | object | No | — | Defines the Git Repository source to be deployed. This property can not be used in combination with files. |
meta | object | No | — | An object containing the deployment’s metadata. Multiple key-value pairs can be attached to a deployment |
monorepoManager | string | No | — | The monorepo manager that is being used for this deployment. When null is used no monorepo manager is selected |
name | string | Yes | — | A string with the project name used in the deployment URL |
project | string | No | — | The target project identifier in which the deployment will be created. When defined, this parameter overrides name |
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 |
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. |
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. |
vercel_deployments_create_deployment_check_run
Create a check run Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
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. |
checkId | string | Yes | — | Check Id |
vercel_deployments_create_project_check
Create a check Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectIdOrName | string | Yes | — | Project Id Or 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. |
blocks | string | No | — | The blocks value |
isRerequestable | boolean | No | — | Is Rerequestable |
name | string | Yes | — | The name value |
requires | string | Yes | — | The requires value |
source | object | No | — | The source value |
targets | any[] | No | — | The targets value |
timeout | number | No | — | The timeout value |
vercel_deployments_delete_deployment
Delete a Deployment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The ID of the deployment to be deleted |
url | string | No | — | A Deployment or Alias URL. In case it is passed, the ID will be ignored |
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_deployments_delete_project_check
Delete a check Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectIdOrName | string | Yes | — | Project Id Or Name |
checkId | string | Yes | — | Check 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_deployments_delete_rolling_release_config
Delete rolling release configuration Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
idOrName | string | Yes | — | Project ID or project name (URL-encoded) |
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_deployments_get_deployment
Get a deployment by ID or URL Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
idOrUrl | string | Yes | — | The unique identifier or hostname of the deployment. |
withGitRepoInfo | string | No | — | Whether to add in gitRepo information. |
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_deployments_get_deployment_check_run
Get a check run Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
deploymentId | string | Yes | — | Deployment Id |
checkRunId | string | Yes | — | The ID of the resource that will be updated. |
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_deployments_get_deployment_events
Get deployment events Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
idOrUrl | string | Yes | — | The unique identifier or hostname of the deployment. |
direction | string | No | — | Order of the returned events based on the timestamp. |
follow | number | No | — | When enabled, this endpoint will return live events as they happen. |
limit | number | No | — | Maximum number of events to return. Provide -1 to return all available logs. |
name | string | No | — | Deployment build ID. |
since | number | No | — | Timestamp for when build logs should be pulled from. |
until | number | No | — | Timestamp for when the build logs should be pulled up until. |
statusCode | object | No | — | HTTP status code range to filter events by. |
delimiter | number | No | — | The delimiter value |
builds | number | No | — | The builds 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_deployments_get_deployment_file_contents
Get Deployment File Contents Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The unique deployment identifier |
fileId | string | Yes | — | The unique file identifier |
path | string | No | — | Path to the file to fetch (only for Git deployments) |
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_deployments_get_deployments
List deployments Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
app | string | No | — | Name of the deployment. |
from | number | No | — | Gets the deployment created after this Date timestamp. (default: current time) |
limit | number | No | — | Maximum number of deployments to list from a request. |
projectId | string | No | — | Filter deployments from the given ID or name. |
projectIds | any[] | No | — | Filter deployments from the given project IDs. Cannot be used when projectId is specified. |
target | string | No | — | Filter deployments based on the environment. |
to | number | No | — | Gets the deployment created before this Date timestamp. (default: current time) |
users | string | No | — | Filter out deployments based on users who have created the deployment. |
since | number | No | — | Get Deployments created after this JavaScript timestamp. |
until | number | No | — | Get Deployments created before this JavaScript timestamp. |
state | string | No | — | Filter deployments based on their state (BUILDING, ERROR, INITIALIZING, QUEUED, READY, CANCELED) |
rollbackCandidate | boolean | No | — | Filter deployments based on their rollback candidacy |
branch | string | No | — | Filter deployments based on the branch name |
sha | string | No | — | Filter deployments based on the SHA |
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_deployments_get_project_check
Get a check Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectIdOrName | string | Yes | — | Project Id Or Name |
checkId | string | Yes | — | The ID of the resource that will be updated. |
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_deployments_get_rolling_release
Get the active rolling release information for a project Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
idOrName | string | Yes | — | Project ID or project name (URL-encoded) |
state | string | No | — | Filter by rolling release state |
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_deployments_get_rolling_release_billing_status
Get rolling release billing status Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
idOrName | string | Yes | — | Project ID or project name (URL-encoded) |
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_deployments_get_rolling_release_config
Get rolling release configuration Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
idOrName | string | Yes | — | Project ID or project name (URL-encoded) |
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_deployments_list_check_runs
List runs for a check Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectIdOrName | string | Yes | — | Project Id Or Name |
checkId | string | Yes | — | The ID of the resource that will be updated. |
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_deployments_list_deployment_check_runs
List check runs for a deployment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
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_deployments_list_deployment_files
List Deployment Files Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The unique deployment 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_deployments_list_project_checks
List all checks for a project Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectIdOrName | string | Yes | — | Project Id Or Name |
blocks | string | No | — | The blocks 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_deployments_update_deployment_check_run
Update a check run Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
deploymentId | string | Yes | — | Deployment Id |
checkRunId | string | Yes | — | Check Run 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. |
completedAt | number | No | — | Completed At |
conclusion | string | No | — | The conclusion value |
conclusionText | string | No | — | Conclusion Text |
externalId | string | No | — | External Id |
externalUrl | string | No | — | External Url |
output | object | No | — | The output value |
status | string | No | — | The status value |
vercel_deployments_update_integration_deployment_action
Update deployment integration action Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
deploymentId | string | Yes | — | Deployment Id |
integrationConfigurationId | string | Yes | — | Integration Configuration Id |
resourceId | string | Yes | — | Resource Id |
action | string | Yes | — | The action value |
outcomes | any[] | No | — | The outcomes value |
status | string | No | — | The status value |
statusText | string | No | — | Status Text |
statusUrl | string | No | — | Status Url |
vercel_deployments_update_project_check
Update a check Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectIdOrName | string | Yes | — | Project Id Or Name |
checkId | string | Yes | — | Check 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. |
blocks | string | No | — | The blocks value |
isRerequestable | boolean | No | — | Is Rerequestable |
name | string | No | — | The name value |
requires | string | No | — | The requires value |
targets | any[] | No | — | The targets value |
timeout | number | No | — | The timeout value |
vercel_deployments_update_rolling_release_config
Update the rolling release settings for the project Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
idOrName | string | Yes | — | Project ID or project name (URL-encoded) |
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_deployments_upload_file
Upload Deployment Files 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. |
body | string | No | — | Request body |

