Vercel
Arcade toolkit · docs.arcade.dev
The Vercel toolkit lets you manage Vercel projects, deployments, domains, and environment variables programmatically via Arcade. It covers the full project lifecycle — from creation and configuration through deployment, promotion, rollback, and teardown.
Capabilities
- Account & team discovery — resolve the authenticated account, list accessible teams, and inspect team details (including billing plan) to establish the correct scope before making changes.
- Project management — create, retrieve, list, update settings for, and permanently delete projects; optionally connect a Git repository at creation time.
- Deployment lifecycle — trigger deployments from inline source files, connected Git repositories, or prior deployment sources; cancel in-progress builds; inspect state and build/runtime logs; promote a deployment to production; and roll production back to a prior build.
- Custom domain management — attach and detach custom domains, retrieve verification and DNS-configuration status, list all domains on a project, and trigger re-verification against outstanding DNS challenges.
- Environment variable management — list, create, update, and delete project environment variables across all environments.
Secrets
VERCEL_ACCESS_TOKEN is a Vercel personal access token (or team-scoped OAuth token) used to authenticate every API call. To obtain one:
- Log in to your Vercel account and open Account Settings → Tokens (personal token): https://vercel.com/account/tokens. For a team-scoped token, open the team's Settings → Tokens.
- Click Create, give it a name, choose an expiry, and optionally restrict it to a specific team scope.
- Copy the token immediately — Vercel only shows it once.
- The token needs sufficient permissions for all operations you intend to use (full-access tokens work for all tools; read-only tokens will fail write operations).
For details on creating tokens see the Vercel documentation on access tokens.
Store this value as an Arcade secret. See Arcade secret configuration docs and manage your secrets at https://api.arcade.dev/dashboard/auth/secrets.
Tools23
Vercel_AddProjectDomain
Attach a custom domain to a project; the result reports its verification status.
Vercel_CancelDeployment
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.
Vercel_CreateDeployment
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.
Vercel_CreateProject
Create a new project, optionally connecting a git repository to deploy from.
Vercel_DeleteEnvironmentVariable
Delete an environment variable from a project.
Vercel_DeleteProject
Permanently delete a project and all of its deployments.
Vercel_GetCurrentUser
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.
Vercel_GetDeployment
Return a single deployment's state and metadata.
Vercel_GetDeploymentLogs
Read a deployment's build and runtime log events to diagnose why it failed.
Vercel_GetProject
Return a single project's settings and latest deployment state.
Vercel_GetProjectDomain
Return a project domain's verification status and DNS-configuration state.
Vercel_GetTeam
Return a team's details, including its billing plan.
Vercel_ListDeployments
List deployments in the active scope, optionally filtered by project, target, and state.
Vercel_ListEnvironmentVariables
List a project's environment variables across all environments.
Vercel_ListProjectDomains
List the custom domains attached to a project.
Vercel_ListProjects
List the projects in the active scope, optionally narrowed by a fuzzy name search.
Vercel_ListTeams
List the teams the access token can act on, to discover a valid team scope.
Vercel_PromoteDeployment
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.
Vercel_RemoveProjectDomain
Detach a custom domain from a project.
Vercel_RollbackDeployment
Roll production back to a prior deployment, making it the current production deployment.
Vercel_SaveEnvironmentVariable
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.
Vercel_UpdateProjectSettings
Update a project's build and framework settings; unset fields are left unchanged.
Vercel_VerifyProjectDomain
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.