> ## Documentation Index > Fetch the complete documentation index at: https://docs.boxd.sh/llms.txt > Use this file to discover all available pages before exploring further. # Vercel > Vercel is a platform for frontend frameworks and static sites, enabling developers to host websites and web services that deploy instantly, scale automatically, and require minimal Vercel is a platform for frontend frameworks and static sites, enabling developers to host websites and web services that deploy instantly, scale automatically, and require minimal configuration. `vercel` · **146 tools** · no triggers ## Connect it ```bash theme={"theme":"github-dark"} run auth vercel run auth vercel --scope team # shared with the organization ``` Or from the [Integrations page](https://app.boxd.sh/integrations) in the console. See [Connections](/guides/integrations/connections) for personal versus shared, and who may remove one. ## Use it ```bash theme={"theme":"github-dark"} run vercel # common commands run vercel --all # every command ``` ```ts theme={"theme":"github-dark"} import { vercel } from "@boxd/run"; ``` ## Common tools | Tool | What it does | | -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `add-environment-variable` | Tool to add an environment variable to a Vercel project. Variables only take effect in subsequent deployments - already-running deployments are not updated. | | `add-project-domain` | Tool to attach a custom domain to a Vercel project. Use when you need to add a domain to a project for production or branch-specific deployments. | | `assign-alias` | Tool to assign an alias to a specific Vercel deployment. Use when you need to associate a custom domain or subdomain with a deployment. | | `create-deployment` | DEPRECATED: Use VERCEL\_CREATE\_NEW\_DEPLOYMENT instead. Create a new deployment on Vercel. | | `create-edge-config` | Creates a new Edge Config for storing key-value data at the edge. | | `create-new-deployment` | Tool to create a new deployment. Use when you need to deploy files or a Git commit to a Vercel project. | | `create-project` | DEPRECATED: Use VERCEL\_VERCEL\_CREATE\_PROJECT2 instead. Tool to create a new Vercel project. | | `delete-auth-token` | Tool to delete an authentication token. Use when you need to revoke a token programmatically after confirming its validity. | | `get-auth-user` | Tool to get the authenticated user's profile. Use when you need to retrieve details about the currently authenticated user. | | `get-deployment` | Tool to get a deployment by ID or URL. Use when you need to retrieve detailed information about a specific deployment. | | `get-deployment-details` | DEPRECATED: Use VERCEL\_VERCEL\_GET\_DEPLOYMENT instead. Retrieves detailed information about a specific deployment. | | `get-deployments` | Tool to list deployments from Vercel. Use when you need to retrieve deployment information for a project or team. | | `get-project` | DEPRECATED: Use VERCEL\_VERCEL\_GET\_PROJECT2 instead. Tool to retrieve information about a Vercel project by ID or name. | | `get-projects` | Tool to retrieve a list of projects from Vercel. Use this to get project information with optional filtering by repository, team, or other criteria. | | `list-all-deployments` | DEPRECATED: Use VERCEL\_GET\_DEPLOYMENTS instead. Lists deployments under your user or team context. | | `list-auth-tokens` | Tool to list authentication tokens. Use when you need to retrieve all tokens for the current user or an optional team. | | `list-domains` | Tool to list all domains from Vercel. Use this to retrieve domain information including verification status, nameservers, and ownership details. | | `list-env-variables` | DEPRECATED: Use FilterProjectEnvs instead. Tool to list environment variables for a specific project. | | `list-projects` | DEPRECATED: Use GetProjects instead. Tool to list all projects accessible to the authenticated user or team. | | `update-project` | DEPRECATED: Use VERCEL\_VERCEL\_UPDATE\_PROJECT2 instead. Tool to update an existing project. | | Tool | What it does | | ------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `add-environment-variable` | Tool to add an environment variable to a Vercel project. Variables only take effect in subsequent deployments - already-running deployments are not updated. | | `add-project-domain` | Tool to attach a custom domain to a Vercel project. Use when you need to add a domain to a project for production or branch-specific deployments. | | `assign-alias` | Tool to assign an alias to a specific Vercel deployment. Use when you need to associate a custom domain or subdomain with a deployment. | | `batch-remove-project-env` | Tool to batch remove environment variables from a Vercel project. | | `buy-domains` | Tool to purchase multiple domains through Vercel's domain registrar. | | `buy-single-domain` | Tool to purchase a domain through Vercel's domain registrar. | | `check-cache-artifact-exists` | Tool to check if a cache artifact exists by its hash. Use when verifying whether a cache artifact is already stored before upload or when validating... | | `check-domain-availability` | Tool to check if a domain is available for registration. Read-only: does not reserve or purchase the domain. | | `check-domain-price` | DEPRECATED: Use VERCEL\_CHECK\_DOMAIN\_PRICE2 instead. Tool to check the price for a domain before purchase. | | `check-domain-price2` | Check pricing for a domain including purchase, renewal, and transfer costs. | | `create-auth-token` | Tool to create a new authentication token. Use when you need to programmatically generate a new auth token with optional expiration. | | `create-deployment` | DEPRECATED: Use VERCEL\_CREATE\_NEW\_DEPLOYMENT instead. Create a new deployment on Vercel. | | `create-dns-record` | Tool to create a new DNS record for a domain. Use when you need to add DNS records such as A, AAAA, CNAME, MX, TXT, SRV, or other record types to a... | | `create-edge-config` | Creates a new Edge Config for storing key-value data at the edge. | | `create-edge-config-token` | Create a read access token for a specific Edge Config. The generated token is used to authenticate against the Edge Config's endpoint for... | | `create-new-deployment` | Tool to create a new deployment. Use when you need to deploy files or a Git commit to a Vercel project. | | `create-or-transfer-domain` | Tool to add an existing domain to the Vercel platform. Use when you need to add a domain to Vercel for DNS management or transfer a domain. | | `create-project` | DEPRECATED: Use VERCEL\_VERCEL\_CREATE\_PROJECT2 instead. Tool to create a new Vercel project. | | `create-project2` | Tool to create a new Vercel project with comprehensive configuration options. | | `create-project-env` | DEPRECATED: Use VERCEL\_ADD\_ENVIRONMENT\_VARIABLE instead. Tool to create environment variables in a Vercel project. | | `create-project-transfer-request` | Tool to create a project transfer request. Use when you need to initiate a transfer of a Vercel project to another account or team. | | `create-shared-env-variable` | Tool to create one or more shared environment variables in Vercel. | | `create-webhook` | Tool to create a webhook for receiving notifications about Vercel events. | | `dangerously-delete-by-src-images` | Tool to dangerously delete edge cache by source image URLs. Use when you need to invalidate cached images from the edge network for a specific project. | | `dangerously-delete-by-tags` | Tool to dangerously delete edge cache by tags. Use when you need to purge cached content for specific cache tags in a Vercel project. | | `delete-alias` | Tool to delete an alias from Vercel. Use when you need to remove a deployment alias or custom domain alias after confirming the alias ID. | | `delete-auth-token` | Tool to delete an authentication token. Use when you need to revoke a token programmatically after confirming its validity. | | `delete-data-cache-purge-all` | Tool to purge all data cache entries for a specific project. | | `delete-deployment` | Permanently delete a Vercel deployment by its ID or URL. Use this action to remove a deployment from Vercel. | | `delete-dns-record` | Tool to delete a DNS record from a domain. Use when you need to remove an existing DNS record by its record ID and domain name. | | `delete-domain` | Tool to remove a domain by name from Vercel. Use when you need to delete a domain that is no longer needed. | | `delete-edge-config` | Tool to delete an Edge Config by its unique identifier. Use when you need to permanently remove an Edge Config and all its associated data. | | `delete-edge-config-tokens` | Tool to delete one or more Edge Config tokens. Use when you need to revoke access tokens from an Edge Config. | | `delete-project` | Tool to delete a Vercel project by ID or name. Use after confirming the correct project identifier to permanently remove the project. | | `delete-project-env` | Tool to remove an environment variable from a Vercel project. | | `delete-rolling-release-config` | Tool to delete rolling release configuration for a project. Use when you need to remove or disable rolling release configuration from a Vercel project. | | `delete-shared-env-variable` | Tool to delete one or more shared environment variables. Use when you need to remove shared env vars by their IDs (up to 50 at a time). | | `delete-webhook` | Delete a webhook by its unique ID to stop receiving event notifications. | | `download-artifact` | Download a cache artifact from Vercel's Remote Cache by its hash. | | `edit-project-env` | Tool to edit an environment variable in a Vercel project. Use when you need to update an existing environment variable's value, type, target... | | `filter-project-envs` | Tool to retrieve environment variables of a Vercel project by id or name. | | `get-active-attack-status` | Tool to read active attack data from Vercel Firewall for a specific project. | | `get-alias` | Tool to retrieve information about a Vercel alias by ID or alias name. | | `get-all-log-drains` | Tool to retrieve a list of all log drains (deprecated). Use when you need to list all log drains configured for your account, team, or project. | | `get-artifact-info` | Tool to query information about artifacts by their hashes. Use when you need to retrieve metadata about one or more artifacts, including size... | | `get-auth-token` | Tool to retrieve metadata for an authentication token. Use when you need to inspect details of a specific token or get information about the current token being used. | | `get-auth-user` | Tool to get the authenticated user's profile. Use when you need to retrieve details about the currently authenticated user. | | `get-bulk-availability` | Tool to check availability for multiple domains at once. Use when you need to verify availability of multiple domain names efficiently in a single request. | | `get-cache-status` | Tool to get the status of Remote Caching for the principal. Use when you need to check if Remote Caching is enabled, disabled, over limit, or paused. | | `get-certs` | Tool to retrieve SSL/TLS certificates for the authenticated user or team. | | `get-configurations` | Tool to get configurations for the authenticated user or team. | | `get-contact-info-schema` | Tool to retrieve the contact information schema for a domain's top-level domain (TLD). | | `get-deployment` | Tool to get a deployment by ID or URL. Use when you need to retrieve detailed information about a specific deployment. | | `get-deployment-details` | DEPRECATED: Use VERCEL\_VERCEL\_GET\_DEPLOYMENT instead. Retrieves detailed information about a specific deployment. | | `get-deployment-events` | DEPRECATED: Use VERCEL\_VERCEL\_GET\_DEPLOYMENT\_EVENTS2 instead. | | `get-deployment-events2` | Tool to get deployment events for a specific Vercel deployment by ID or URL. | | `get-deployment-file-contents` | Retrieve the contents of a specific file from a Vercel deployment. | | `get-deployment-logs` | DEPRECATED: Use VERCEL\_VERCEL\_GET\_DEPLOYMENT\_EVENTS2 instead. | | `get-deployment-logs2` | Tool to retrieve runtime logs for a specific Vercel deployment by project and deployment ID. | | `get-deployments` | Tool to list deployments from Vercel. Use when you need to retrieve deployment information for a project or team. | | `get-domain` | Tool to retrieve complete information for a single domain. Use when you need to check domain details, ownership verification status, nameserver... | | `get-domain-config` | Tool to get a domain's configuration details from Vercel. Use when you need to check how a domain is configured, what DNS records are recommended, or verify domain setup. | | `get-domain-transfer-info` | Tool to get information required to transfer a domain to Vercel. | | `get-drains` | Tool to retrieve a list of all drains. Use this to get all configured drains for an account or team, including their delivery configurations and sources. | | `get-edge-config` | Tool to retrieve detailed information about a specific Edge Config by ID. | | `get-edge-config-backup` | Tool to retrieve a specific backup version of an Edge Config. | | `get-edge-config-item` | Tool to retrieve a specific item within an Edge Config. Use after obtaining the Edge Config ID and when you need to inspect or validate a particular... | | `get-edge-config-schema` | Tool to retrieve the JSON schema of a specific Edge Config. Use when you need to inspect the schema definition of an edge config. | | `get-edge-config-token` | Tool to retrieve details of a specific token associated with an Edge Config. | | `get-firewall-config` | Tool to retrieve firewall configuration for a Vercel project. | | `get-git-namespaces` | Tool to list Git namespaces (organizations/users) by provider. | | `get-project` | DEPRECATED: Use VERCEL\_VERCEL\_GET\_PROJECT2 instead. Tool to retrieve information about a Vercel project by ID or name. | | `get-project2` | Tool to find a project by ID or name with comprehensive details. | | `get-project-domain` | Tool to retrieve details about a specific domain attached to a Vercel project. | | `get-project-domains` | Tool to retrieve all domains attached to a Vercel project. Use when you need to verify domain configuration, check verification status, audit... | | `get-project-env` | Tool to retrieve the decrypted value of an environment variable from a Vercel project. | | `get-projects` | Tool to retrieve a list of projects from Vercel. Use this to get project information with optional filtering by repository, team, or other criteria. | | `get-promote-aliases` | Tool to get a list of aliases with status for the current promote operation. | | `get-rolling-release` | Tool to retrieve active rolling release information for a Vercel project. | | `get-rolling-release-billing-status` | Tool to retrieve the rolling release billing status for a Vercel project. | | `get-rolling-release-config` | Tool to get rolling release configuration for a Vercel project. | | `get-runtime-logs` | DEPRECATED: Use VERCEL\_GET\_DEPLOYMENT\_LOGS2 instead. Tool to retrieve runtime logs for a specific Vercel deployment. | | `get-shared-env-var` | Tool to retrieve the decrypted value of a Shared Environment Variable by id. | | `get-shared-env-variables` | Tool to list all shared environment variables for a team. Use when you need to retrieve or inspect shared environment variables across projects. | | `get-team` | Retrieves detailed information about a specific Vercel team by its ID or slug. | | `get-teams` | Tool to list all teams accessible to the authenticated user with detailed information. | | `get-tld-info` | Tool to get information about a specific top-level domain (TLD). | | `get-tld-price` | Tool to get pricing information for a specific top-level domain (TLD). | | `get-user-events` | Tool to list user events. Use when you need to retrieve events generated by a user or team, such as logins, deployments, and team activities. | | `get-webhook` | Tool to retrieve details of a specific webhook by ID. Use when you need to inspect webhook configuration, events, or metadata. | | `invalidate-cache-by-src-images` | Tool to invalidate edge cache by source image URLs. Use when you need to mark cached images as stale for specific source images. | | `invalidate-cache-by-tags` | Tool to invalidate edge cache by tags. Use when you need to mark cached content as stale for specific cache tags. | | `list-aliases` | Tool to list aliases from Vercel API. Use when you need to retrieve aliases with optional filtering by domain, project, or time range. | | `list-all-deployments` | DEPRECATED: Use VERCEL\_GET\_DEPLOYMENTS instead. Lists deployments under your user or team context. | | `list-auth-tokens` | Tool to list authentication tokens. Use when you need to retrieve all tokens for the current user or an optional team. | | `list-deployment-aliases` | Tool to list all aliases assigned to a specific deployment. Use when you need to retrieve the aliases (custom domains or URLs) that point to a particular deployment. | | `list-deployment-checks` | Tool to retrieve a list of checks for a specific deployment. | | `list-deployment-files` | Tool to list all files in a specific deployment. Use when you need to inspect the file tree structure of a deployed application. | | `list-dns-records` | Tool to list existing DNS records for a domain. Use when you need to retrieve, audit, or verify DNS configuration for a domain managed in Vercel. | | `list-domains` | Tool to list all domains from Vercel. Use this to retrieve domain information including verification status, nameservers, and ownership details. | | `list-edge-config-backups` | Tool to retrieve backups for a specific Edge Config. Use when you need to list or inspect available backups for recovery purposes. | | `list-edge-config-items` | Tool to retrieve all items from a specific Edge Config. Use when you need to inspect all key-value pairs stored in an Edge Config. | | `list-edge-configs` | Tool to retrieve all Edge Configs for an account or team. Use when you need to list all Edge Config definitions. | | `list-edge-config-tokens` | Tool to get all tokens of an Edge Config. Use when you need to retrieve the complete list of tokens associated with a specific Edge Config. | | `list-env-variables` | DEPRECATED: Use FilterProjectEnvs instead. Tool to list environment variables for a specific project. | | `list-firewall-events` | Retrieve firewall events and security actions for a specific Vercel project. | | `list-integration-log-drains` | Retrieves a list of Integration log drains for a team or account. | | `list-project-custom-environments` | Tool to retrieve custom environments for a Vercel project. Use when you need to list all custom environments or filter by git branch. | | `list-project-members` | Tool to list all members of a Vercel project. Use when you need to retrieve member information, check access permissions, or audit project membership. | | `list-projects` | DEPRECATED: Use GetProjects instead. Tool to list all projects accessible to the authenticated user or team. | | `list-supported-tlds` | Tool to retrieve all TLDs (top-level domains) supported by Vercel for domain registration. | | `list-team-members` | Tool to list all members of a Vercel team. Use when you need to retrieve team member information, check team access permissions, or audit team membership. | | `list-teams` | DEPRECATED: Use VERCEL\_VERCEL\_GET\_TEAMS instead. Tool to list all teams accessible to the authenticated user. | | `list-webhooks` | Tool to retrieve a list of all webhooks for the authenticated account or team. | | `move-project-domain` | Tool to move a domain from one Vercel project to another. Use when you need to transfer domain ownership between projects. | | `pause-project` | Tool to pause a Vercel project. Use when you need to temporarily disable a project to prevent new deployments and stop serving traffic. | | `read-firewall-config` | Tool to read firewall configuration for a Vercel project. Use when you need to inspect current firewall settings, IP rules, or custom security rules for a project. | | `record-events` | Tool to record artifacts cache usage events. Use when tracking cache hits and misses for artifact hashes to monitor remote caching performance. | | `remove-project-domain` | Tool to remove a domain from a Vercel project. Use when you need to detach a domain from a project or clean up domain associations. | | `replace-firewall-config` | Tool to update firewall configuration for a Vercel project. Use when you need to enable/disable firewall, configure CRS rules, or manage custom... | | `request-delete-user` | Tool to initiate user account deletion on Vercel. Use when a user wants to delete their account. | | `request-promote` | Tool to promote a deployment to production by pointing all production domains for a project to the given deployment. | | `search-repo` | Tool to search and list Git repositories linked to a namespace by provider. | | `test-drain` | Tool to validate a drain delivery configuration by sending a test request. | | `transfer-in-domain` | Tool to transfer a domain to Vercel from another registrar. Use when you need to migrate domain registration to Vercel. | | `unlink-shared-env-variable` | Tool to disconnect a shared environment variable from a Vercel project. | | `unpause-project` | Tool to unpause a specific project by its ID. Use after identifying a paused project to enable auto assigning custom production domains and unblock... | | `update-attack-challenge-mode` | Tool to update Attack Challenge mode for a Vercel project. Use when you need to enable or disable enhanced security protection against potential attacks. | | `update-dns-record` | Tool to update an existing DNS record. Use when you need to modify DNS record properties such as value, name, type, TTL, or comment. | | `update-domain` | Tool to update or move an apex domain on Vercel. Use when you need to modify domain configuration (zone settings) or transfer a domain to another team. | | `update-edge-config` | Tool to update an Edge Config by changing its slug. Use when you need to rename an Edge Config to reflect a new purpose or organizational structure. | | `update-edge-config-items` | Tool to update items within a specific Edge Config. Use when you need to batch modify, add, or remove key-value pairs in an existing Edge Config. | | `update-edge-config-schema` | Tool to update the JSON Schema for an Edge Config. Use when you need to define or modify validation rules for Edge Config items. | | `update-firewall-config` | Tool to incrementally update Vercel Firewall configuration for a project using PATCH. | | `update-project` | DEPRECATED: Use VERCEL\_VERCEL\_UPDATE\_PROJECT2 instead. Tool to update an existing project. | | `update-project2` | Tool to update an existing Vercel project configuration. Use when you need to modify project settings such as framework, build commands, environment... | | `update-project-data-cache` | Tool to update the data cache feature for a Vercel project. Use when you need to enable or disable data caching for a project's deployments. | | `update-project-domain` | Tool to update a project domain in Vercel. Use when you need to modify domain settings such as git branch association, redirects, or redirect status... | | `update-project-protection-bypass` | Tool to update protection bypass for automation on a Vercel project. | | `update-shared-env-variable` | Tool to update one or more shared environment variables. Use when you need to modify shared env var properties like value, target environments, or... | | `update-static-ips` | Tool to configure Static IPs for a Vercel project. Use when you need to enable or configure Static IPs for builds or specific regions. | | `update-team` | Tool to update a Vercel team's configuration. Use when you need to modify team settings like name, description, security policies, or deployment settings. | | `update-url-protection-bypass` | Tool to update the protection bypass for a URL. Use when you need to configure shareable links with TTL, revoke/regenerate links, set user-scoped... | | `upload-artifact` | Tool to upload a cache artifact to Vercel. Use when you need to store build artifacts in Vercel's remote cache. | | `upload-file` | Tool to upload deployment files to Vercel. Use when preparing files for a Vercel deployment. | | `verify-project-domain` | Attempts to verify a project domain by checking if DNS challenges are correctly configured. | [Open Vercel in the console →](https://app.boxd.sh/integrations/detail/vercel)