> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt
> Use this file to discover all available pages before exploring further.
# vercel-deployments
> Vercel Deployments - manage deployments, checks, and rolling releases
**Server path:** `/vercel-deployments` | **Type:** Application | **PCID required:** Yes
## Tools
| Tool | Description |
| --------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------- |
| [`vercel_deployments_approve_rolling_release_stage`](#vercel_deployments_approve_rolling_release_stage) | Update the active rolling release to the next stage for a project |
| [`vercel_deployments_cancel_deployment`](#vercel_deployments_cancel_deployment) | Cancel a deployment |
| [`vercel_deployments_complete_rolling_release`](#vercel_deployments_complete_rolling_release) | Complete the rolling release for the project |
| [`vercel_deployments_create_deployment`](#vercel_deployments_create_deployment) | Create a new deployment |
| [`vercel_deployments_create_deployment_check_run`](#vercel_deployments_create_deployment_check_run) | Create a check run |
| [`vercel_deployments_create_project_check`](#vercel_deployments_create_project_check) | Create a check |
| [`vercel_deployments_delete_deployment`](#vercel_deployments_delete_deployment) | Delete a Deployment |
| [`vercel_deployments_delete_project_check`](#vercel_deployments_delete_project_check) | Delete a check |
| [`vercel_deployments_delete_rolling_release_config`](#vercel_deployments_delete_rolling_release_config) | Delete rolling release configuration |
| [`vercel_deployments_get_deployment`](#vercel_deployments_get_deployment) | Get a deployment by ID or URL |
| [`vercel_deployments_get_deployment_check_run`](#vercel_deployments_get_deployment_check_run) | Get a check run |
| [`vercel_deployments_get_deployment_events`](#vercel_deployments_get_deployment_events) | Get deployment events |
| [`vercel_deployments_get_deployment_file_contents`](#vercel_deployments_get_deployment_file_contents) | Get Deployment File Contents |
| [`vercel_deployments_get_deployments`](#vercel_deployments_get_deployments) | List deployments |
| [`vercel_deployments_get_project_check`](#vercel_deployments_get_project_check) | Get a check |
| [`vercel_deployments_get_rolling_release`](#vercel_deployments_get_rolling_release) | Get the active rolling release information for a project |
| [`vercel_deployments_get_rolling_release_billing_status`](#vercel_deployments_get_rolling_release_billing_status) | Get rolling release billing status |
| [`vercel_deployments_get_rolling_release_config`](#vercel_deployments_get_rolling_release_config) | Get rolling release configuration |
| [`vercel_deployments_list_check_runs`](#vercel_deployments_list_check_runs) | List runs for a check |
| [`vercel_deployments_list_deployment_check_runs`](#vercel_deployments_list_deployment_check_runs) | List check runs for a deployment |
| [`vercel_deployments_list_deployment_files`](#vercel_deployments_list_deployment_files) | List Deployment Files |
| [`vercel_deployments_list_project_checks`](#vercel_deployments_list_project_checks) | List all checks for a project |
| [`vercel_deployments_update_deployment_check_run`](#vercel_deployments_update_deployment_check_run) | Update a check run |
| [`vercel_deployments_update_integration_deployment_action`](#vercel_deployments_update_integration_deployment_action) | Update deployment integration action |
| [`vercel_deployments_update_project_check`](#vercel_deployments_update_project_check) | Update a check |
| [`vercel_deployments_update_rolling_release_config`](#vercel_deployments_update_rolling_release_config) | Update the rolling release settings for the project |
| [`vercel_deployments_upload_file`](#vercel_deployments_upload_file) | Upload Deployment Files |
***
## 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 |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"idOrName": {
"type": "string",
"description": "Project ID or project name (URL-encoded)"
},
"teamId": {
"type": "string",
"description": "The Team identifier to perform the request on behalf of."
},
"slug": {
"type": "string",
"description": "The Team slug to perform the request on behalf of."
},
"canaryDeploymentId": {
"type": "string",
"description": "The id of the canary deployment to approve for the next stage"
},
"nextStageIndex": {
"type": "number",
"description": "The index of the stage to transition to"
}
},
"required": [
"PCID",
"idOrName",
"canaryDeploymentId",
"nextStageIndex"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "The unique identifier of the deployment."
},
"teamId": {
"type": "string",
"description": "The Team identifier to perform the request on behalf of."
},
"slug": {
"type": "string",
"description": "The Team slug to perform the request on behalf of."
}
},
"required": [
"PCID",
"id"
]
}
```
***
## 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 |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"idOrName": {
"type": "string",
"description": "Project ID or project name (URL-encoded)"
},
"teamId": {
"type": "string",
"description": "The Team identifier to perform the request on behalf of."
},
"slug": {
"type": "string",
"description": "The Team slug to perform the request on behalf of."
},
"canaryDeploymentId": {
"type": "string",
"description": "The ID of the canary deployment to complete"
}
},
"required": [
"PCID",
"idOrName",
"canaryDeploymentId"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"forceNew": {
"description": "Forces a new deployment even if there is a previous similar deployment",
"enum": [
"0",
"1"
]
},
"skipAutoDetectionConfirmation": {
"description": "Allows to skip framework detection so the API would not fail to ask for confirmation",
"enum": [
"0",
"1"
]
},
"teamId": {
"type": "string",
"description": "The Team identifier to perform the request on behalf of."
},
"slug": {
"type": "string",
"description": "The Team slug to perform the request on behalf of."
},
"customEnvironmentSlugOrId": {
"type": "string",
"description": "Deploy to a custom environment, which will override the default environment"
},
"deploymentId": {
"type": "string",
"description": "An deployment id for an existing deployment to redeploy"
},
"files": {
"type": "array",
"description": "A list of objects with the files to be deployed"
},
"gitMetadata": {
"type": "object",
"description": "Populates initial git metadata for different git providers.",
"properties": {
"remoteUrl": {
"type": "string",
"description": "The git repository's remote origin url"
},
"commitAuthorName": {
"type": "string",
"description": "The name of the author of the commit"
},
"commitAuthorEmail": {
"type": "string",
"description": "The email of the author of the commit"
},
"commitMessage": {
"type": "string",
"description": "The commit message"
},
"commitRef": {
"type": "string",
"description": "The branch on which the commit was made"
},
"commitSha": {
"type": "string",
"description": "The hash of the commit"
},
"dirty": {
"type": "boolean",
"description": "Whether or not there have been modifications to the working tree since the latest commit"
},
"ci": {
"type": "boolean",
"description": "True if process.env.CI was set when deploying"
},
"ciType": {
"type": "string",
"description": "The type of CI system used"
},
"ciGitProviderUsername": {
"type": "string",
"description": "The username used for the Git Provider (e.g. GitHub) if their CI (e.g. GitHub Actions) was used, if available"
},
"ciGitRepoVisibility": {
"type": "string",
"description": "The visibility of the Git repository if their CI (e.g. GitHub Actions) was used, if available"
}
}
},
"gitSource": {
"description": "Defines the Git Repository source to be deployed. This property can not be used in combination with `files`."
},
"meta": {
"type": "object",
"description": "An object containing the deployment's metadata. Multiple key-value pairs can be attached to a deployment"
},
"monorepoManager": {
"type": "string",
"description": "The monorepo manager that is being used for this deployment. When `null` is used no monorepo manager is selected"
},
"name": {
"type": "string",
"description": "A string with the project name used in the deployment URL"
},
"project": {
"type": "string",
"description": "The target project identifier in which the deployment will be created. When defined, this parameter overrides name"
},
"projectSettings": {
"type": "object",
"description": "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",
"properties": {
"buildCommand": {
"type": "string",
"description": "The build command for this project. When `null` is used this value will be automatically detected"
},
"commandForIgnoringBuildStep": {
"type": "string",
"description": "Command For Ignoring Build Step"
},
"devCommand": {
"type": "string",
"description": "The dev command for this project. When `null` is used this value will be automatically detected"
},
"framework": {
"type": "string",
"description": "The framework that is being used for this project. When `null` is used no framework is selected",
"enum": [
"blitzjs",
"nextjs",
"gatsby",
"remix",
"react-router",
"astro",
"hexo",
"eleventy",
"docusaurus-2",
"docusaurus",
"preact",
"solidstart-1",
"solidstart",
"dojo",
"ember",
"vue",
"scully",
"ionic-angular",
"angular",
"polymer",
"svelte",
"sveltekit",
"sveltekit-1",
"ionic-react",
"create-react-app",
"gridsome",
"umijs",
"sapper",
"saber",
"stencil",
"nuxtjs",
"redwoodjs",
"hugo",
"jekyll",
"brunch",
"middleman",
"zola",
"hydrogen",
"vite",
"tanstack-start",
"vitepress",
"vuepress",
"parcel",
"fastapi",
"flask",
"fasthtml",
"django",
"sanity-v3",
"sanity",
"storybook",
"nitro",
"hono",
"express",
"h3",
"koa",
"nestjs",
"elysia",
"fastify",
"xmcp",
"python",
"ruby",
"rust",
"node",
"go",
"services"
]
},
"installCommand": {
"type": "string",
"description": "The install command for this project. When `null` is used this value will be automatically detected"
},
"nodeVersion": {
"type": "string",
"description": "Override the Node.js version that should be used for this deployment",
"enum": [
"24.x",
"22.x",
"20.x",
"18.x",
"16.x",
"14.x",
"12.x",
"10.x",
"8.10.x"
]
},
"outputDirectory": {
"type": "string",
"description": "The output directory of the project. When `null` is used this value will be automatically detected"
},
"rootDirectory": {
"type": "string",
"description": "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": {
"type": "string",
"description": "The region to deploy Serverless Functions in this project"
},
"skipGitConnectDuringLink": {
"type": "boolean",
"description": "Opts-out of the message prompting a CLI user to connect a Git repository in `vercel link`."
},
"sourceFilesOutsideRootDirectory": {
"type": "boolean",
"description": "Indicates if there are source files outside of the root directory, typically used for monorepos"
}
}
},
"target": {
"type": "string",
"description": "Either not defined, `staging`, `production`, or a custom environment identifier. If `staging`, a staging alias in the format `-.vercel.app` will be assigned. If `production`, any aliases defined in `alias` will be assigned. If omitted, the target will be `preview`."
},
"withLatestCommit": {
"type": "boolean",
"description": "When `true` and `deploymentId` is passed in, the sha from the previous deployment's `gitSource` is removed forcing the latest commit to be used."
}
},
"required": [
"PCID",
"name"
]
}
```
***
## 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 |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"deploymentId": {
"type": "string",
"description": "Deployment Id"
},
"teamId": {
"type": "string",
"description": "The Team identifier to perform the request on behalf of."
},
"slug": {
"type": "string",
"description": "The Team slug to perform the request on behalf of."
},
"checkId": {
"type": "string",
"description": "Check Id"
}
},
"required": [
"PCID",
"deploymentId",
"checkId"
]
}
```
***
## 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` | string\[] | No | — | The targets value |
| `timeout` | number | No | — | The timeout value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectIdOrName": {
"type": "string",
"description": "Project Id Or Name"
},
"teamId": {
"type": "string",
"description": "The Team identifier to perform the request on behalf of."
},
"slug": {
"type": "string",
"description": "The Team slug to perform the request on behalf of."
},
"blocks": {
"type": "string",
"description": "The blocks value",
"enum": [
"build-start",
"deployment-start",
"deployment-alias",
"deployment-promotion",
"none"
]
},
"isRerequestable": {
"type": "boolean",
"description": "Is Rerequestable"
},
"name": {
"type": "string",
"description": "The name value"
},
"requires": {
"type": "string",
"description": "The requires value",
"enum": [
"build-ready",
"deployment-url",
"none"
]
},
"source": {
"type": "object",
"description": "The source value"
},
"targets": {
"type": "array",
"items": {
"type": "string"
},
"description": "The targets value"
},
"timeout": {
"type": "number",
"description": "The timeout value"
}
},
"required": [
"PCID",
"projectIdOrName",
"name",
"requires"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "The ID of the deployment to be deleted"
},
"url": {
"type": "string",
"description": "A Deployment or Alias URL. In case it is passed, the ID will be ignored"
},
"teamId": {
"type": "string",
"description": "The Team identifier to perform the request on behalf of."
},
"slug": {
"type": "string",
"description": "The Team slug to perform the request on behalf of."
}
},
"required": [
"PCID",
"id"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectIdOrName": {
"type": "string",
"description": "Project Id Or Name"
},
"checkId": {
"type": "string",
"description": "Check Id"
},
"teamId": {
"type": "string",
"description": "The Team identifier to perform the request on behalf of."
},
"slug": {
"type": "string",
"description": "The Team slug to perform the request on behalf of."
}
},
"required": [
"PCID",
"projectIdOrName",
"checkId"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"idOrName": {
"type": "string",
"description": "Project ID or project name (URL-encoded)"
},
"teamId": {
"type": "string",
"description": "The Team identifier to perform the request on behalf of."
},
"slug": {
"type": "string",
"description": "The Team slug to perform the request on behalf of."
}
},
"required": [
"PCID",
"idOrName"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"idOrUrl": {
"type": "string",
"description": "The unique identifier or hostname of the deployment."
},
"withGitRepoInfo": {
"type": "string",
"description": "Whether to add in gitRepo information."
},
"teamId": {
"type": "string",
"description": "The Team identifier to perform the request on behalf of."
},
"slug": {
"type": "string",
"description": "The Team slug to perform the request on behalf of."
}
},
"required": [
"PCID",
"idOrUrl"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"deploymentId": {
"type": "string",
"description": "Deployment Id"
},
"checkRunId": {
"type": "string",
"description": "The ID of the resource that will be updated."
},
"teamId": {
"type": "string",
"description": "The Team identifier to perform the request on behalf of."
},
"slug": {
"type": "string",
"description": "The Team slug to perform the request on behalf of."
}
},
"required": [
"PCID",
"deploymentId",
"checkRunId"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"idOrUrl": {
"type": "string",
"description": "The unique identifier or hostname of the deployment."
},
"direction": {
"type": "string",
"description": "Order of the returned events based on the timestamp.",
"enum": [
"backward",
"forward"
]
},
"follow": {
"type": "number",
"description": "When enabled, this endpoint will return live events as they happen.",
"enum": [
0,
1
]
},
"limit": {
"type": "number",
"description": "Maximum number of events to return. Provide `-1` to return all available logs."
},
"name": {
"type": "string",
"description": "Deployment build ID."
},
"since": {
"type": "number",
"description": "Timestamp for when build logs should be pulled from."
},
"until": {
"type": "number",
"description": "Timestamp for when the build logs should be pulled up until."
},
"statusCode": {
"description": "HTTP status code range to filter events by."
},
"delimiter": {
"type": "number",
"description": "The delimiter value",
"enum": [
0,
1
]
},
"builds": {
"type": "number",
"description": "The builds value",
"enum": [
0,
1
]
},
"teamId": {
"type": "string",
"description": "The Team identifier to perform the request on behalf of."
},
"slug": {
"type": "string",
"description": "The Team slug to perform the request on behalf of."
}
},
"required": [
"PCID",
"idOrUrl"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "The unique deployment identifier"
},
"fileId": {
"type": "string",
"description": "The unique file identifier"
},
"path": {
"type": "string",
"description": "Path to the file to fetch (only for Git deployments)"
},
"teamId": {
"type": "string",
"description": "The Team identifier to perform the request on behalf of."
},
"slug": {
"type": "string",
"description": "The Team slug to perform the request on behalf of."
}
},
"required": [
"PCID",
"id",
"fileId"
]
}
```
***
## 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` | string\[] | 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"app": {
"type": "string",
"description": "Name of the deployment."
},
"from": {
"type": "number",
"description": "Gets the deployment created after this Date timestamp. (default: current time)"
},
"limit": {
"type": "number",
"description": "Maximum number of deployments to list from a request."
},
"projectId": {
"type": "string",
"description": "Filter deployments from the given ID or name."
},
"projectIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "Filter deployments from the given project IDs. Cannot be used when projectId is specified."
},
"target": {
"type": "string",
"description": "Filter deployments based on the environment."
},
"to": {
"type": "number",
"description": "Gets the deployment created before this Date timestamp. (default: current time)"
},
"users": {
"type": "string",
"description": "Filter out deployments based on users who have created the deployment."
},
"since": {
"type": "number",
"description": "Get Deployments created after this JavaScript timestamp."
},
"until": {
"type": "number",
"description": "Get Deployments created before this JavaScript timestamp."
},
"state": {
"type": "string",
"description": "Filter deployments based on their state (`BUILDING`, `ERROR`, `INITIALIZING`, `QUEUED`, `READY`, `CANCELED`)"
},
"rollbackCandidate": {
"type": "boolean",
"description": "Filter deployments based on their rollback candidacy"
},
"branch": {
"type": "string",
"description": "Filter deployments based on the branch name"
},
"sha": {
"type": "string",
"description": "Filter deployments based on the SHA"
},
"teamId": {
"type": "string",
"description": "The Team identifier to perform the request on behalf of."
},
"slug": {
"type": "string",
"description": "The Team slug to perform the request on behalf of."
}
},
"required": [
"PCID"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectIdOrName": {
"type": "string",
"description": "Project Id Or Name"
},
"checkId": {
"type": "string",
"description": "The ID of the resource that will be updated."
},
"teamId": {
"type": "string",
"description": "The Team identifier to perform the request on behalf of."
},
"slug": {
"type": "string",
"description": "The Team slug to perform the request on behalf of."
}
},
"required": [
"PCID",
"projectIdOrName",
"checkId"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"idOrName": {
"type": "string",
"description": "Project ID or project name (URL-encoded)"
},
"state": {
"type": "string",
"description": "Filter by rolling release state",
"enum": [
"ACTIVE",
"COMPLETE",
"ABORTED"
]
},
"teamId": {
"type": "string",
"description": "The Team identifier to perform the request on behalf of."
},
"slug": {
"type": "string",
"description": "The Team slug to perform the request on behalf of."
}
},
"required": [
"PCID",
"idOrName"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"idOrName": {
"type": "string",
"description": "Project ID or project name (URL-encoded)"
},
"teamId": {
"type": "string",
"description": "The Team identifier to perform the request on behalf of."
},
"slug": {
"type": "string",
"description": "The Team slug to perform the request on behalf of."
}
},
"required": [
"PCID",
"idOrName"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"idOrName": {
"type": "string",
"description": "Project ID or project name (URL-encoded)"
},
"teamId": {
"type": "string",
"description": "The Team identifier to perform the request on behalf of."
},
"slug": {
"type": "string",
"description": "The Team slug to perform the request on behalf of."
}
},
"required": [
"PCID",
"idOrName"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectIdOrName": {
"type": "string",
"description": "Project Id Or Name"
},
"checkId": {
"type": "string",
"description": "The ID of the resource that will be updated."
},
"teamId": {
"type": "string",
"description": "The Team identifier to perform the request on behalf of."
},
"slug": {
"type": "string",
"description": "The Team slug to perform the request on behalf of."
}
},
"required": [
"PCID",
"projectIdOrName",
"checkId"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"deploymentId": {
"type": "string",
"description": "Deployment Id"
},
"teamId": {
"type": "string",
"description": "The Team identifier to perform the request on behalf of."
},
"slug": {
"type": "string",
"description": "The Team slug to perform the request on behalf of."
}
},
"required": [
"PCID",
"deploymentId"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "The unique deployment identifier"
},
"teamId": {
"type": "string",
"description": "The Team identifier to perform the request on behalf of."
},
"slug": {
"type": "string",
"description": "The Team slug to perform the request on behalf of."
}
},
"required": [
"PCID",
"id"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectIdOrName": {
"type": "string",
"description": "Project Id Or Name"
},
"blocks": {
"type": "string",
"description": "The blocks value",
"enum": [
"build-start",
"deployment-start",
"deployment-alias",
"deployment-promotion",
"none"
]
},
"teamId": {
"type": "string",
"description": "The Team identifier to perform the request on behalf of."
},
"slug": {
"type": "string",
"description": "The Team slug to perform the request on behalf of."
}
},
"required": [
"PCID",
"projectIdOrName"
]
}
```
***
## 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 |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"deploymentId": {
"type": "string",
"description": "Deployment Id"
},
"checkRunId": {
"type": "string",
"description": "Check Run Id"
},
"teamId": {
"type": "string",
"description": "The Team identifier to perform the request on behalf of."
},
"slug": {
"type": "string",
"description": "The Team slug to perform the request on behalf of."
},
"completedAt": {
"type": "number",
"description": "Completed At"
},
"conclusion": {
"type": "string",
"description": "The conclusion value",
"enum": [
"canceled",
"skipped",
"timeout",
"failed",
"neutral",
"succeeded"
]
},
"conclusionText": {
"type": "string",
"description": "Conclusion Text"
},
"externalId": {
"type": "string",
"description": "External Id"
},
"externalUrl": {
"type": "string",
"description": "External Url"
},
"output": {
"type": "object",
"description": "The output value"
},
"status": {
"type": "string",
"description": "The status value",
"enum": [
"queued",
"running",
"completed"
]
}
},
"required": [
"PCID",
"deploymentId",
"checkRunId"
]
}
```
***
## 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` | object\[] | No | — | The outcomes value |
| `status` | string | No | — | The status value |
| `statusText` | string | No | — | Status Text |
| `statusUrl` | string | No | — | Status Url |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"deploymentId": {
"type": "string",
"description": "Deployment Id"
},
"integrationConfigurationId": {
"type": "string",
"description": "Integration Configuration Id"
},
"resourceId": {
"type": "string",
"description": "Resource Id"
},
"action": {
"type": "string",
"description": "The action value"
},
"outcomes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "The kind value"
},
"secrets": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
}
},
"description": "The secrets value"
}
},
"required": [
"kind",
"secrets"
]
},
"description": "The outcomes value"
},
"status": {
"type": "string",
"description": "The status value",
"enum": [
"running",
"succeeded",
"failed"
]
},
"statusText": {
"type": "string",
"description": "Status Text"
},
"statusUrl": {
"type": "string",
"description": "Status Url"
}
},
"required": [
"PCID",
"deploymentId",
"integrationConfigurationId",
"resourceId",
"action"
]
}
```
***
## 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` | string\[] | No | — | The targets value |
| `timeout` | number | No | — | The timeout value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectIdOrName": {
"type": "string",
"description": "Project Id Or Name"
},
"checkId": {
"type": "string",
"description": "Check Id"
},
"teamId": {
"type": "string",
"description": "The Team identifier to perform the request on behalf of."
},
"slug": {
"type": "string",
"description": "The Team slug to perform the request on behalf of."
},
"blocks": {
"type": "string",
"description": "The blocks value",
"enum": [
"build-start",
"deployment-start",
"deployment-alias",
"deployment-promotion",
"none"
]
},
"isRerequestable": {
"type": "boolean",
"description": "Is Rerequestable"
},
"name": {
"type": "string",
"description": "The name value"
},
"requires": {
"type": "string",
"description": "The requires value",
"enum": [
"build-ready",
"deployment-url"
]
},
"targets": {
"type": "array",
"items": {
"type": "string"
},
"description": "The targets value"
},
"timeout": {
"type": "number",
"description": "The timeout value"
}
},
"required": [
"PCID",
"projectIdOrName",
"checkId"
]
}
```
***
## 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. |
| `rollingRelease` | object | Yes | — | The rolling release configuration to apply. Set to null to disable rolling releases. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"idOrName": {
"type": "string",
"description": "Project ID or project name (URL-encoded)"
},
"teamId": {
"type": "string",
"description": "The Team identifier to perform the request on behalf of."
},
"slug": {
"type": "string",
"description": "The Team slug to perform the request on behalf of."
},
"rollingRelease": {
"type": "object",
"description": "The rolling release configuration to apply. Set to null to disable rolling releases.",
"properties": {
"target": {
"type": "string",
"description": "The environment that the release targets, currently only supports production. Adding in case we want to configure with alias groups or custom environments."
},
"stages": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of all the stages required during a deployment release. Each stage defines a target percentage and advancement rules. The final stage must always have targetPercentage: 100."
},
"canaryResponseHeader": {
"type": "boolean",
"description": "Whether the request served by a canary deployment should return a header indicating a canary was served. Defaults to `false` when omitted.",
"enum": [
false,
true
]
}
}
}
},
"required": [
"PCID",
"idOrName",
"rollingRelease"
]
}
```
***
## vercel\_deployments\_upload\_file
Upload Deployment Files
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | ------ | -------- | ------- | -------------------------------------------------------- |
| `Content-Length` | number | No | — | The file size in bytes |
| `x-vercel-digest` | string | No | — | The file SHA1 used to check the integrity |
| `x-now-digest` | string | No | — | The file SHA1 used to check the integrity |
| `x-now-size` | number | No | — | The file size as an alternative to `Content-Length` |
| `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 |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Content-Length": {
"type": "number",
"description": "The file size in bytes"
},
"x-vercel-digest": {
"type": "string",
"description": "The file SHA1 used to check the integrity"
},
"x-now-digest": {
"type": "string",
"description": "The file SHA1 used to check the integrity"
},
"x-now-size": {
"type": "number",
"description": "The file size as an alternative to `Content-Length`"
},
"teamId": {
"type": "string",
"description": "The Team identifier to perform the request on behalf of."
},
"slug": {
"type": "string",
"description": "The Team slug to perform the request on behalf of."
},
"body": {
"type": "string",
"description": "Request body"
}
},
"required": [
"PCID"
]
}
```