Vercel

使用说明

Integrate with Vercel to manage deployments, projects, domains, DNS records, environment variables, aliases, edge configs, teams, and more.

工具

`vercel_list_deployments`

List deployments for a Vercel project or team

输入

参数	类型	必填	描述
`apiKey`	string	是	Vercel Access Token
`projectId`	string	否	Filter deployments by project ID or name
`target`	string	否	Filter by environment: production or staging
`state`	string	否	Filter by state: BUILDING, ERROR, INITIALIZING, QUEUED, READY, CANCELED
`app`	string	否	Filter by deployment name
`since`	number	否	Get deployments created after this JavaScript timestamp
`until`	number	否	Get deployments created before this JavaScript timestamp
`limit`	number	否	Maximum number of deployments to return per request
`teamId`	string	否	Team ID to scope the request

输出

参数	类型	描述
`deployments`	array	List of deployments
↳ `uid`	string	Unique deployment identifier
↳ `name`	string	Deployment name
↳ `url`	string	Deployment URL
↳ `state`	string	Deployment state: BUILDING, ERROR, INITIALIZING, QUEUED, READY, CANCELED, DELETED
↳ `target`	string	Target environment
↳ `created`	number	Creation timestamp
↳ `projectId`	string	Associated project ID
↳ `source`	string	Deployment source: api-trigger-git-deploy, cli, clone/repo, git, import, import/repo, redeploy, v0-web
↳ `inspectorUrl`	string	Vercel inspector URL
↳ `creator`	object	Creator information
↳ `uid`	string	Creator user ID
↳ `email`	string	Creator email
↳ `username`	string	Creator username
↳ `meta`	object	Git provider metadata (key-value strings)
`count`	number	Number of deployments returned
`hasMore`	boolean	Whether more deployments are available

`vercel_get_deployment`

Get details of a specific Vercel deployment

输入

参数	类型	必填	描述
`apiKey`	string	是	Vercel Access Token
`deploymentId`	string	是	The unique deployment identifier or hostname
`withGitRepoInfo`	string	否	Whether to add in gitRepo information (true/false)
`teamId`	string	否	Team ID to scope the request

输出

参数	类型	描述
`id`	string	Deployment ID
`name`	string	Deployment name
`url`	string	Unique deployment URL
`readyState`	string	Deployment ready state: QUEUED, BUILDING, ERROR, INITIALIZING, READY, CANCELED
`status`	string	Deployment status
`target`	string	Target environment
`createdAt`	number	Creation timestamp in milliseconds
`buildingAt`	number	Build start timestamp
`ready`	number	Ready timestamp
`source`	string	Deployment source: cli, git, redeploy, import, v0-web, etc.
`alias`	array	Assigned aliases
`regions`	array	Deployment regions
`inspectorUrl`	string	Vercel inspector URL
`projectId`	string	Associated project ID
`creator`	object	Creator information
↳ `uid`	string	Creator user ID
↳ `username`	string	Creator username
`project`	object	Associated project
↳ `id`	string	Project ID
↳ `name`	string	Project name
↳ `framework`	string	Project framework
`meta`	object	Deployment metadata (key-value strings)
↳ `githubCommitSha`	string	GitHub commit SHA
↳ `githubCommitMessage`	string	GitHub commit message
↳ `githubCommitRef`	string	GitHub branch/ref
↳ `githubRepo`	string	GitHub repository
↳ `githubOrg`	string	GitHub organization
↳ `githubCommitAuthorName`	string	Commit author name
`gitSource`	object	Git source information
↳ `type`	string	Git provider type (e.g., github, gitlab, bitbucket)
↳ `ref`	string	Git ref (branch or tag)
↳ `sha`	string	Git commit SHA
↳ `repoId`	string	Repository ID

`vercel_create_deployment`

Create a new deployment or redeploy an existing one

输入

参数	类型	必填	描述
`apiKey`	string	是	Vercel Access Token
`name`	string	是	Project name for the deployment
`project`	string	否	Project ID (overrides name for project lookup)
`deploymentId`	string	否	Existing deployment ID to redeploy
`target`	string	否	Target environment: production, staging, or a custom environment identifier
`gitSource`	string	否	JSON string defining the Git Repository source to deploy (e.g. {"type":"github","repo":"owner/repo","ref":"main"})
`forceNew`	string	否	Forces a new deployment even if there is a previous similar deployment (0 or 1)
`teamId`	string	否	Team ID to scope the request

输出

参数	类型	描述
`id`	string	Deployment ID
`name`	string	Deployment name
`url`	string	Unique deployment URL
`readyState`	string	Deployment ready state: QUEUED, BUILDING, ERROR, INITIALIZING, READY, CANCELED
`projectId`	string	Associated project ID
`createdAt`	number	Creation timestamp in milliseconds
`alias`	array	Assigned aliases
`target`	string	Target environment
`inspectorUrl`	string	Vercel inspector URL

`vercel_cancel_deployment`

Cancel a running Vercel deployment

输入

参数	类型	必填	描述
`apiKey`	string	是	Vercel Access Token
`deploymentId`	string	是	The deployment ID to cancel
`teamId`	string	否	Team ID to scope the request

输出

参数	类型	描述
`id`	string	Deployment ID
`name`	string	Deployment name
`state`	string	Deployment state after cancellation
`url`	string	Deployment URL

`vercel_delete_deployment`

Delete a Vercel deployment

输入

参数	类型	必填	描述
`apiKey`	string	是	Vercel Access Token
`deploymentId`	string	是	The deployment ID or URL to delete
`teamId`	string	否	Team ID to scope the request

输出

参数	类型	描述
`uid`	string	The removed deployment ID
`state`	string	Deployment state after deletion (DELETED)

`vercel_get_deployment_events`

Get build and runtime events for a Vercel deployment

输入

参数	类型	必填	描述
`apiKey`	string	是	Vercel Access Token
`deploymentId`	string	是	The unique deployment identifier or hostname
`direction`	string	否	Order of events by timestamp: backward or forward (default: forward)
`follow`	number	否	When set to 1, returns live events as they happen
`limit`	number	否	Maximum number of events to return (-1 for all)
`since`	number	否	Timestamp to start pulling build logs from
`until`	number	否	Timestamp to stop pulling build logs at
`teamId`	string	否	Team ID to scope the request

输出

参数	类型	描述
`events`	array	List of deployment events
↳ `type`	string	Event type: delimiter, command, stdout, stderr, exit, deployment-state, middleware, middleware-invocation, edge-function-invocation, metric, report, fatal
↳ `created`	number	Event creation timestamp
↳ `date`	number	Event date timestamp
↳ `text`	string	Event text content
↳ `serial`	string	Event serial identifier
↳ `deploymentId`	string	Associated deployment ID
↳ `id`	string	Event unique identifier
↳ `level`	string	Event level: error or warning
`count`	number	Number of events returned

`vercel_list_deployment_files`

List files in a Vercel deployment

输入

参数	类型	必填	描述
`apiKey`	string	是	Vercel Access Token
`deploymentId`	string	是	The deployment ID to list files for
`teamId`	string	否	Team ID to scope the request

输出

参数	类型	描述
`files`	array	List of deployment files
↳ `name`	string	The name of the file tree entry
↳ `type`	string	File type: directory, file, symlink, lambda, middleware, or invalid
↳ `uid`	string	Unique file identifier (only valid for file type)
↳ `mode`	number	File mode indicating file type and permissions
↳ `contentType`	string	Content-type of the file (only valid for file type)
↳ `children`	array	Child files of the directory (only valid for directory type)
↳ `name`	string	File name
↳ `type`	string	Entry type
↳ `uid`	string	File identifier
`count`	number	Number of files returned

`vercel_promote_deployment`

Promote a deployment by pointing the production deployment to the given deployment

输入

参数	类型	必填	描述
`apiKey`	string	是	Vercel Access Token
`projectId`	string	是	Project ID or name
`deploymentId`	string	是	The ID of the deployment to promote to production
`teamId`	string	否	Team ID to scope the request

输出

参数	类型	描述
`promoted`	boolean	Whether the deployment was promoted to production

`vercel_list_projects`

List all projects in a Vercel team or account

输入

参数	类型	必填	描述
`apiKey`	string	是	Vercel Access Token
`search`	string	否	Search projects by name
`limit`	number	否	Maximum number of projects to return
`teamId`	string	否	Team ID to scope the request

输出

参数	类型	描述
`projects`	array	List of projects
↳ `id`	string	Project ID
↳ `name`	string	Project name
↳ `framework`	string	Framework
↳ `createdAt`	number	Creation timestamp
↳ `updatedAt`	number	Last updated timestamp
↳ `domains`	array	Project domains
`count`	number	Number of projects returned
`hasMore`	boolean	Whether more projects are available

`vercel_get_project`

Get details of a specific Vercel project

输入

参数	类型	必填	描述
`apiKey`	string	是	Vercel Access Token
`projectId`	string	是	Project ID or name
`teamId`	string	否	Team ID to scope the request

输出

参数	类型	描述
`id`	string	Project ID
`name`	string	Project name
`framework`	string	Project framework
`createdAt`	number	Creation timestamp
`updatedAt`	number	Last updated timestamp
`domains`	array	Project domains
`link`	object	Git repository connection
↳ `type`	string	Repository type (github, gitlab, bitbucket)
↳ `repo`	string	Repository name
↳ `org`	string	Organization or owner

`vercel_create_project`

Create a new Vercel project

输入

参数	类型	必填	描述
`apiKey`	string	是	Vercel Access Token
`name`	string	是	Project name
`framework`	string	否	Project framework (e.g. nextjs, remix, vite)
`gitRepository`	json	否	Git repository connection object with type and repo
`buildCommand`	string	否	Custom build command
`outputDirectory`	string	否	Custom output directory
`installCommand`	string	否	Custom install command
`teamId`	string	否	Team ID to scope the request

输出

参数	类型	描述
`id`	string	Project ID
`name`	string	Project name
`framework`	string	Project framework
`createdAt`	number	Creation timestamp
`updatedAt`	number	Last updated timestamp

`vercel_update_project`

Update an existing Vercel project

输入

参数	类型	必填	描述
`apiKey`	string	是	Vercel Access Token
`projectId`	string	是	Project ID or name
`name`	string	否	New project name
`framework`	string	否	Project framework (e.g. nextjs, remix, vite)
`buildCommand`	string	否	Custom build command
`outputDirectory`	string	否	Custom output directory
`installCommand`	string	否	Custom install command
`teamId`	string	否	Team ID to scope the request

输出

参数	类型	描述
`id`	string	Project ID
`name`	string	Project name
`framework`	string	Project framework
`updatedAt`	number	Last updated timestamp

`vercel_delete_project`

Delete a Vercel project

输入

参数	类型	必填	描述
`apiKey`	string	是	Vercel Access Token
`projectId`	string	是	Project ID or name
`teamId`	string	否	Team ID to scope the request

输出

参数	类型	描述
`deleted`	boolean	Whether the project was successfully deleted

`vercel_pause_project`

Pause a Vercel project

输入

参数	类型	必填	描述
`apiKey`	string	是	Vercel Access Token
`projectId`	string	是	Project ID or name
`teamId`	string	否	Team ID to scope the request

输出

参数	类型	描述
`id`	string	Project ID
`name`	string	Project name
`paused`	boolean	Whether the project is paused

`vercel_unpause_project`

Unpause a Vercel project

输入

参数	类型	必填	描述
`apiKey`	string	是	Vercel Access Token
`projectId`	string	是	Project ID or name
`teamId`	string	否	Team ID to scope the request

输出

参数	类型	描述
`id`	string	Project ID
`name`	string	Project name
`paused`	boolean	Whether the project is paused

`vercel_list_project_domains`

List all domains for a Vercel project

输入

参数	类型	必填	描述
`apiKey`	string	是	Vercel Access Token
`projectId`	string	是	Project ID or name
`teamId`	string	否	Team ID to scope the request
`limit`	number	否	Maximum number of domains to return

输出

参数	类型	描述
`domains`	array	List of project domains
↳ `name`	string	Domain name
↳ `apexName`	string	Apex domain name
↳ `redirect`	string	Redirect target
↳ `redirectStatusCode`	number	Redirect status code
↳ `verified`	boolean	Whether the domain is verified
↳ `gitBranch`	string	Git branch for the domain
↳ `createdAt`	number	Creation timestamp
↳ `updatedAt`	number	Last updated timestamp
`count`	number	Number of domains returned
`hasMore`	boolean	Whether more domains are available

`vercel_add_project_domain`

Add a domain to a Vercel project

输入

参数	类型	必填	描述
`apiKey`	string	是	Vercel Access Token
`projectId`	string	是	Project ID or name
`domain`	string	是	Domain name to add
`redirect`	string	否	Target domain for redirect
`redirectStatusCode`	number	否	HTTP status code for redirect (301, 302, 307, 308)
`gitBranch`	string	否	Git branch to link the domain to
`teamId`	string	否	Team ID to scope the request

输出

参数	类型	描述
`name`	string	Domain name
`apexName`	string	Apex domain name
`verified`	boolean	Whether the domain is verified
`gitBranch`	string	Git branch for the domain
`redirect`	string	Redirect target domain
`redirectStatusCode`	number	HTTP status code for redirect (301, 302, 307, 308)
`createdAt`	number	Creation timestamp
`updatedAt`	number	Last updated timestamp

`vercel_remove_project_domain`

Remove a domain from a Vercel project

输入

参数	类型	必填	描述
`apiKey`	string	是	Vercel Access Token
`projectId`	string	是	Project ID or name
`domain`	string	是	Domain name to remove
`teamId`	string	否	Team ID to scope the request

输出

参数	类型	描述
`deleted`	boolean	Whether the domain was successfully removed

`vercel_update_project_domain`

Update a project domain

输入

参数	类型	必填	描述
`apiKey`	string	是	Vercel Access Token
`projectId`	string	是	Project ID or name
`domain`	string	是	Domain name to update
`redirect`	string	否	Target destination domain for redirect
`redirectStatusCode`	number	否	HTTP status code for redirect (301, 302, 307, 308)
`gitBranch`	string	否	Git branch to link the domain to
`teamId`	string	否	Team ID to scope the request

输出

参数	类型	描述
`name`	string	Domain name
`apexName`	string	Apex domain name
`projectId`	string	Project ID the domain belongs to
`verified`	boolean	Whether the domain is verified
`redirect`	string	Redirect target domain
`redirectStatusCode`	number	HTTP status code for redirect (301, 302, 307, 308)
`gitBranch`	string	Git branch for the domain
`verification`	array	Domain verification challenges (type, domain, value, reason)
↳ `type`	string	Challenge type
↳ `domain`	string	Domain to add the record to
↳ `value`	string	Expected record value
↳ `reason`	string	Why verification is needed
`createdAt`	number	Creation timestamp
`updatedAt`	number	Last updated timestamp

`vercel_verify_project_domain`

Verify a Vercel project domain by checking its verification challenge

输入

参数	类型	必填	描述
`apiKey`	string	是	Vercel Access Token
`projectId`	string	是	Project ID or name
`domain`	string	是	Domain name to verify
`teamId`	string	否	Team ID to scope the request

输出

参数	类型	描述
`name`	string	Domain name
`apexName`	string	Apex domain name
`projectId`	string	Project ID
`verified`	boolean	Whether the domain is verified
`redirect`	string	Redirect target domain
`redirectStatusCode`	number	Redirect status code (301, 302, 307, 308)
`gitBranch`	string	Git branch linked to the domain
`createdAt`	number	Creation timestamp
`updatedAt`	number	Last update timestamp

`vercel_get_env_vars`

Retrieve environment variables for a Vercel project

输入

参数	类型	必填	描述
`apiKey`	string	是	Vercel Access Token
`projectId`	string	是	Project ID or name
`teamId`	string	否	Team ID to scope the request

输出

参数	类型	描述
`envs`	array	List of environment variables
↳ `id`	string	Environment variable ID
↳ `key`	string	Variable name
↳ `value`	string	Variable value
↳ `type`	string	Variable type (secret, system, encrypted, plain, sensitive)
↳ `target`	array	Target environments
↳ `gitBranch`	string	Git branch filter
↳ `comment`	string	Comment providing context for the variable
`count`	number	Number of environment variables returned

`vercel_create_env_var`

Create an environment variable for a Vercel project

输入

参数	类型	必填	描述
`apiKey`	string	是	Vercel Access Token
`projectId`	string	是	Project ID or name
`key`	string	是	Environment variable name
`value`	string	是	Environment variable value
`target`	string	是	Comma-separated list of target environments (production, preview, development)
`type`	string	否	Variable type: system, secret, encrypted, plain, or sensitive (default: plain)
`gitBranch`	string	否	Git branch to associate with the variable (requires target to include preview)
`comment`	string	否	Comment to add context to the variable (max 500 characters)
`teamId`	string	否	Team ID to scope the request

输出

参数	类型	描述
`id`	string	Environment variable ID
`key`	string	Variable name
`value`	string	Variable value
`type`	string	Variable type (secret, system, encrypted, plain, sensitive)
`target`	array	Target environments
`gitBranch`	string	Git branch filter
`comment`	string	Comment providing context for the variable

`vercel_update_env_var`

Update an environment variable for a Vercel project

输入

参数	类型	必填	描述
`apiKey`	string	是	Vercel Access Token
`projectId`	string	是	Project ID or name
`envId`	string	是	Environment variable ID to update
`key`	string	否	New variable name
`value`	string	否	New variable value
`target`	string	否	Comma-separated list of target environments (production, preview, development)
`type`	string	否	Variable type: system, secret, encrypted, plain, or sensitive
`gitBranch`	string	否	Git branch to associate with the variable (requires target to include preview)
`comment`	string	否	Comment to add context to the variable (max 500 characters)
`teamId`	string	否	Team ID to scope the request

输出

参数	类型	描述
`id`	string	Environment variable ID
`key`	string	Variable name
`value`	string	Variable value
`type`	string	Variable type (secret, system, encrypted, plain, sensitive)
`target`	array	Target environments
`gitBranch`	string	Git branch filter
`comment`	string	Comment providing context for the variable

`vercel_delete_env_var`

Delete an environment variable from a Vercel project

输入

参数	类型	必填	描述
`apiKey`	string	是	Vercel Access Token
`projectId`	string	是	Project ID or name
`envId`	string	是	Environment variable ID to delete
`teamId`	string	否	Team ID to scope the request

输出

参数	类型	描述
`deleted`	boolean	Whether the environment variable was successfully deleted

`vercel_list_domains`

List all domains in a Vercel account or team

输入

参数	类型	必填	描述
`apiKey`	string	是	Vercel Access Token
`limit`	number	否	Maximum number of domains to return (default 20)
`teamId`	string	否	Team ID to scope the request

输出

参数	类型	描述
`domains`	array	List of domains
↳ `id`	string	Domain ID
↳ `name`	string	Domain name
↳ `verified`	boolean	Whether domain is verified
↳ `createdAt`	number	Creation timestamp
↳ `expiresAt`	number	Expiration timestamp
↳ `serviceType`	string	Service type (zeit.world, external, na)
↳ `nameservers`	array	Current nameservers
↳ `intendedNameservers`	array	Intended nameservers
↳ `renew`	boolean	Whether auto-renewal is enabled
↳ `boughtAt`	number	Purchase timestamp
`count`	number	Number of domains returned
`hasMore`	boolean	Whether more domains are available

`vercel_get_domain`

Get information about a specific domain in a Vercel account

输入

参数	类型	必填	描述
`apiKey`	string	是	Vercel Access Token
`domain`	string	是	The domain name to retrieve
`teamId`	string	否	Team ID to scope the request

输出

参数	类型	描述
`id`	string	Domain ID
`name`	string	Domain name
`verified`	boolean	Whether domain is verified
`createdAt`	number	Creation timestamp
`expiresAt`	number	Expiration timestamp
`serviceType`	string	Service type (zeit.world, external, na)
`nameservers`	array	Current nameservers
`intendedNameservers`	array	Intended nameservers
`customNameservers`	array	Custom nameservers
`renew`	boolean	Whether auto-renewal is enabled
`boughtAt`	number	Purchase timestamp
`transferredAt`	number	Transfer completion timestamp

`vercel_add_domain`

Add a new domain to a Vercel account or team

输入

参数	类型	必填	描述
`apiKey`	string	是	Vercel Access Token
`name`	string	是	The domain name to add
`teamId`	string	否	Team ID to scope the request

输出

参数	类型	描述
`id`	string	Domain ID
`name`	string	Domain name
`verified`	boolean	Whether domain is verified
`createdAt`	number	Creation timestamp
`serviceType`	string	Service type (zeit.world, external, na)
`nameservers`	array	Current nameservers
`intendedNameservers`	array	Intended nameservers

`vercel_delete_domain`

Delete a domain from a Vercel account or team

输入

参数	类型	必填	描述
`apiKey`	string	是	Vercel Access Token
`domain`	string	是	The domain name to delete
`teamId`	string	否	Team ID to scope the request

输出

参数	类型	描述
`uid`	string	The ID of the deleted domain
`deleted`	boolean	Whether the domain was deleted

`vercel_get_domain_config`

Get the configuration for a domain in a Vercel account

输入

参数	类型	必填	描述
`apiKey`	string	是	Vercel Access Token
`domain`	string	是	The domain name to get configuration for
`teamId`	string	否	Team ID to scope the request

输出

参数	类型	描述
`configuredBy`	string	How the domain is configured (CNAME, A, http, dns-01, or null)
`acceptedChallenges`	array	Accepted challenge types for certificate issuance (dns-01, http-01)
`misconfigured`	boolean	Whether the domain is misconfigured for TLS certificate generation
`recommendedIPv4`	array	Recommended IPv4 addresses with rank values
↳ `rank`	number	Priority rank (1 is preferred)
↳ `value`	array	IPv4 addresses
`recommendedCNAME`	array	Recommended CNAME records with rank values
↳ `rank`	number	Priority rank (1 is preferred)
↳ `value`	string	CNAME value

`vercel_list_dns_records`

List all DNS records for a domain in a Vercel account

输入

参数	类型	必填	描述
`apiKey`	string	是	Vercel Access Token
`domain`	string	是	The domain name to list records for
`limit`	number	否	Maximum number of records to return
`teamId`	string	否	Team ID to scope the request

输出

参数	类型	描述
`records`	array	List of DNS records
↳ `id`	string	Record ID
↳ `slug`	string	Record slug
↳ `name`	string	Record name
↳ `type`	string	Record type (A, AAAA, ALIAS, CAA, CNAME, HTTPS, MX, SRV, TXT, NS)
↳ `value`	string	Record value
↳ `ttl`	number	Time to live in seconds
↳ `mxPriority`	number	MX record priority
↳ `priority`	number	Record priority
↳ `creator`	string	Creator identifier
↳ `createdAt`	number	Creation timestamp
↳ `updatedAt`	number	Last update timestamp
↳ `comment`	string	Record comment
`count`	number	Number of records returned
`hasMore`	boolean	Whether more records are available

`vercel_create_dns_record`

Create a DNS record for a domain in a Vercel account

输入

参数	类型	必填	描述
`apiKey`	string	是	Vercel Access Token
`domain`	string	是	The domain name to create the record for
`recordName`	string	是	The subdomain or record name
`recordType`	string	是	DNS record type (A, AAAA, ALIAS, CAA, CNAME, HTTPS, MX, SRV, TXT, NS)
`value`	string	是	The value of the DNS record
`ttl`	number	否	Time to live in seconds
`mxPriority`	number	否	Priority for MX records
`teamId`	string	否	Team ID to scope the request

输出

参数	类型	描述
`uid`	string	The DNS record ID
`updated`	number	Timestamp of the update

`vercel_update_dns_record`

Update an existing DNS record for a domain in a Vercel account

输入

参数	类型	必填	描述
`apiKey`	string	是	Vercel Access Token
`recordId`	string	是	The ID of the DNS record to update
`name`	string	否	The name of the DNS record
`value`	string	否	The value of the DNS record
`type`	string	否	DNS record type (A, AAAA, ALIAS, CAA, CNAME, HTTPS, MX, SRV, TXT, NS)
`ttl`	number	否	Time to live in seconds (60 to 2147483647)
`mxPriority`	number	否	Priority for MX records
`comment`	string	否	A comment to add context on what this DNS record is for (max 500 characters)
`teamId`	string	否	Team ID to scope the request

输出

参数	类型	描述
`id`	string	The DNS record ID
`name`	string	The name of the DNS record
`type`	string	The record class (record or record-sys)
`value`	string	The value of the DNS record
`creator`	string	The creator of the DNS record
`domain`	string	The domain the record belongs to
`ttl`	number	Time to live in seconds
`comment`	string	Comment providing context for the record
`recordType`	string	DNS record type (A, AAAA, ALIAS, CAA, CNAME, HTTPS, MX, NS, SRV, TXT)
`createdAt`	number	Timestamp of record creation

`vercel_delete_dns_record`

Delete a DNS record for a domain in a Vercel account

输入

参数	类型	必填	描述
`apiKey`	string	是	Vercel Access Token
`domain`	string	是	The domain name the record belongs to
`recordId`	string	是	The ID of the DNS record to delete
`teamId`	string	否	Team ID to scope the request

输出

参数	类型	描述
`deleted`	boolean	Whether the record was deleted

`vercel_list_aliases`

List aliases for a Vercel project or team

输入

参数	类型	必填	描述
`apiKey`	string	是	Vercel Access Token
`projectId`	string	否	Filter aliases by project ID
`domain`	string	否	Filter aliases by domain
`limit`	number	否	Maximum number of aliases to return
`teamId`	string	否	Team ID to scope the request

输出

参数	类型	描述
`aliases`	array	List of aliases
↳ `uid`	string	Alias ID
↳ `alias`	string	Alias hostname
↳ `deploymentId`	string	Associated deployment ID
↳ `projectId`	string	Associated project ID
↳ `createdAt`	number	Creation timestamp in milliseconds
↳ `updatedAt`	number	Last update timestamp in milliseconds
`count`	number	Number of aliases returned
`hasMore`	boolean	Whether more aliases are available

`vercel_get_alias`

Get details about a specific alias by ID or hostname

输入

参数	类型	必填	描述
`apiKey`	string	是	Vercel Access Token
`aliasId`	string	是	Alias ID or hostname to look up
`teamId`	string	否	Team ID to scope the request

输出

参数	类型	描述
`uid`	string	Alias ID
`alias`	string	Alias hostname
`deploymentId`	string	Associated deployment ID
`projectId`	string	Associated project ID
`createdAt`	number	Creation timestamp in milliseconds
`updatedAt`	number	Last update timestamp in milliseconds
`redirect`	string	Target domain for redirect aliases
`redirectStatusCode`	number	HTTP status code for redirect (301, 302, 307, or 308)

`vercel_create_alias`

Assign an alias (domain/subdomain) to a deployment

输入

参数	类型	必填	描述
`apiKey`	string	是	Vercel Access Token
`deploymentId`	string	是	Deployment ID to assign the alias to
`alias`	string	是	The domain or subdomain to assign as an alias
`teamId`	string	否	Team ID to scope the request

输出

参数	类型	描述
`uid`	string	Alias ID
`alias`	string	Alias hostname
`created`	string	Creation timestamp as ISO 8601 date-time string
`oldDeploymentId`	string	ID of the previously aliased deployment, if the alias was reassigned

`vercel_delete_alias`

Delete an alias by its ID

输入

参数	类型	必填	描述
`apiKey`	string	是	Vercel Access Token
`aliasId`	string	是	Alias ID to delete
`teamId`	string	否	Team ID to scope the request

输出

参数	类型	描述
`status`	string	Deletion status (SUCCESS)

`vercel_list_edge_configs`

List all Edge Config stores for a team

输入

参数	类型	必填	描述
`apiKey`	string	是	Vercel Access Token
`teamId`	string	否	Team ID to scope the request

输出

参数	类型	描述
`edgeConfigs`	array	List of Edge Config stores
↳ `id`	string	Edge Config ID
↳ `slug`	string	Edge Config slug
↳ `ownerId`	string	Owner ID
↳ `digest`	string	Content digest hash
↳ `createdAt`	number	Creation timestamp
↳ `updatedAt`	number	Last update timestamp
↳ `itemCount`	number	Number of items
↳ `sizeInBytes`	number	Size in bytes
`count`	number	Number of Edge Configs returned

`vercel_get_edge_config`

Get details about a specific Edge Config store

输入

参数	类型	必填	描述
`apiKey`	string	是	Vercel Access Token
`edgeConfigId`	string	是	Edge Config ID to look up
`teamId`	string	否	Team ID to scope the request

输出

参数	类型	描述
`id`	string	Edge Config ID
`slug`	string	Edge Config slug
`ownerId`	string	Owner ID
`digest`	string	Content digest hash
`createdAt`	number	Creation timestamp
`updatedAt`	number	Last update timestamp
`itemCount`	number	Number of items
`sizeInBytes`	number	Size in bytes

`vercel_create_edge_config`

Create a new Edge Config store

输入

参数	类型	必填	描述
`apiKey`	string	是	Vercel Access Token
`slug`	string	是	The name/slug for the new Edge Config
`teamId`	string	否	Team ID to scope the request

输出

参数	类型	描述
`id`	string	Edge Config ID
`slug`	string	Edge Config slug
`ownerId`	string	Owner ID
`digest`	string	Content digest hash
`createdAt`	number	Creation timestamp
`updatedAt`	number	Last update timestamp
`itemCount`	number	Number of items
`sizeInBytes`	number	Size in bytes

`vercel_get_edge_config_items`

Get all items in an Edge Config store

输入

参数	类型	必填	描述
`apiKey`	string	是	Vercel Access Token
`edgeConfigId`	string	是	Edge Config ID to get items from
`teamId`	string	否	Team ID to scope the request

输出

参数	类型	描述
`items`	array	List of Edge Config items
↳ `key`	string	Item key
↳ `value`	json	Item value
↳ `description`	string	Item description
↳ `edgeConfigId`	string	Parent Edge Config ID
↳ `createdAt`	number	Creation timestamp
↳ `updatedAt`	number	Last update timestamp
`count`	number	Number of items returned

`vercel_update_edge_config_items`

Create, update, upsert, or delete items in an Edge Config store

输入

参数	类型	必填	描述
`apiKey`	string	是	Vercel Access Token
`edgeConfigId`	string	是	Edge Config ID to update items in
`items`	json	是	Array of operations: [{operation: "create"\|"update"\|"upsert"\|"delete", key: string, value?: any}]
`teamId`	string	否	Team ID to scope the request

输出

参数	类型	描述
`status`	string	Operation status

`vercel_delete_edge_config`

Delete an Edge Config store by ID

输入

参数	类型	必填	描述
`apiKey`	string	是	Vercel Access Token
`edgeConfigId`	string	是	Edge Config ID to delete
`teamId`	string	否	Team ID to scope the request

输出

参数	类型	描述
`deleted`	boolean	Whether the Edge Config was successfully deleted

`vercel_list_webhooks`

List webhooks for a Vercel project or team

输入

参数	类型	必填	描述
`apiKey`	string	是	Vercel Access Token
`projectId`	string	否	Filter webhooks by project ID
`teamId`	string	否	Team ID to scope the request

输出

参数	类型	描述
`webhooks`	array	List of webhooks
↳ `id`	string	Webhook ID
↳ `url`	string	Webhook URL
↳ `events`	array	Events the webhook listens to
↳ `ownerId`	string	Owner ID
↳ `projectIds`	array	Associated project IDs
↳ `createdAt`	number	Creation timestamp
↳ `updatedAt`	number	Last updated timestamp
`count`	number	Number of webhooks returned

`vercel_get_webhook`

Get details about a specific Vercel webhook

输入

参数	类型	必填	描述
`apiKey`	string	是	Vercel Access Token
`webhookId`	string	是	Webhook ID to look up
`teamId`	string	否	Team ID to scope the request

输出

参数	类型	描述
`id`	string	Webhook ID
`url`	string	Webhook URL
`events`	array	Events the webhook listens to
`ownerId`	string	Owner ID
`projectIds`	array	Associated project IDs
`createdAt`	number	Creation timestamp
`updatedAt`	number	Last updated timestamp

`vercel_create_webhook`

Create a new webhook for a Vercel team

输入

参数	类型	必填	描述
`apiKey`	string	是	Vercel Access Token
`url`	string	是	Webhook URL (must be https)
`events`	string	是	Comma-separated event names to subscribe to
`projectIds`	string	否	Comma-separated project IDs to scope the webhook to
`teamId`	string	是	Team ID to create the webhook for

输出

参数	类型	描述
`id`	string	Webhook ID
`url`	string	Webhook URL
`secret`	string	Webhook signing secret
`events`	array	Events the webhook listens to
`ownerId`	string	Owner ID
`projectIds`	array	Associated project IDs
`createdAt`	number	Creation timestamp
`updatedAt`	number	Last updated timestamp

`vercel_delete_webhook`

Delete a webhook from a Vercel team

输入

参数	类型	必填	描述
`apiKey`	string	是	Vercel Access Token
`webhookId`	string	是	The webhook ID to delete
`teamId`	string	否	Team ID to scope the request

输出

参数	类型	描述
`deleted`	boolean	Whether the webhook was successfully deleted

`vercel_create_check`

Create a new deployment check

输入

参数	类型	必填	描述
`apiKey`	string	是	Vercel Access Token
`deploymentId`	string	是	Deployment ID to create the check for
`name`	string	是	Name of the check (max 100 characters)
`blocking`	boolean	是	Whether the check blocks the deployment
`path`	string	否	Page path being checked
`detailsUrl`	string	否	URL with details about the check
`externalId`	string	否	External identifier for the check
`rerequestable`	boolean	否	Whether the check can be rerequested
`teamId`	string	否	Team ID to scope the request

输出

参数	类型	描述
`id`	string	Check ID
`name`	string	Check name
`status`	string	Check status: registered, running, or completed
`conclusion`	string	Check conclusion: canceled, failed, neutral, succeeded, skipped, or stale
`blocking`	boolean	Whether the check blocks the deployment
`deploymentId`	string	Associated deployment ID
`integrationId`	string	Associated integration ID
`externalId`	string	External identifier
`detailsUrl`	string	URL with details about the check
`path`	string	Page path being checked
`rerequestable`	boolean	Whether the check can be rerequested
`createdAt`	number	Creation timestamp in milliseconds
`updatedAt`	number	Last update timestamp in milliseconds
`startedAt`	number	Start timestamp in milliseconds
`completedAt`	number	Completion timestamp in milliseconds

`vercel_get_check`

Get details of a specific deployment check

输入

参数	类型	必填	描述
`apiKey`	string	是	Vercel Access Token
`deploymentId`	string	是	Deployment ID the check belongs to
`checkId`	string	是	Check ID to retrieve
`teamId`	string	否	Team ID to scope the request

输出

参数	类型	描述
`id`	string	Check ID
`name`	string	Check name
`status`	string	Check status: registered, running, or completed
`conclusion`	string	Check conclusion: canceled, failed, neutral, succeeded, skipped, or stale
`blocking`	boolean	Whether the check blocks the deployment
`deploymentId`	string	Associated deployment ID
`integrationId`	string	Associated integration ID
`externalId`	string	External identifier
`detailsUrl`	string	URL with details about the check
`path`	string	Page path being checked
`rerequestable`	boolean	Whether the check can be rerequested
`createdAt`	number	Creation timestamp in milliseconds
`updatedAt`	number	Last update timestamp in milliseconds
`startedAt`	number	Start timestamp in milliseconds
`completedAt`	number	Completion timestamp in milliseconds

`vercel_list_checks`

List all checks for a deployment

输入

参数	类型	必填	描述
`apiKey`	string	是	Vercel Access Token
`deploymentId`	string	是	Deployment ID to list checks for
`teamId`	string	否	Team ID to scope the request

输出

参数	类型	描述
`checks`	array	List of deployment checks
↳ `id`	string	Check ID
↳ `name`	string	Check name
↳ `status`	string	Check status
↳ `conclusion`	string	Check conclusion
↳ `blocking`	boolean	Whether the check blocks the deployment
↳ `deploymentId`	string	Associated deployment ID
↳ `integrationId`	string	Associated integration ID
↳ `externalId`	string	External identifier
↳ `detailsUrl`	string	URL with details about the check
↳ `path`	string	Page path being checked
↳ `rerequestable`	boolean	Whether the check can be rerequested
↳ `createdAt`	number	Creation timestamp
↳ `updatedAt`	number	Last update timestamp
↳ `startedAt`	number	Start timestamp
↳ `completedAt`	number	Completion timestamp
`count`	number	Total number of checks

`vercel_update_check`

Update an existing deployment check

输入

参数	类型	必填	描述
`apiKey`	string	是	Vercel Access Token
`deploymentId`	string	是	Deployment ID the check belongs to
`checkId`	string	是	Check ID to update
`name`	string	否	Updated name of the check
`status`	string	否	Updated status: running or completed
`conclusion`	string	否	Check conclusion: canceled, failed, neutral, succeeded, or skipped
`detailsUrl`	string	否	URL with details about the check
`externalId`	string	否	External identifier for the check
`path`	string	否	Page path being checked
`output`	string	否	JSON string with check output metrics
`teamId`	string	否	Team ID to scope the request

输出

参数	类型	描述
`id`	string	Check ID
`name`	string	Check name
`status`	string	Check status: registered, running, or completed
`conclusion`	string	Check conclusion: canceled, failed, neutral, succeeded, skipped, or stale
`blocking`	boolean	Whether the check blocks the deployment
`deploymentId`	string	Associated deployment ID
`integrationId`	string	Associated integration ID
`externalId`	string	External identifier
`detailsUrl`	string	URL with details about the check
`path`	string	Page path being checked
`rerequestable`	boolean	Whether the check can be rerequested
`createdAt`	number	Creation timestamp in milliseconds
`updatedAt`	number	Last update timestamp in milliseconds
`startedAt`	number	Start timestamp in milliseconds
`completedAt`	number	Completion timestamp in milliseconds

`vercel_rerequest_check`

Rerequest a deployment check

输入

参数	类型	必填	描述
`apiKey`	string	是	Vercel Access Token
`deploymentId`	string	是	Deployment ID the check belongs to
`checkId`	string	是	Check ID to rerequest
`teamId`	string	否	Team ID to scope the request

输出

参数	类型	描述
`rerequested`	boolean	Whether the check was successfully rerequested

`vercel_list_teams`

List all teams in a Vercel account

输入

参数	类型	必填	描述
`apiKey`	string	是	Vercel Access Token
`limit`	number	否	Maximum number of teams to return
`since`	number	否	Timestamp in milliseconds to only include teams created since then
`until`	number	否	Timestamp in milliseconds to only include teams created until then

输出

参数	类型	描述
`teams`	array	List of teams
↳ `id`	string	Team ID
↳ `slug`	string	Team slug
↳ `name`	string	Team name
↳ `avatar`	string	Avatar file ID
↳ `createdAt`	number	Creation timestamp in milliseconds
↳ `updatedAt`	number	Last update timestamp in milliseconds
↳ `creatorId`	string	User ID of team creator
↳ `membership`	object	Current user membership details
↳ `role`	string	Membership role
↳ `confirmed`	boolean	Whether membership is confirmed
↳ `created`	number	Membership creation timestamp
↳ `uid`	string	User ID of the member
↳ `teamId`	string	Team ID
`count`	number	Number of teams returned
`pagination`	object	Pagination information
↳ `count`	number	Items in current page
↳ `next`	number	Timestamp for next page request
↳ `prev`	number	Timestamp for previous page request

`vercel_get_team`

Get information about a specific Vercel team

输入

参数	类型	必填	描述
`apiKey`	string	是	Vercel Access Token
`teamId`	string	是	The team ID to retrieve

输出

参数	类型	描述
`id`	string	Team ID
`slug`	string	Team slug
`name`	string	Team name
`avatar`	string	Avatar file ID
`description`	string	Short team description
`createdAt`	number	Creation timestamp in milliseconds
`updatedAt`	number	Last update timestamp in milliseconds
`creatorId`	string	User ID of team creator
`membership`	object	Current user membership details
↳ `uid`	string	User ID of the member
↳ `teamId`	string	Team ID
↳ `role`	string	Membership role
↳ `confirmed`	boolean	Whether membership is confirmed
↳ `created`	number	Membership creation timestamp
↳ `createdAt`	number	Membership creation timestamp (milliseconds)
↳ `accessRequestedAt`	number	When access was requested
↳ `teamRoles`	array	Team role assignments
↳ `teamPermissions`	array	Team permission assignments

`vercel_list_team_members`

List all members of a Vercel team

输入

参数	类型	必填	描述
`apiKey`	string	是	Vercel Access Token
`teamId`	string	是	The team ID to list members for
`limit`	number	否	Maximum number of members to return
`role`	string	否	Filter by role (OWNER, MEMBER, DEVELOPER, SECURITY, BILLING, VIEWER, VIEWER_FOR_PLUS, CONTRIBUTOR)
`since`	number	否	Timestamp in milliseconds to only include members added since then
`until`	number	否	Timestamp in milliseconds to only include members added until then
`search`	string	否	Search team members by their name, username, and email

输出

参数	类型	描述
`members`	array	List of team members
↳ `uid`	string	Member user ID
↳ `email`	string	Member email
↳ `username`	string	Member username
↳ `name`	string	Member full name
↳ `avatar`	string	Avatar file ID
↳ `role`	string	Member role
↳ `confirmed`	boolean	Whether membership is confirmed
↳ `createdAt`	number	Join timestamp in milliseconds
↳ `joinedFrom`	object	Origin of how the member joined
↳ `origin`	string	Join origin identifier
`count`	number	Number of members returned
`pagination`	object	Pagination information
↳ `hasNext`	boolean	Whether there are more pages
↳ `count`	number	Items in current page

`vercel_get_user`

Get information about the authenticated Vercel user

输入

参数	类型	必填	描述
`apiKey`	string	是	Vercel Access Token

输出

参数	类型	描述
`id`	string	User ID
`email`	string	User email
`username`	string	Username
`name`	string	Display name
`avatar`	string	SHA1 hash of the avatar
`defaultTeamId`	string	Default team ID
`createdAt`	number	Account creation timestamp in milliseconds
`stagingPrefix`	string	Prefix for preview deployment URLs
`softBlock`	object	Account restriction details if blocked
↳ `blockedAt`	number	When the account was blocked
↳ `reason`	string	Reason for the block
`hasTrialAvailable`	boolean	Whether a trial is available