Vercel/projects
@swamp/vercel/projectsv2026.09.10.1
01README
Vercel projects infrastructure models
02Release Notes
- Updated: projects
03Models
domains.tsv2026.08.03.4
Global Arguments
| Argument | Type | Description |
|---|---|---|
| teamId? | string | Vercel team ID |
| slug? | string | Vercel team slug (alternative to teamId) |
| idOrName | string | The unique project identifier or the project name |
| gitBranch? | string | Git branch to link the project domain |
| redirect? | string | Target destination domain for redirect |
| redirectStatusCode? | union | Status code for domain redirect |
| name | string | The project domain name |
| customEnvironmentId? | string | The unique custom environment identifier within the project |
| 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 Domains
fn get(id: string)
Get a Domains
| Argument | Type | Description |
|---|---|---|
| id | string | The ID of the Domains |
fn lookup()
Look up an existing Domains by matching global argument values and import it into state
fn adopt(id: string)
Import an existing Domains by ID into state for management
| Argument | Type | Description |
|---|---|---|
| id | string | The ID of the Domains to import |
fn update(identifier?: string)
Update Domains attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific Domains by name (e.g. one discovered by list) |
fn delete(id: string)
Delete the Domains
| Argument | Type | Description |
|---|---|---|
| id | string | The ID of the Domains |
fn sync(identifier?: string)
Sync Domains state from Vercel
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific Domains by name (e.g. one discovered by list) |
env.tsv2026.08.03.4
Global Arguments
| Argument | Type | Description |
|---|---|---|
| teamId? | string | Vercel team ID |
| slug? | string | Vercel team slug (alternative to teamId) |
| idOrName | string | The unique project identifier or the project name |
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| key | string | The name of the environment variable |
| target? | array | The target environment of the environment variable |
| gitBranch? | string | If defined, the git branch of the environment variable (must have target=preview) |
| type | enum | The type of environment variable |
| value | string | The value of the environment variable |
| customEnvironmentIds? | array | The custom environment IDs associated with the environment variable |
| comment? | string | A comment to add context on what this environment variable is for |
| 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 Env
fn get(id: string)
Get a Env
| Argument | Type | Description |
|---|---|---|
| id | string | The ID of the Env |
fn lookup()
Look up an existing Env by matching global argument values and import it into state
fn adopt(id: string)
Import an existing Env by ID into state for management
| Argument | Type | Description |
|---|---|---|
| id | string | The ID of the Env to import |
fn update(identifier?: string)
Update Env attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific Env by id (e.g. one discovered by list) |
fn delete(id: string)
Delete the Env
| Argument | Type | Description |
|---|---|---|
| id | string | The ID of the Env |
fn sync(identifier?: string)
Sync Env state from Vercel
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific Env by id (e.g. one discovered by list) |
projects.tsv2026.09.10.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| teamId? | string | Vercel team ID |
| slug? | string | Vercel team slug (alternative to teamId) |
| autoExposeSystemEnvs? | boolean | |
| autoAssignCustomDomains? | boolean | |
| autoAssignCustomDomainsUpdatedBy? | string | |
| buildCommand? | string | The build command for this project. When `null` is used this value will be automatically detected |
| commandForIgnoringBuildStep? | string | |
| customerSupportCodeVisibility? | boolean | Specifies whether customer support can see git source for a deployment |
| devCommand? | string | The dev command for this project. When `null` is used this value will be automatically detected |
| directoryListing? | boolean | |
| framework? | enum | The framework that is being used for this project. When `null` is used no framework is selected |
| gitForkProtection? | boolean | Specifies whether PRs from Git forks should require a team member's authorization before it can be deployed |
| gitLFS? | boolean | Specifies whether Git LFS is enabled for this project. |
| protectedSourcemaps? | boolean | Specifies whether sourcemaps are protected and require authentication to access. |
| installCommand? | string | The install command for this project. When `null` is used this value will be automatically detected |
| name | string | The desired name for the project |
| nodeVersion? | enum | |
| outputDirectory? | string | The output directory of the project. When `null` is used this value will be automatically detected |
| previewDeploymentsDisabled? | boolean | Specifies whether preview deployments are disabled for this project. |
| previewDeploymentSuffix? | string | Custom domain suffix for preview deployments. Takes precedence over team-level suffix. Must be a domain owned by the team. |
| resourceConfig? | object | Specifies resource override configuration for the project |
| publicSource? | boolean | Deprecated. Accepted for backwards compatibility but ignored. |
| rootDirectory? | string | 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 | The region to deploy Serverless Functions in this project |
| serverlessFunctionZeroConfigFailover? | boolean | |
| skewProtectionBoundaryAt? | number | Deployments created before this absolute datetime have Skew Protection disabled. Value is in milliseconds since epoch to match \\"createdAt\\" fields. |
| skewProtectionMaxAge? | number | Deployments created before this rolling window have Skew Protection disabled. Value is in seconds to match \\"revalidate\\" fields. |
| skewProtectionAllowedDomains? | array | Cross-site domains allowed to fetch skew-protected assets (hostnames, optionally with leading wildcard like *.example.com). |
| skipGitConnectDuringLink? | boolean | Opts-out of the message prompting a CLI user to connect a Git repository in `vercel link`. |
| sourceFilesOutsideRootDirectory? | boolean | Indicates if there are source files outside of the root directory |
| enablePreviewFeedback? | boolean | Opt-in to preview toolbar on the project level |
| enableProductionFeedback? | boolean | Opt-in to production toolbar on the project level |
| enableAffectedProjectsDeployments? | boolean | Opt-in to skip deployments when there are no changes to the root directory and its dependencies |
| enableExternalRewriteCaching? | boolean | Specifies whether external rewrite caching is enabled for this project. |
| staticIps? | object | Manage Static IPs for this project |
| tracing? | object | Tracing configuration for this project |
| oidcTokenConfig? | object | OpenID Connect JSON Web Token generation configuration. |
| passwordProtection? | object | Allows to protect project deployments with a password |
| passport? | object | Passport configuration for the project. |
| sandbox? | object | Specifies the default region and failover regions for sandboxes created in the project |
| ssoProtection? | object | The Vercel Auth setting for the project (historically named \\"SSO Protection\\") |
| trustedIps? | object | Restricts access to deployments based on the incoming request IP address |
| trustedSources? | object | Deployment Protection Trusted Sources |
| deploymentPolicy? | object | Composable deployment-time policy. Each rule type holds a list of rules, one per environment scope. |
| optionsAllowlist? | object | Specify a list of paths that should not be protected by Deployment Protection to enable Cors preflight requests |
| connectConfigurations? | array | The list of connections from project environment to Secure Compute network |
| dismissedToasts? | array | 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.` |
| environmentVariables? | array | Collection of ENV Variables the Project will use |
| gitRepository? | object | 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 |
| 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 Projects
fn get(id: string)
Get a Projects
| Argument | Type | Description |
|---|---|---|
| id | string | The ID of the Projects |
fn lookup()
Look up an existing Projects by matching global argument values and import it into state
fn adopt(id: string)
Import an existing Projects by ID into state for management
| Argument | Type | Description |
|---|---|---|
| id | string | The ID of the Projects to import |
fn update(identifier?: string)
Update Projects attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific Projects by id (e.g. one discovered by list) |
fn delete(id: string)
Delete the Projects
| Argument | Type | Description |
|---|---|---|
| id | string | The ID of the Projects |
fn sync(identifier?: string)
Sync Projects state from Vercel
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific Projects by id (e.g. one discovered by list) |
04Previous Versions
2026.09.03.1
- Updated: projects
2026.09.02.1
- Updated: projects
2026.08.31.1
- Updated: projects
2026.08.29.1
- Updated: projects
2026.08.26.1
- Updated: projects
2026.08.22.1
- Updated: projects
2026.08.21.1
- Updated: projects
2026.08.20.1
- Updated: projects
2026.08.19.1
- Updated: projects
2026.08.11.1
- Updated: projects
2026.08.07.1
- Updated: projects
2026.08.06.1
- Updated: projects
2026.08.04.1
- Updated: projects
2026.08.03.4
- Updated: projects
- Updated: domains
- Updated: env
2026.08.03.3
- Updated: projects
- Updated: domains
- Updated: env
05Stats
A
100 / 100
Downloads
5
Archive size
47.6 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