Skip to content
Talk to an Engineer Dashboard

Vercel

Connect to Vercel. Access user profile, teams, projects, deployments, and environment settings.

Connect to Vercel. Access user profile, teams, projects, deployments, and environment settings.

Vercel logo

Supports authentication: OAuth 2.0

Assigns an alias (custom domain) to a Vercel deployment.

NameTypeRequiredDescription
aliasstringYesThe alias hostname to assign.
deployment_idstringYesThe deployment ID to assign the alias to.
team_idstringNoTeam ID if the deployment belongs to a team.

Removes an alias from a Vercel deployment.

NameTypeRequiredDescription
alias_or_idstringYesThe alias hostname or ID to delete.
team_idstringNoTeam ID if the alias belongs to a team.

Returns information about a specific alias by its ID or hostname.

NameTypeRequiredDescription
alias_or_idstringYesThe alias hostname or ID.
team_idstringNoTeam ID if the alias belongs to a team.

Returns all aliases for the authenticated user or team, with optional domain and deployment filtering.

NameTypeRequiredDescription
domainstringNoFilter aliases by domain.
limitintegerNoMaximum number of aliases to return.
sinceintegerNoTimestamp in ms for pagination.
team_idstringNoTeam ID to list aliases for.

Creates a new check on a Vercel deployment. Used by integrations to report status of external checks like test suites or audits.

NameTypeRequiredDescription
blockingbooleanYesIf true, this check must pass before deployment is considered ready.
deployment_idstringYesThe deployment ID to create a check for.
detailsUrlstringNoURL where users can view check details.
namestringYesDisplay name for the check.
team_idstringNoTeam ID if the deployment belongs to a team.

Updates the status and conclusion of a deployment check. Used to report check results back to Vercel.

NameTypeRequiredDescription
check_idstringYesThe check ID to update.
conclusionstringNoCheck conclusion: succeeded, failed, skipped, canceled.
deployment_idstringYesThe deployment ID the check belongs to.
detailsUrlstringNoURL where users can view check details.
statusstringNoCheck status: running, completed.
team_idstringNoTeam ID if the deployment belongs to a team.

Returns all checks attached to a Vercel deployment (e.g. from third-party integrations).

NameTypeRequiredDescription
deployment_idstringYesThe deployment ID to list checks for.
team_idstringNoTeam ID if the deployment belongs to a team.

Returns all aliases assigned to a specific Vercel deployment.

NameTypeRequiredDescription
deployment_idstringYesThe deployment ID to get aliases for.
team_idstringNoTeam ID if the deployment belongs to a team.

Cancels a Vercel deployment that is currently building or queued.

NameTypeRequiredDescription
deployment_idstringYesThe deployment ID to cancel.
team_idstringNoTeam ID if the deployment belongs to a team.

Creates a new Vercel deployment for a project, optionally from a Git ref or with inline files.

NameTypeRequiredDescription
git_sourcestringNoJSON object with Git source info, e.g. {"type":"github","ref":"main","repoId":"123"}.
namestringYesThe project name to deploy.
targetstringNoDeployment target: production or preview. Default is preview.
team_idstringNoTeam ID if deploying to a team project.

Deletes a Vercel deployment by its ID.

NameTypeRequiredDescription
deployment_idstringYesThe deployment ID to delete.
team_idstringNoTeam ID if the deployment belongs to a team.

Returns build log events for a Vercel deployment. Useful for debugging build errors.

NameTypeRequiredDescription
deployment_idstringYesThe deployment ID to get events for.
limitintegerNoMaximum number of log events to return.
sinceintegerNoTimestamp in ms to fetch events after.
team_idstringNoTeam ID if the deployment belongs to a team.

Returns details of a specific Vercel deployment by its ID or URL, including build status, target, and metadata.

NameTypeRequiredDescription
id_or_urlstringYesThe deployment ID (dpl_xxx) or deployment URL.
team_idstringNoTeam ID if the deployment belongs to a team.

Returns a list of deployments for the authenticated user or a specific project/team, with filtering and pagination.

NameTypeRequiredDescription
fromintegerNoTimestamp in ms for pagination cursor.
limitintegerNoMaximum number of deployments to return.
project_idstringNoFilter deployments by project ID or name.
statestringNoFilter by deployment state: BUILDING, ERROR, INITIALIZING, QUEUED, READY, CANCELED.
targetstringNoFilter by target environment: production or preview.
team_idstringNoFilter deployments by team ID.

Creates a new DNS record for a domain managed by Vercel. Supports A, AAAA, CNAME, TXT, MX, SRV, and CAA records.

NameTypeRequiredDescription
domainstringYesThe domain to create the DNS record for.
mx_priorityintegerNoPriority for MX records.
namestringYesSubdomain name, or empty string for root domain.
team_idstringNoTeam ID if the domain belongs to a team.
ttlintegerNoTime-to-live in seconds. Default is 60.
typestringYesRecord type: A, AAAA, CNAME, TXT, MX, SRV, CAA.
valuestringYesThe record value (IP address, hostname, text, etc.).

Deletes a DNS record from a domain managed by Vercel.

NameTypeRequiredDescription
domainstringYesThe domain the DNS record belongs to.
record_idstringYesThe ID of the DNS record to delete.
team_idstringNoTeam ID if the domain belongs to a team.

Returns all DNS records for a domain managed by Vercel.

NameTypeRequiredDescription
domainstringYesThe domain to list DNS records for.
limitintegerNoMaximum number of records to return.
sinceintegerNoTimestamp in ms for pagination.
team_idstringNoTeam ID if the domain belongs to a team.

Adds a domain to the authenticated user or team’s Vercel account.

NameTypeRequiredDescription
namestringYesThe domain name to add.
team_idstringNoTeam ID to add the domain to.

Removes a domain from the authenticated user or team’s Vercel account.

NameTypeRequiredDescription
domainstringYesThe domain name to delete.
team_idstringNoTeam ID if the domain belongs to a team.

Returns information about a specific domain including verification status, nameservers, and registrar.

NameTypeRequiredDescription
domainstringYesThe domain name to look up.
team_idstringNoTeam ID if the domain belongs to a team.

Returns all domains registered or added to the authenticated user or team’s Vercel account.

NameTypeRequiredDescription
limitintegerNoMaximum number of domains to return.
sinceintegerNoTimestamp in ms for pagination.
team_idstringNoTeam ID to list domains for.

Creates a new Edge Config store for storing read-only configuration data close to users at the edge.

NameTypeRequiredDescription
slugstringYesA unique slug for the Edge Config store.
team_idstringNoTeam ID to create the Edge Config under.

Permanently deletes an Edge Config store and all its items.

NameTypeRequiredDescription
edge_config_idstringYesThe Edge Config store ID to delete.
team_idstringNoTeam ID if the Edge Config belongs to a team.

Returns details of a specific Edge Config store by its ID.

NameTypeRequiredDescription
edge_config_idstringYesThe Edge Config store ID.
team_idstringNoTeam ID if the Edge Config belongs to a team.

Returns the value of a specific item from an Edge Config store by key.

NameTypeRequiredDescription
edge_config_idstringYesThe Edge Config store ID.
item_keystringYesThe key of the item to retrieve.
team_idstringNoTeam ID if the Edge Config belongs to a team.

Returns all key-value items stored in an Edge Config store.

NameTypeRequiredDescription
edge_config_idstringYesThe Edge Config store ID.
team_idstringNoTeam ID if the Edge Config belongs to a team.

Creates, updates, or deletes items in an Edge Config store using a list of patch operations.

NameTypeRequiredDescription
edge_config_idstringYesThe Edge Config store ID.
itemsstringYesJSON array of patch operations. Each item has ‘operation’ (create/update/upsert/delete), ‘key’, and optionally ‘value’.
team_idstringNoTeam ID if the Edge Config belongs to a team.

Creates a new read token for an Edge Config store to be used in application code.

NameTypeRequiredDescription
edge_config_idstringYesThe Edge Config store ID.
labelstringYesA descriptive label for the token.
team_idstringNoTeam ID if the Edge Config belongs to a team.

Deletes one or more read tokens from an Edge Config store.

NameTypeRequiredDescription
edge_config_idstringYesThe Edge Config store ID.
team_idstringNoTeam ID if the Edge Config belongs to a team.
tokensstringYesJSON array of token IDs to delete.

Returns all read tokens for an Edge Config store.

NameTypeRequiredDescription
edge_config_idstringYesThe Edge Config store ID.
team_idstringNoTeam ID if the Edge Config belongs to a team.

Returns all Edge Config stores for the authenticated user or team.

NameTypeRequiredDescription
team_idstringNoTeam ID to list Edge Configs for.

Creates a new environment variable for a Vercel project with the specified key, value, and target environments.

NameTypeRequiredDescription
id_or_namestringYesThe project ID or name.
keystringYesThe environment variable key.
targetstringNoJSON array of targets: production, preview, development. Defaults to all.
team_idstringNoTeam ID if the project belongs to a team.
typestringNoVariable type: plain or secret. Default is plain.
valuestringYesThe environment variable value.

Deletes an environment variable from a Vercel project.

NameTypeRequiredDescription
env_idstringYesThe environment variable ID to delete.
id_or_namestringYesThe project ID or name.
team_idstringNoTeam ID if the project belongs to a team.

Updates an existing environment variable for a Vercel project.

NameTypeRequiredDescription
env_idstringYesThe environment variable ID to update.
id_or_namestringYesThe project ID or name.
targetstringNoJSON array of new targets: production, preview, development.
team_idstringNoTeam ID if the project belongs to a team.
valuestringNoNew value for the environment variable.

Returns all environment variables for a Vercel project, including their targets (production, preview, development) and encryption status.

NameTypeRequiredDescription
decryptbooleanNoIf true, returns decrypted values for sensitive variables.
id_or_namestringYesThe project ID or name.
team_idstringNoTeam ID if the project belongs to a team.

Creates a new Vercel project with a given name, framework, and optional Git repository.

NameTypeRequiredDescription
frameworkstringNoFramework preset, e.g. nextjs, vite, gatsby, nuxtjs, create-react-app.
git_repositorystringNoJSON object with ‘type’ (github/gitlab/bitbucket) and ‘repo’ (owner/name) fields.
namestringYesThe name of the project.
root_directorystringNoRoot directory of the project within the repository.
team_idstringNoTeam ID to create the project under.

Permanently deletes a Vercel project and all its deployments, domains, and environment variables.

NameTypeRequiredDescription
id_or_namestringYesThe project ID or name to delete.
team_idstringNoTeam ID if the project belongs to a team.

Assigns a domain to a Vercel project with an optional redirect target.

NameTypeRequiredDescription
git_branchstringNoGit branch to associate this domain with for preview deployments.
id_or_namestringYesThe project ID or name.
namestringYesThe domain name to assign to the project.
redirectstringNoRedirect target domain if this domain should redirect.
team_idstringNoTeam ID if the project belongs to a team.

Removes a domain assignment from a Vercel project.

NameTypeRequiredDescription
domainstringYesThe domain name to remove from the project.
id_or_namestringYesThe project ID or name.
team_idstringNoTeam ID if the project belongs to a team.

Returns all domains assigned to a specific Vercel project.

NameTypeRequiredDescription
id_or_namestringYesThe project ID or name.
productionbooleanNoFilter to production domains only.
team_idstringNoTeam ID if the project belongs to a team.

Returns details of a specific Vercel project including its framework, Git repository, environment variables summary, and domains.

NameTypeRequiredDescription
id_or_namestringYesThe project ID or name.
team_idstringNoTeam ID if the project belongs to a team.

Updates a Vercel project’s name, framework, build command, output directory, or other settings.

NameTypeRequiredDescription
build_commandstringNoCustom build command override.
frameworkstringNoFramework preset to apply.
id_or_namestringYesThe project ID or name to update.
install_commandstringNoCustom install command override.
namestringNoNew project name.
output_directorystringNoCustom output directory override.
team_idstringNoTeam ID if the project belongs to a team.

Returns all projects for the authenticated user or team, with optional search and pagination.

NameTypeRequiredDescription
fromintegerNoTimestamp in ms for pagination cursor.
limitintegerNoMaximum number of projects to return.
searchstringNoFilter projects by name search query.
team_idstringNoTeam ID to list projects for. Omit for personal projects.

Creates a new Vercel team with the specified slug and optional name.

NameTypeRequiredDescription
namestringNoDisplay name for the team.
slugstringYesA unique URL-friendly identifier for the team.

Permanently deletes a Vercel team and all its associated resources.

NameTypeRequiredDescription
team_idstringYesThe team ID or slug to delete.

Returns details of a specific Vercel team by its ID or slug.

NameTypeRequiredDescription
team_idstringYesThe team ID or slug.

Invites a user to a Vercel team by email address with a specified role.

NameTypeRequiredDescription
emailstringYesEmail address of the user to invite.
rolestringNoRole to assign: OWNER, MEMBER, VIEWER, DEVELOPER, BILLING.
team_idstringYesThe team ID or slug.

Removes a member from a Vercel team by their user ID.

NameTypeRequiredDescription
team_idstringYesThe team ID or slug.
user_idstringYesThe user ID of the member to remove.

Returns all members of a Vercel team including their roles and join dates.

NameTypeRequiredDescription
limitintegerNoMaximum number of members to return.
rolestringNoFilter by role: OWNER, MEMBER, VIEWER, DEVELOPER, BILLING.
sinceintegerNoTimestamp in ms to fetch members joined after this time.
team_idstringYesThe team ID or slug.

Updates a Vercel team’s name, slug, description, or other settings.

NameTypeRequiredDescription
descriptionstringNoNew description for the team.
namestringNoNew display name for the team.
slugstringNoNew URL-friendly slug for the team.
team_idstringYesThe team ID or slug to update.

Returns all teams the authenticated user belongs to, with pagination support.

NameTypeRequiredDescription
limitintegerNoMaximum number of teams to return.
sinceintegerNoTimestamp in milliseconds to fetch teams created after this time.
untilintegerNoTimestamp in milliseconds to fetch teams created before this time.

Returns the authenticated user’s profile including name, email, username, and account details.

Creates a new webhook that sends event notifications to the specified URL for Vercel deployment and project events.

NameTypeRequiredDescription
eventsstringYesJSON array of event types to subscribe to, e.g. [“deployment.created”,“deployment.succeeded”].
project_idsstringNoJSON array of project IDs to scope this webhook to. Omit for all projects.
team_idstringNoTeam ID to create the webhook for.
urlstringYesThe HTTPS endpoint URL to receive webhook payloads.

Permanently deletes a Vercel webhook.

NameTypeRequiredDescription
team_idstringNoTeam ID if the webhook belongs to a team.
webhook_idstringYesThe webhook ID to delete.

Returns details of a specific Vercel webhook by its ID.

NameTypeRequiredDescription
team_idstringNoTeam ID if the webhook belongs to a team.
webhook_idstringYesThe webhook ID.

Returns all webhooks configured for the authenticated user or team.

NameTypeRequiredDescription
team_idstringNoTeam ID to list webhooks for.