Skip to main content
← back to extensions

Vercel/deployments

@swamp/vercel/deploymentsv2026.10.23.1· AGPL-3.0-or-later· 3d agoBEHAVIORS
01README

Vercel deployments infrastructure models

02Release Notes
  • Updated: deployments
03Behaviors1
@swamp/vercel/deployments/deploymentsv2026.10.23.1deployments.ts

Global Arguments

ArgumentTypeDescription
teamId?stringVercel team ID
slug?stringVercel team slug (alternative to teamId)
buildMachine?enumSelects a custom build machine for this deployment without changing project settings.
customEnvironmentSlugOrId?stringThe slug or ID of a custom environment to deploy to, overriding the default target environment. When omitted, the deployment targets the environment inferred from the branch (production or preview).
deploymentId?stringThe ID of an existing deployment to redeploy. All project settings and environment variables are inherited from the original unless explicitly overridden in this request. The redeployment gets a new ID, URL, and build.
files?arrayThe files to include in the deployment. Each entry is either an inlined file (with `data` and `encoding`) or a reference to a previously uploaded file (with `sha` and `size`). Required for non-git deployments. Cannot be used together with `gitSource`.
gitAccessToken?stringAvailable only to Vercel platform accounts. A read-only GitHub access token scoped to the requested repository. Use a token with a lifetime of 24 hours or less that remains valid until source retrieval completes. Wire with a vault.get(...) expression to source it from a vault.
gitMetadata?objectPopulates initial git metadata for different git providers.
gitSource?object
meta?recordAn object containing the deployment's metadata. Multiple key-value pairs can be attached to a deployment. For deployments created with a Cursor Origin `gitSource`, Vercel automatically adds `cursorOriginDeployment`, `cursorOriginCommitSha`, `cursorOriginCommitRef`, `cursorOriginCommitMessage`, `cursorOriginCommitAuthorName`, `cursorOriginCommitAuthorEmail` when available, `cursorOriginOwner`, `cursorOriginRepo`, `cursorOriginRepoId`, and `cursorOriginPrId` for pull request deployments.
monorepoManager?stringThe monorepo manager that is being used for this deployment. When `null` is used no monorepo manager is selected
name?stringA string with the project name used in the deployment URL
project?stringThe target project identifier in which the deployment will be created. When defined, this parameter overrides name
projectSettings?objectProject 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?stringEither 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?booleanWhen `true` and `deploymentId` is passed in, the sha from the previous deployment's `gitSource` is removed forcing the latest commit to be used.
token?stringVercel API token; overrides the VERCEL_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
fn create()
Create a Deployments
fn get(id: string)
Get a Deployments
ArgumentTypeDescription
idstringThe ID of the Deployments
fn lookup(allowMissing?: boolean)
Look up an existing Deployments by matching global argument values and import it into state
ArgumentTypeDescription
allowMissing?booleanSucceed and record found: false in lookupResult when nothing matches, instead of failing
fn adopt(id: string)
Import an existing Deployments by ID into state for management
ArgumentTypeDescription
idstringThe ID of the Deployments to import
fn delete(id: string)
Delete the Deployments
ArgumentTypeDescription
idstringThe ID of the Deployments
fn sync(identifier?: string)
Sync Deployments state from Vercel
ArgumentTypeDescription
identifier?stringTarget a specific Deployments by id (e.g. one discovered by list)

Resources

state(infinite)— Deployments resource state
lookupResult(infinite)— Outcome of the most recent lookup
04Previous Versions18
2026.10.22.1AGPL-3.0-or-later
  • Updated: deployments
2026.10.21.1AGPL-3.0-or-later
  • Updated: deployments
2026.10.20.3AGPL-3.0-or-later
  • Updated: deployments
2026.10.20.2AGPL-3.0-or-later
  • Updated: deployments

Modified 1 behaviors

2026.10.20.1AGPL-3.0-or-later
  • Updated: deployments
2026.10.17.1AGPL-3.0-or-later(was none)
  • Updated: deployments
2026.10.13.1
  • Updated: deployments
2026.10.02.1
  • Updated: deployments
2026.10.01.1
  • Updated: deployments
2026.09.25.1
  • Updated: deployments
2026.09.17.1
  • Updated: deployments
2026.09.12.1
  • Updated: deployments
2026.09.03.1
  • Updated: deployments
2026.08.19.1
  • Updated: deployments
2026.08.06.1
  • Updated: deployments
2026.08.04.1
  • Updated: deployments
2026.08.03.3
  • Updated: deployments
2026.08.03.2
  • Updated: deployments
05Stats
A
100 / 100
Downloads
69
Archive size
20.7 KB
Verified by Swamp
  • Has README or module doc2/2earned
  • README has a code example1/1earned
  • README is substantive1/1earned
  • Most symbols documented1/1earned
  • No slow types (deprecated)1/1earned
  • Dependencies pass trust audit2/2earned
  • Docs keep secrets in a vault1/1earned
  • Has description1/1earned
  • Platform support declared (or universal)2/2earned
  • License2/2earned
  • Verified public repository2/2earned
Repository
https://github.com/swamp-club/swamp-extensions
06Platforms
07Labels
#vercel#deployments#cloud#infrastructure