Vercel
Arcade Optimized
Arcade.dev tools for interacting with Vercel
Author:Arcade
Version:
2.0.1Auth:No authentication required
23tools
23require secrets
Vercel Toolkit for Arcade
Provides Arcade tools for managing Vercel projects, deployments, domains, and environment variables programmatically via the Vercel REST API.
Capabilities
- Project lifecycle: Create, inspect, update settings, and permanently delete projects; list and search across all projects in scope.
- Deployment management: Trigger deployments from inline files, connected Git repositories, or prior deployments; cancel in-progress builds; list and filter deployments; read build and runtime logs for diagnostics.
- Production promotion & rollback: Promote any deployment to production (rebuilds previews automatically to match production environment) or roll back to a prior production deployment.
- Domain management: Attach and detach custom domains, retrieve DNS/verification status, trigger verification, and list all domains on a project.
- Environment variables: List, create, update, and delete per-project environment variables across environments; changes take effect on the next deployment.
- Account & team introspection: Resolve the authenticated identity, list accessible teams, and retrieve team billing details to confirm scope before making changes.
Secrets
VERCEL_ACCESS_TOKEN — A Vercel personal access token (or team-scoped token) that authenticates all API requests. To create one, log in to the Vercel dashboard, navigate to Account Settings → Tokens, and click Create. Give the token a descriptive name and choose an expiration. If you need to act on a team's resources, ensure the token is created under an account that is a member of that team (team scope is then controlled by passing a team ID at call time, not by the token itself). Copy the token immediately — Vercel does not display it again after creation. Store it as the VERCEL_ACCESS_TOKEN secret in Arcade.
For guidance on configuring secrets in Arcade, see the Arcade secrets docs. You can also manage secrets directly at https://api.arcade.dev/dashboard/auth/secrets.
Available tools(23)
23 of 23 tools
Operations
Behavior
| Tool name | Description | Secrets | |
|---|---|---|---|
Attach a custom domain to a project; the result reports its verification status. | 1 | ||
Cancel an in-progress deployment.
Canceling a deployment that has already finished is not an error: its current (terminal) state
is returned unchanged rather than reporting a cancellation. | 1 | ||
Trigger a new deployment from inline source files, a git repository, or a prior deployment.
The target project must already exist (create it first); an unknown project name or id is
rejected rather than silently auto-created. Exactly one source is required: pass files to
upload source inline (no Git connection needed, the way to ship a first deployment on an
account without a connected repository), git_repo together with git_ref to deploy from a
connected repository, or redeploy_of to rebuild a prior deployment's source. Deploying from a
repository requires the Vercel account to have a connected Git integration for that provider. | 1 | ||
Create a new project, optionally connecting a git repository to deploy from. | 1 | ||
Delete an environment variable from a project. | 1 | ||
Permanently delete a project and all of its deployments. | 1 | ||
Return a single deployment's state and metadata. | 1 | ||
Return a single project's settings and latest deployment state. | 1 | ||
Return a project domain's verification status and DNS-configuration state. | 1 | ||
Return a team's details, including its billing plan. | 1 | ||
Read a deployment's build and runtime log events to diagnose why it failed. | 1 | ||
List deployments in the active scope, optionally filtered by project, target, and state. | 1 | ||
List a project's environment variables across all environments. | 1 | ||
List the custom domains attached to a project. | 1 | ||
List the projects in the active scope, optionally narrowed by a fuzzy name search. | 1 | ||
List the teams the access token can act on, to discover a valid team scope. | 1 | ||
Make a deployment the project's current production deployment ("ship this one").
A deployment that already targeted production (a staged or prior production build) is
promoted instantly without a rebuild. A preview deployment cannot be aliased to production
directly, because preview and production builds can differ (e.g. environment variables), so
this rebuilds the preview's source as a new production deployment — the same complete-rebuild
path the Vercel dashboard uses to promote a preview. In that case the returned deployment is
the new build (still building), not the preview that was passed in. | 1 | ||
Detach a custom domain from a project. | 1 | ||
Roll production back to a prior deployment, making it the current production deployment. | 1 | ||
Create or update a project environment variable.
Omit env_id to create (key, value, and target are required); pass env_id to update an existing
variable in place, changing only the fields you supply. Saving a variable does not affect
already-built deployments: a new deployment must be triggered for the change to take effect. | 1 | ||
Update a project's build and framework settings; unset fields are left unchanged. | 1 | ||
Trigger verification of a project domain and return its resulting status.
An unmet DNS challenge is the normal polling path, not an error: this returns the domain's
still-unverified status (with the outstanding challenge records) rather than failing. | 1 | ||
Return the Vercel account the access token authenticates as.
Call this first in a session to confirm which account you are acting on
before making any changes. | 1 |
Last updated on