Vercel/deployments
@swamp/vercel/deploymentsv2026.09.03.1
01README
Vercel deployments infrastructure models
02Release Notes
- Updated: deployments
03Models
@swamp/vercel/deployments/deploymentsv2026.09.03.1deployments.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| teamId? | string | Vercel team ID |
| slug? | string | Vercel team slug (alternative to teamId) |
| customEnvironmentSlugOrId? | string | The 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? | string | The 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? | array | The 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? | string | Available 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. |
| gitMetadata? | object | Populates initial git metadata for different git providers. |
| gitSource? | object | |
| meta? | record | An object containing the deployment's metadata. Multiple key-value pairs can be attached to a deployment |
| monorepoManager? | string | The monorepo manager that is being used for this deployment. When `null` is used no monorepo manager is selected |
| name | string | A string with the project name used in the deployment URL |
| project? | string | The target project identifier in which the deployment will be created. When defined, this parameter overrides name |
| projectSettings? | object | 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 | 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 | When `true` and `deploymentId` is passed in, the sha from the previous deployment's `gitSource` is removed forcing the latest commit to be used. |
| token? | string | Vercel 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
| Argument | Type | Description |
|---|---|---|
| id | string | The ID of the Deployments |
fn lookup()
Look up an existing Deployments by matching global argument values and import it into state
fn adopt(id: string)
Import an existing Deployments by ID into state for management
| Argument | Type | Description |
|---|---|---|
| id | string | The ID of the Deployments to import |
fn delete(id: string)
Delete the Deployments
| Argument | Type | Description |
|---|---|---|
| id | string | The ID of the Deployments |
fn sync(identifier?: string)
Sync Deployments state from Vercel
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific Deployments by uid (e.g. one discovered by list) |
Resources
state(infinite)— Deployments resource state
04Previous Versions
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
5
Archive size
15.8 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
- Has description1/1earned
- Platform support declared (or universal)2/2earned
- License declared1/1earned
- Verified public repository2/2earned
06Platforms
07Labels