AptlyStar

Vercel

Manage Vercel deployments, projects, and infrastructure

Instructions d'utilisation

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

Outils

vercel_list_deployments

List deployments for a Vercel project or team

Entrée

ParamètreTypeObligatoireDescription
apiKeystringOuiVercel Access Token
projectIdstringNonFilter deployments by project ID or name
targetstringNonFilter by environment: production or staging
statestringNonFilter by state: BUILDING, ERROR, INITIALIZING, QUEUED, READY, CANCELED
appstringNonFilter by deployment name
sincenumberNonGet deployments created after this JavaScript timestamp
untilnumberNonGet deployments created before this JavaScript timestamp
limitnumberNonMaximum number of deployments to return per request
teamIdstringNonTeam ID to scope the request

Sortie

ParamètreTypeDescription
deploymentsarrayList of deployments
↳ uidstringUnique deployment identifier
↳ namestringDeployment name
↳ urlstringDeployment URL
↳ statestringDeployment state: BUILDING, ERROR, INITIALIZING, QUEUED, READY, CANCELED, DELETED
↳ targetstringTarget environment
↳ creatednumberCreation timestamp
↳ projectIdstringAssociated project ID
↳ sourcestringDeployment source: api-trigger-git-deploy, cli, clone/repo, git, import, import/repo, redeploy, v0-web
↳ inspectorUrlstringVercel inspector URL
↳ creatorobjectCreator information
↳ uidstringCreator user ID
↳ emailstringCreator email
↳ usernamestringCreator username
↳ metaobjectGit provider metadata (key-value strings)
countnumberNumber of deployments returned
hasMorebooleanWhether more deployments are available

vercel_get_deployment

Get details of a specific Vercel deployment

Entrée

ParamètreTypeObligatoireDescription
apiKeystringOuiVercel Access Token
deploymentIdstringOuiThe unique deployment identifier or hostname
withGitRepoInfostringNonWhether to add in gitRepo information (true/false)
teamIdstringNonTeam ID to scope the request

Sortie

ParamètreTypeDescription
idstringDeployment ID
namestringDeployment name
urlstringUnique deployment URL
readyStatestringDeployment ready state: QUEUED, BUILDING, ERROR, INITIALIZING, READY, CANCELED
statusstringDeployment status
targetstringTarget environment
createdAtnumberCreation timestamp in milliseconds
buildingAtnumberBuild start timestamp
readynumberReady timestamp
sourcestringDeployment source: cli, git, redeploy, import, v0-web, etc.
aliasarrayAssigned aliases
regionsarrayDeployment regions
inspectorUrlstringVercel inspector URL
projectIdstringAssociated project ID
creatorobjectCreator information
↳ uidstringCreator user ID
↳ usernamestringCreator username
projectobjectAssociated project
↳ idstringProject ID
↳ namestringProject name
↳ frameworkstringProject framework
metaobjectDeployment metadata (key-value strings)
↳ githubCommitShastringGitHub commit SHA
↳ githubCommitMessagestringGitHub commit message
↳ githubCommitRefstringGitHub branch/ref
↳ githubRepostringGitHub repository
↳ githubOrgstringGitHub organization
↳ githubCommitAuthorNamestringCommit author name
gitSourceobjectGit source information
↳ typestringGit provider type (e.g., github, gitlab, bitbucket)
↳ refstringGit ref (branch or tag)
↳ shastringGit commit SHA
↳ repoIdstringRepository ID

vercel_create_deployment

Create a new deployment or redeploy an existing one

Entrée

ParamètreTypeObligatoireDescription
apiKeystringOuiVercel Access Token
namestringOuiProject name for the deployment
projectstringNonProject ID (overrides name for project lookup)
deploymentIdstringNonExisting deployment ID to redeploy
targetstringNonTarget environment: production, staging, or a custom environment identifier
gitSourcestringNonJSON string defining the Git Repository source to deploy (e.g. {"type":"github","repo":"owner/repo","ref":"main"})
forceNewstringNonForces a new deployment even if there is a previous similar deployment (0 or 1)
teamIdstringNonTeam ID to scope the request

Sortie

ParamètreTypeDescription
idstringDeployment ID
namestringDeployment name
urlstringUnique deployment URL
readyStatestringDeployment ready state: QUEUED, BUILDING, ERROR, INITIALIZING, READY, CANCELED
projectIdstringAssociated project ID
createdAtnumberCreation timestamp in milliseconds
aliasarrayAssigned aliases
targetstringTarget environment
inspectorUrlstringVercel inspector URL

vercel_cancel_deployment

Cancel a running Vercel deployment

Entrée

ParamètreTypeObligatoireDescription
apiKeystringOuiVercel Access Token
deploymentIdstringOuiThe deployment ID to cancel
teamIdstringNonTeam ID to scope the request

Sortie

ParamètreTypeDescription
idstringDeployment ID
namestringDeployment name
statestringDeployment state after cancellation
urlstringDeployment URL

vercel_delete_deployment

Delete a Vercel deployment

Entrée

ParamètreTypeObligatoireDescription
apiKeystringOuiVercel Access Token
deploymentIdstringOuiThe deployment ID or URL to delete
teamIdstringNonTeam ID to scope the request

Sortie

ParamètreTypeDescription
uidstringThe removed deployment ID
statestringDeployment state after deletion (DELETED)

vercel_get_deployment_events

Get build and runtime events for a Vercel deployment

Entrée

ParamètreTypeObligatoireDescription
apiKeystringOuiVercel Access Token
deploymentIdstringOuiThe unique deployment identifier or hostname
directionstringNonOrder of events by timestamp: backward or forward (default: forward)
follownumberNonWhen set to 1, returns live events as they happen
limitnumberNonMaximum number of events to return (-1 for all)
sincenumberNonTimestamp to start pulling build logs from
untilnumberNonTimestamp to stop pulling build logs at
teamIdstringNonTeam ID to scope the request

Sortie

ParamètreTypeDescription
eventsarrayList of deployment events
↳ typestringEvent type: delimiter, command, stdout, stderr, exit, deployment-state, middleware, middleware-invocation, edge-function-invocation, metric, report, fatal
↳ creatednumberEvent creation timestamp
↳ datenumberEvent date timestamp
↳ textstringEvent text content
↳ serialstringEvent serial identifier
↳ deploymentIdstringAssociated deployment ID
↳ idstringEvent unique identifier
↳ levelstringEvent level: error or warning
countnumberNumber of events returned

vercel_list_deployment_files

List files in a Vercel deployment

Entrée

ParamètreTypeObligatoireDescription
apiKeystringOuiVercel Access Token
deploymentIdstringOuiThe deployment ID to list files for
teamIdstringNonTeam ID to scope the request

Sortie

ParamètreTypeDescription
filesarrayList of deployment files
↳ namestringThe name of the file tree entry
↳ typestringFile type: directory, file, symlink, lambda, middleware, or invalid
↳ uidstringUnique file identifier (only valid for file type)
↳ modenumberFile mode indicating file type and permissions
↳ contentTypestringContent-type of the file (only valid for file type)
↳ childrenarrayChild files of the directory (only valid for directory type)
↳ namestringFile name
↳ typestringEntry type
↳ uidstringFile identifier
countnumberNumber of files returned

vercel_promote_deployment

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

Entrée

ParamètreTypeObligatoireDescription
apiKeystringOuiVercel Access Token
projectIdstringOuiProject ID or name
deploymentIdstringOuiThe ID of the deployment to promote to production
teamIdstringNonTeam ID to scope the request

Sortie

ParamètreTypeDescription
promotedbooleanWhether the deployment was promoted to production

vercel_list_projects

List all projects in a Vercel team or account

Entrée

ParamètreTypeObligatoireDescription
apiKeystringOuiVercel Access Token
searchstringNonSearch projects by name
limitnumberNonMaximum number of projects to return
teamIdstringNonTeam ID to scope the request

Sortie

ParamètreTypeDescription
projectsarrayList of projects
↳ idstringProject ID
↳ namestringProject name
↳ frameworkstringFramework
↳ createdAtnumberCreation timestamp
↳ updatedAtnumberLast updated timestamp
↳ domainsarrayProject domains
countnumberNumber of projects returned
hasMorebooleanWhether more projects are available

vercel_get_project

Get details of a specific Vercel project

Entrée

ParamètreTypeObligatoireDescription
apiKeystringOuiVercel Access Token
projectIdstringOuiProject ID or name
teamIdstringNonTeam ID to scope the request

Sortie

ParamètreTypeDescription
idstringProject ID
namestringProject name
frameworkstringProject framework
createdAtnumberCreation timestamp
updatedAtnumberLast updated timestamp
domainsarrayProject domains
linkobjectGit repository connection
↳ typestringRepository type (github, gitlab, bitbucket)
↳ repostringRepository name
↳ orgstringOrganization or owner

vercel_create_project

Create a new Vercel project

Entrée

ParamètreTypeObligatoireDescription
apiKeystringOuiVercel Access Token
namestringOuiProject name
frameworkstringNonProject framework (e.g. nextjs, remix, vite)
gitRepositoryjsonNonGit repository connection object with type and repo
buildCommandstringNonCustom build command
outputDirectorystringNonCustom output directory
installCommandstringNonCustom install command
teamIdstringNonTeam ID to scope the request

Sortie

ParamètreTypeDescription
idstringProject ID
namestringProject name
frameworkstringProject framework
createdAtnumberCreation timestamp
updatedAtnumberLast updated timestamp

vercel_update_project

Update an existing Vercel project

Entrée

ParamètreTypeObligatoireDescription
apiKeystringOuiVercel Access Token
projectIdstringOuiProject ID or name
namestringNonNew project name
frameworkstringNonProject framework (e.g. nextjs, remix, vite)
buildCommandstringNonCustom build command
outputDirectorystringNonCustom output directory
installCommandstringNonCustom install command
teamIdstringNonTeam ID to scope the request

Sortie

ParamètreTypeDescription
idstringProject ID
namestringProject name
frameworkstringProject framework
updatedAtnumberLast updated timestamp

vercel_delete_project

Delete a Vercel project

Entrée

ParamètreTypeObligatoireDescription
apiKeystringOuiVercel Access Token
projectIdstringOuiProject ID or name
teamIdstringNonTeam ID to scope the request

Sortie

ParamètreTypeDescription
deletedbooleanWhether the project was successfully deleted

vercel_pause_project

Pause a Vercel project

Entrée

ParamètreTypeObligatoireDescription
apiKeystringOuiVercel Access Token
projectIdstringOuiProject ID or name
teamIdstringNonTeam ID to scope the request

Sortie

ParamètreTypeDescription
idstringProject ID
namestringProject name
pausedbooleanWhether the project is paused

vercel_unpause_project

Unpause a Vercel project

Entrée

ParamètreTypeObligatoireDescription
apiKeystringOuiVercel Access Token
projectIdstringOuiProject ID or name
teamIdstringNonTeam ID to scope the request

Sortie

ParamètreTypeDescription
idstringProject ID
namestringProject name
pausedbooleanWhether the project is paused

vercel_list_project_domains

List all domains for a Vercel project

Entrée

ParamètreTypeObligatoireDescription
apiKeystringOuiVercel Access Token
projectIdstringOuiProject ID or name
teamIdstringNonTeam ID to scope the request
limitnumberNonMaximum number of domains to return

Sortie

ParamètreTypeDescription
domainsarrayList of project domains
↳ namestringDomain name
↳ apexNamestringApex domain name
↳ redirectstringRedirect target
↳ redirectStatusCodenumberRedirect status code
↳ verifiedbooleanWhether the domain is verified
↳ gitBranchstringGit branch for the domain
↳ createdAtnumberCreation timestamp
↳ updatedAtnumberLast updated timestamp
countnumberNumber of domains returned
hasMorebooleanWhether more domains are available

vercel_add_project_domain

Add a domain to a Vercel project

Entrée

ParamètreTypeObligatoireDescription
apiKeystringOuiVercel Access Token
projectIdstringOuiProject ID or name
domainstringOuiDomain name to add
redirectstringNonTarget domain for redirect
redirectStatusCodenumberNonHTTP status code for redirect (301, 302, 307, 308)
gitBranchstringNonGit branch to link the domain to
teamIdstringNonTeam ID to scope the request

Sortie

ParamètreTypeDescription
namestringDomain name
apexNamestringApex domain name
verifiedbooleanWhether the domain is verified
gitBranchstringGit branch for the domain
redirectstringRedirect target domain
redirectStatusCodenumberHTTP status code for redirect (301, 302, 307, 308)
createdAtnumberCreation timestamp
updatedAtnumberLast updated timestamp

vercel_remove_project_domain

Remove a domain from a Vercel project

Entrée

ParamètreTypeObligatoireDescription
apiKeystringOuiVercel Access Token
projectIdstringOuiProject ID or name
domainstringOuiDomain name to remove
teamIdstringNonTeam ID to scope the request

Sortie

ParamètreTypeDescription
deletedbooleanWhether the domain was successfully removed

vercel_update_project_domain

Update a project domain

Entrée

ParamètreTypeObligatoireDescription
apiKeystringOuiVercel Access Token
projectIdstringOuiProject ID or name
domainstringOuiDomain name to update
redirectstringNonTarget destination domain for redirect
redirectStatusCodenumberNonHTTP status code for redirect (301, 302, 307, 308)
gitBranchstringNonGit branch to link the domain to
teamIdstringNonTeam ID to scope the request

Sortie

ParamètreTypeDescription
namestringDomain name
apexNamestringApex domain name
projectIdstringProject ID the domain belongs to
verifiedbooleanWhether the domain is verified
redirectstringRedirect target domain
redirectStatusCodenumberHTTP status code for redirect (301, 302, 307, 308)
gitBranchstringGit branch for the domain
verificationarrayDomain verification challenges (type, domain, value, reason)
↳ typestringChallenge type
↳ domainstringDomain to add the record to
↳ valuestringExpected record value
↳ reasonstringWhy verification is needed
createdAtnumberCreation timestamp
updatedAtnumberLast updated timestamp

vercel_verify_project_domain

Verify a Vercel project domain by checking its verification challenge

Entrée

ParamètreTypeObligatoireDescription
apiKeystringOuiVercel Access Token
projectIdstringOuiProject ID or name
domainstringOuiDomain name to verify
teamIdstringNonTeam ID to scope the request

Sortie

ParamètreTypeDescription
namestringDomain name
apexNamestringApex domain name
projectIdstringProject ID
verifiedbooleanWhether the domain is verified
redirectstringRedirect target domain
redirectStatusCodenumberRedirect status code (301, 302, 307, 308)
gitBranchstringGit branch linked to the domain
createdAtnumberCreation timestamp
updatedAtnumberLast update timestamp

vercel_get_env_vars

Retrieve environment variables for a Vercel project

Entrée

ParamètreTypeObligatoireDescription
apiKeystringOuiVercel Access Token
projectIdstringOuiProject ID or name
teamIdstringNonTeam ID to scope the request

Sortie

ParamètreTypeDescription
envsarrayList of environment variables
↳ idstringEnvironment variable ID
↳ keystringVariable name
↳ valuestringVariable value
↳ typestringVariable type (secret, system, encrypted, plain, sensitive)
↳ targetarrayTarget environments
↳ gitBranchstringGit branch filter
↳ commentstringComment providing context for the variable
countnumberNumber of environment variables returned

vercel_create_env_var

Create an environment variable for a Vercel project

Entrée

ParamètreTypeObligatoireDescription
apiKeystringOuiVercel Access Token
projectIdstringOuiProject ID or name
keystringOuiEnvironment variable name
valuestringOuiEnvironment variable value
targetstringOuiComma-separated list of target environments (production, preview, development)
typestringNonVariable type: system, secret, encrypted, plain, or sensitive (default: plain)
gitBranchstringNonGit branch to associate with the variable (requires target to include preview)
commentstringNonComment to add context to the variable (max 500 characters)
teamIdstringNonTeam ID to scope the request

Sortie

ParamètreTypeDescription
idstringEnvironment variable ID
keystringVariable name
valuestringVariable value
typestringVariable type (secret, system, encrypted, plain, sensitive)
targetarrayTarget environments
gitBranchstringGit branch filter
commentstringComment providing context for the variable

vercel_update_env_var

Update an environment variable for a Vercel project

Entrée

ParamètreTypeObligatoireDescription
apiKeystringOuiVercel Access Token
projectIdstringOuiProject ID or name
envIdstringOuiEnvironment variable ID to update
keystringNonNew variable name
valuestringNonNew variable value
targetstringNonComma-separated list of target environments (production, preview, development)
typestringNonVariable type: system, secret, encrypted, plain, or sensitive
gitBranchstringNonGit branch to associate with the variable (requires target to include preview)
commentstringNonComment to add context to the variable (max 500 characters)
teamIdstringNonTeam ID to scope the request

Sortie

ParamètreTypeDescription
idstringEnvironment variable ID
keystringVariable name
valuestringVariable value
typestringVariable type (secret, system, encrypted, plain, sensitive)
targetarrayTarget environments
gitBranchstringGit branch filter
commentstringComment providing context for the variable

vercel_delete_env_var

Delete an environment variable from a Vercel project

Entrée

ParamètreTypeObligatoireDescription
apiKeystringOuiVercel Access Token
projectIdstringOuiProject ID or name
envIdstringOuiEnvironment variable ID to delete
teamIdstringNonTeam ID to scope the request

Sortie

ParamètreTypeDescription
deletedbooleanWhether the environment variable was successfully deleted

vercel_list_domains

List all domains in a Vercel account or team

Entrée

ParamètreTypeObligatoireDescription
apiKeystringOuiVercel Access Token
limitnumberNonMaximum number of domains to return (default 20)
teamIdstringNonTeam ID to scope the request

Sortie

ParamètreTypeDescription
domainsarrayList of domains
↳ idstringDomain ID
↳ namestringDomain name
↳ verifiedbooleanWhether domain is verified
↳ createdAtnumberCreation timestamp
↳ expiresAtnumberExpiration timestamp
↳ serviceTypestringService type (zeit.world, external, na)
↳ nameserversarrayCurrent nameservers
↳ intendedNameserversarrayIntended nameservers
↳ renewbooleanWhether auto-renewal is enabled
↳ boughtAtnumberPurchase timestamp
countnumberNumber of domains returned
hasMorebooleanWhether more domains are available

vercel_get_domain

Get information about a specific domain in a Vercel account

Entrée

ParamètreTypeObligatoireDescription
apiKeystringOuiVercel Access Token
domainstringOuiThe domain name to retrieve
teamIdstringNonTeam ID to scope the request

Sortie

ParamètreTypeDescription
idstringDomain ID
namestringDomain name
verifiedbooleanWhether domain is verified
createdAtnumberCreation timestamp
expiresAtnumberExpiration timestamp
serviceTypestringService type (zeit.world, external, na)
nameserversarrayCurrent nameservers
intendedNameserversarrayIntended nameservers
customNameserversarrayCustom nameservers
renewbooleanWhether auto-renewal is enabled
boughtAtnumberPurchase timestamp
transferredAtnumberTransfer completion timestamp

vercel_add_domain

Add a new domain to a Vercel account or team

Entrée

ParamètreTypeObligatoireDescription
apiKeystringOuiVercel Access Token
namestringOuiThe domain name to add
teamIdstringNonTeam ID to scope the request

Sortie

ParamètreTypeDescription
idstringDomain ID
namestringDomain name
verifiedbooleanWhether domain is verified
createdAtnumberCreation timestamp
serviceTypestringService type (zeit.world, external, na)
nameserversarrayCurrent nameservers
intendedNameserversarrayIntended nameservers

vercel_delete_domain

Delete a domain from a Vercel account or team

Entrée

ParamètreTypeObligatoireDescription
apiKeystringOuiVercel Access Token
domainstringOuiThe domain name to delete
teamIdstringNonTeam ID to scope the request

Sortie

ParamètreTypeDescription
uidstringThe ID of the deleted domain
deletedbooleanWhether the domain was deleted

vercel_get_domain_config

Get the configuration for a domain in a Vercel account

Entrée

ParamètreTypeObligatoireDescription
apiKeystringOuiVercel Access Token
domainstringOuiThe domain name to get configuration for
teamIdstringNonTeam ID to scope the request

Sortie

ParamètreTypeDescription
configuredBystringHow the domain is configured (CNAME, A, http, dns-01, or null)
acceptedChallengesarrayAccepted challenge types for certificate issuance (dns-01, http-01)
misconfiguredbooleanWhether the domain is misconfigured for TLS certificate generation
recommendedIPv4arrayRecommended IPv4 addresses with rank values
↳ ranknumberPriority rank (1 is preferred)
↳ valuearrayIPv4 addresses
recommendedCNAMEarrayRecommended CNAME records with rank values
↳ ranknumberPriority rank (1 is preferred)
↳ valuestringCNAME value

vercel_list_dns_records

List all DNS records for a domain in a Vercel account

Entrée

ParamètreTypeObligatoireDescription
apiKeystringOuiVercel Access Token
domainstringOuiThe domain name to list records for
limitnumberNonMaximum number of records to return
teamIdstringNonTeam ID to scope the request

Sortie

ParamètreTypeDescription
recordsarrayList of DNS records
↳ idstringRecord ID
↳ slugstringRecord slug
↳ namestringRecord name
↳ typestringRecord type (A, AAAA, ALIAS, CAA, CNAME, HTTPS, MX, SRV, TXT, NS)
↳ valuestringRecord value
↳ ttlnumberTime to live in seconds
↳ mxPrioritynumberMX record priority
↳ prioritynumberRecord priority
↳ creatorstringCreator identifier
↳ createdAtnumberCreation timestamp
↳ updatedAtnumberLast update timestamp
↳ commentstringRecord comment
countnumberNumber of records returned
hasMorebooleanWhether more records are available

vercel_create_dns_record

Create a DNS record for a domain in a Vercel account

Entrée

ParamètreTypeObligatoireDescription
apiKeystringOuiVercel Access Token
domainstringOuiThe domain name to create the record for
recordNamestringOuiThe subdomain or record name
recordTypestringOuiDNS record type (A, AAAA, ALIAS, CAA, CNAME, HTTPS, MX, SRV, TXT, NS)
valuestringOuiThe value of the DNS record
ttlnumberNonTime to live in seconds
mxPrioritynumberNonPriority for MX records
teamIdstringNonTeam ID to scope the request

Sortie

ParamètreTypeDescription
uidstringThe DNS record ID
updatednumberTimestamp of the update

vercel_update_dns_record

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

Entrée

ParamètreTypeObligatoireDescription
apiKeystringOuiVercel Access Token
recordIdstringOuiThe ID of the DNS record to update
namestringNonThe name of the DNS record
valuestringNonThe value of the DNS record
typestringNonDNS record type (A, AAAA, ALIAS, CAA, CNAME, HTTPS, MX, SRV, TXT, NS)
ttlnumberNonTime to live in seconds (60 to 2147483647)
mxPrioritynumberNonPriority for MX records
commentstringNonA comment to add context on what this DNS record is for (max 500 characters)
teamIdstringNonTeam ID to scope the request

Sortie

ParamètreTypeDescription
idstringThe DNS record ID
namestringThe name of the DNS record
typestringThe record class (record or record-sys)
valuestringThe value of the DNS record
creatorstringThe creator of the DNS record
domainstringThe domain the record belongs to
ttlnumberTime to live in seconds
commentstringComment providing context for the record
recordTypestringDNS record type (A, AAAA, ALIAS, CAA, CNAME, HTTPS, MX, NS, SRV, TXT)
createdAtnumberTimestamp of record creation

vercel_delete_dns_record

Delete a DNS record for a domain in a Vercel account

Entrée

ParamètreTypeObligatoireDescription
apiKeystringOuiVercel Access Token
domainstringOuiThe domain name the record belongs to
recordIdstringOuiThe ID of the DNS record to delete
teamIdstringNonTeam ID to scope the request

Sortie

ParamètreTypeDescription
deletedbooleanWhether the record was deleted

vercel_list_aliases

List aliases for a Vercel project or team

Entrée

ParamètreTypeObligatoireDescription
apiKeystringOuiVercel Access Token
projectIdstringNonFilter aliases by project ID
domainstringNonFilter aliases by domain
limitnumberNonMaximum number of aliases to return
teamIdstringNonTeam ID to scope the request

Sortie

ParamètreTypeDescription
aliasesarrayList of aliases
↳ uidstringAlias ID
↳ aliasstringAlias hostname
↳ deploymentIdstringAssociated deployment ID
↳ projectIdstringAssociated project ID
↳ createdAtnumberCreation timestamp in milliseconds
↳ updatedAtnumberLast update timestamp in milliseconds
countnumberNumber of aliases returned
hasMorebooleanWhether more aliases are available

vercel_get_alias

Get details about a specific alias by ID or hostname

Entrée

ParamètreTypeObligatoireDescription
apiKeystringOuiVercel Access Token
aliasIdstringOuiAlias ID or hostname to look up
teamIdstringNonTeam ID to scope the request

Sortie

ParamètreTypeDescription
uidstringAlias ID
aliasstringAlias hostname
deploymentIdstringAssociated deployment ID
projectIdstringAssociated project ID
createdAtnumberCreation timestamp in milliseconds
updatedAtnumberLast update timestamp in milliseconds
redirectstringTarget domain for redirect aliases
redirectStatusCodenumberHTTP status code for redirect (301, 302, 307, or 308)

vercel_create_alias

Assign an alias (domain/subdomain) to a deployment

Entrée

ParamètreTypeObligatoireDescription
apiKeystringOuiVercel Access Token
deploymentIdstringOuiDeployment ID to assign the alias to
aliasstringOuiThe domain or subdomain to assign as an alias
teamIdstringNonTeam ID to scope the request

Sortie

ParamètreTypeDescription
uidstringAlias ID
aliasstringAlias hostname
createdstringCreation timestamp as ISO 8601 date-time string
oldDeploymentIdstringID of the previously aliased deployment, if the alias was reassigned

vercel_delete_alias

Delete an alias by its ID

Entrée

ParamètreTypeObligatoireDescription
apiKeystringOuiVercel Access Token
aliasIdstringOuiAlias ID to delete
teamIdstringNonTeam ID to scope the request

Sortie

ParamètreTypeDescription
statusstringDeletion status (SUCCESS)

vercel_list_edge_configs

List all Edge Config stores for a team

Entrée

ParamètreTypeObligatoireDescription
apiKeystringOuiVercel Access Token
teamIdstringNonTeam ID to scope the request

Sortie

ParamètreTypeDescription
edgeConfigsarrayList of Edge Config stores
↳ idstringEdge Config ID
↳ slugstringEdge Config slug
↳ ownerIdstringOwner ID
↳ digeststringContent digest hash
↳ createdAtnumberCreation timestamp
↳ updatedAtnumberLast update timestamp
↳ itemCountnumberNumber of items
↳ sizeInBytesnumberSize in bytes
countnumberNumber of Edge Configs returned

vercel_get_edge_config

Get details about a specific Edge Config store

Entrée

ParamètreTypeObligatoireDescription
apiKeystringOuiVercel Access Token
edgeConfigIdstringOuiEdge Config ID to look up
teamIdstringNonTeam ID to scope the request

Sortie

ParamètreTypeDescription
idstringEdge Config ID
slugstringEdge Config slug
ownerIdstringOwner ID
digeststringContent digest hash
createdAtnumberCreation timestamp
updatedAtnumberLast update timestamp
itemCountnumberNumber of items
sizeInBytesnumberSize in bytes

vercel_create_edge_config

Create a new Edge Config store

Entrée

ParamètreTypeObligatoireDescription
apiKeystringOuiVercel Access Token
slugstringOuiThe name/slug for the new Edge Config
teamIdstringNonTeam ID to scope the request

Sortie

ParamètreTypeDescription
idstringEdge Config ID
slugstringEdge Config slug
ownerIdstringOwner ID
digeststringContent digest hash
createdAtnumberCreation timestamp
updatedAtnumberLast update timestamp
itemCountnumberNumber of items
sizeInBytesnumberSize in bytes

vercel_get_edge_config_items

Get all items in an Edge Config store

Entrée

ParamètreTypeObligatoireDescription
apiKeystringOuiVercel Access Token
edgeConfigIdstringOuiEdge Config ID to get items from
teamIdstringNonTeam ID to scope the request

Sortie

ParamètreTypeDescription
itemsarrayList of Edge Config items
↳ keystringItem key
↳ valuejsonItem value
↳ descriptionstringItem description
↳ edgeConfigIdstringParent Edge Config ID
↳ createdAtnumberCreation timestamp
↳ updatedAtnumberLast update timestamp
countnumberNumber of items returned

vercel_update_edge_config_items

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

Entrée

ParamètreTypeObligatoireDescription
apiKeystringOuiVercel Access Token
edgeConfigIdstringOuiEdge Config ID to update items in
itemsjsonOuiArray of operations: [{operation: "create"|"update"|"upsert"|"delete", key: string, value?: any}]
teamIdstringNonTeam ID to scope the request

Sortie

ParamètreTypeDescription
statusstringOperation status

vercel_delete_edge_config

Delete an Edge Config store by ID

Entrée

ParamètreTypeObligatoireDescription
apiKeystringOuiVercel Access Token
edgeConfigIdstringOuiEdge Config ID to delete
teamIdstringNonTeam ID to scope the request

Sortie

ParamètreTypeDescription
deletedbooleanWhether the Edge Config was successfully deleted

vercel_list_webhooks

List webhooks for a Vercel project or team

Entrée

ParamètreTypeObligatoireDescription
apiKeystringOuiVercel Access Token
projectIdstringNonFilter webhooks by project ID
teamIdstringNonTeam ID to scope the request

Sortie

ParamètreTypeDescription
webhooksarrayList of webhooks
↳ idstringWebhook ID
↳ urlstringWebhook URL
↳ eventsarrayEvents the webhook listens to
↳ ownerIdstringOwner ID
↳ projectIdsarrayAssociated project IDs
↳ createdAtnumberCreation timestamp
↳ updatedAtnumberLast updated timestamp
countnumberNumber of webhooks returned

vercel_get_webhook

Get details about a specific Vercel webhook

Entrée

ParamètreTypeObligatoireDescription
apiKeystringOuiVercel Access Token
webhookIdstringOuiWebhook ID to look up
teamIdstringNonTeam ID to scope the request

Sortie

ParamètreTypeDescription
idstringWebhook ID
urlstringWebhook URL
eventsarrayEvents the webhook listens to
ownerIdstringOwner ID
projectIdsarrayAssociated project IDs
createdAtnumberCreation timestamp
updatedAtnumberLast updated timestamp

vercel_create_webhook

Create a new webhook for a Vercel team

Entrée

ParamètreTypeObligatoireDescription
apiKeystringOuiVercel Access Token
urlstringOuiWebhook URL (must be https)
eventsstringOuiComma-separated event names to subscribe to
projectIdsstringNonComma-separated project IDs to scope the webhook to
teamIdstringOuiTeam ID to create the webhook for

Sortie

ParamètreTypeDescription
idstringWebhook ID
urlstringWebhook URL
secretstringWebhook signing secret
eventsarrayEvents the webhook listens to
ownerIdstringOwner ID
projectIdsarrayAssociated project IDs
createdAtnumberCreation timestamp
updatedAtnumberLast updated timestamp

vercel_delete_webhook

Delete a webhook from a Vercel team

Entrée

ParamètreTypeObligatoireDescription
apiKeystringOuiVercel Access Token
webhookIdstringOuiThe webhook ID to delete
teamIdstringNonTeam ID to scope the request

Sortie

ParamètreTypeDescription
deletedbooleanWhether the webhook was successfully deleted

vercel_create_check

Create a new deployment check

Entrée

ParamètreTypeObligatoireDescription
apiKeystringOuiVercel Access Token
deploymentIdstringOuiDeployment ID to create the check for
namestringOuiName of the check (max 100 characters)
blockingbooleanOuiWhether the check blocks the deployment
pathstringNonPage path being checked
detailsUrlstringNonURL with details about the check
externalIdstringNonExternal identifier for the check
rerequestablebooleanNonWhether the check can be rerequested
teamIdstringNonTeam ID to scope the request

Sortie

ParamètreTypeDescription
idstringCheck ID
namestringCheck name
statusstringCheck status: registered, running, or completed
conclusionstringCheck conclusion: canceled, failed, neutral, succeeded, skipped, or stale
blockingbooleanWhether the check blocks the deployment
deploymentIdstringAssociated deployment ID
integrationIdstringAssociated integration ID
externalIdstringExternal identifier
detailsUrlstringURL with details about the check
pathstringPage path being checked
rerequestablebooleanWhether the check can be rerequested
createdAtnumberCreation timestamp in milliseconds
updatedAtnumberLast update timestamp in milliseconds
startedAtnumberStart timestamp in milliseconds
completedAtnumberCompletion timestamp in milliseconds

vercel_get_check

Get details of a specific deployment check

Entrée

ParamètreTypeObligatoireDescription
apiKeystringOuiVercel Access Token
deploymentIdstringOuiDeployment ID the check belongs to
checkIdstringOuiCheck ID to retrieve
teamIdstringNonTeam ID to scope the request

Sortie

ParamètreTypeDescription
idstringCheck ID
namestringCheck name
statusstringCheck status: registered, running, or completed
conclusionstringCheck conclusion: canceled, failed, neutral, succeeded, skipped, or stale
blockingbooleanWhether the check blocks the deployment
deploymentIdstringAssociated deployment ID
integrationIdstringAssociated integration ID
externalIdstringExternal identifier
detailsUrlstringURL with details about the check
pathstringPage path being checked
rerequestablebooleanWhether the check can be rerequested
createdAtnumberCreation timestamp in milliseconds
updatedAtnumberLast update timestamp in milliseconds
startedAtnumberStart timestamp in milliseconds
completedAtnumberCompletion timestamp in milliseconds

vercel_list_checks

List all checks for a deployment

Entrée

ParamètreTypeObligatoireDescription
apiKeystringOuiVercel Access Token
deploymentIdstringOuiDeployment ID to list checks for
teamIdstringNonTeam ID to scope the request

Sortie

ParamètreTypeDescription
checksarrayList of deployment checks
↳ idstringCheck ID
↳ namestringCheck name
↳ statusstringCheck status
↳ conclusionstringCheck conclusion
↳ blockingbooleanWhether the check blocks the deployment
↳ deploymentIdstringAssociated deployment ID
↳ integrationIdstringAssociated integration ID
↳ externalIdstringExternal identifier
↳ detailsUrlstringURL with details about the check
↳ pathstringPage path being checked
↳ rerequestablebooleanWhether the check can be rerequested
↳ createdAtnumberCreation timestamp
↳ updatedAtnumberLast update timestamp
↳ startedAtnumberStart timestamp
↳ completedAtnumberCompletion timestamp
countnumberTotal number of checks

vercel_update_check

Update an existing deployment check

Entrée

ParamètreTypeObligatoireDescription
apiKeystringOuiVercel Access Token
deploymentIdstringOuiDeployment ID the check belongs to
checkIdstringOuiCheck ID to update
namestringNonUpdated name of the check
statusstringNonUpdated status: running or completed
conclusionstringNonCheck conclusion: canceled, failed, neutral, succeeded, or skipped
detailsUrlstringNonURL with details about the check
externalIdstringNonExternal identifier for the check
pathstringNonPage path being checked
outputstringNonJSON string with check output metrics
teamIdstringNonTeam ID to scope the request

Sortie

ParamètreTypeDescription
idstringCheck ID
namestringCheck name
statusstringCheck status: registered, running, or completed
conclusionstringCheck conclusion: canceled, failed, neutral, succeeded, skipped, or stale
blockingbooleanWhether the check blocks the deployment
deploymentIdstringAssociated deployment ID
integrationIdstringAssociated integration ID
externalIdstringExternal identifier
detailsUrlstringURL with details about the check
pathstringPage path being checked
rerequestablebooleanWhether the check can be rerequested
createdAtnumberCreation timestamp in milliseconds
updatedAtnumberLast update timestamp in milliseconds
startedAtnumberStart timestamp in milliseconds
completedAtnumberCompletion timestamp in milliseconds

vercel_rerequest_check

Rerequest a deployment check

Entrée

ParamètreTypeObligatoireDescription
apiKeystringOuiVercel Access Token
deploymentIdstringOuiDeployment ID the check belongs to
checkIdstringOuiCheck ID to rerequest
teamIdstringNonTeam ID to scope the request

Sortie

ParamètreTypeDescription
rerequestedbooleanWhether the check was successfully rerequested

vercel_list_teams

List all teams in a Vercel account

Entrée

ParamètreTypeObligatoireDescription
apiKeystringOuiVercel Access Token
limitnumberNonMaximum number of teams to return
sincenumberNonTimestamp in milliseconds to only include teams created since then
untilnumberNonTimestamp in milliseconds to only include teams created until then

Sortie

ParamètreTypeDescription
teamsarrayList of teams
↳ idstringTeam ID
↳ slugstringTeam slug
↳ namestringTeam name
↳ avatarstringAvatar file ID
↳ createdAtnumberCreation timestamp in milliseconds
↳ updatedAtnumberLast update timestamp in milliseconds
↳ creatorIdstringUser ID of team creator
↳ membershipobjectCurrent user membership details
↳ rolestringMembership role
↳ confirmedbooleanWhether membership is confirmed
↳ creatednumberMembership creation timestamp
↳ uidstringUser ID of the member
↳ teamIdstringTeam ID
countnumberNumber of teams returned
paginationobjectPagination information
↳ countnumberItems in current page
↳ nextnumberTimestamp for next page request
↳ prevnumberTimestamp for previous page request

vercel_get_team

Get information about a specific Vercel team

Entrée

ParamètreTypeObligatoireDescription
apiKeystringOuiVercel Access Token
teamIdstringOuiThe team ID to retrieve

Sortie

ParamètreTypeDescription
idstringTeam ID
slugstringTeam slug
namestringTeam name
avatarstringAvatar file ID
descriptionstringShort team description
createdAtnumberCreation timestamp in milliseconds
updatedAtnumberLast update timestamp in milliseconds
creatorIdstringUser ID of team creator
membershipobjectCurrent user membership details
↳ uidstringUser ID of the member
↳ teamIdstringTeam ID
↳ rolestringMembership role
↳ confirmedbooleanWhether membership is confirmed
↳ creatednumberMembership creation timestamp
↳ createdAtnumberMembership creation timestamp (milliseconds)
↳ accessRequestedAtnumberWhen access was requested
↳ teamRolesarrayTeam role assignments
↳ teamPermissionsarrayTeam permission assignments

vercel_list_team_members

List all members of a Vercel team

Entrée

ParamètreTypeObligatoireDescription
apiKeystringOuiVercel Access Token
teamIdstringOuiThe team ID to list members for
limitnumberNonMaximum number of members to return
rolestringNonFilter by role (OWNER, MEMBER, DEVELOPER, SECURITY, BILLING, VIEWER, VIEWER_FOR_PLUS, CONTRIBUTOR)
sincenumberNonTimestamp in milliseconds to only include members added since then
untilnumberNonTimestamp in milliseconds to only include members added until then
searchstringNonSearch team members by their name, username, and email

Sortie

ParamètreTypeDescription
membersarrayList of team members
↳ uidstringMember user ID
↳ emailstringMember email
↳ usernamestringMember username
↳ namestringMember full name
↳ avatarstringAvatar file ID
↳ rolestringMember role
↳ confirmedbooleanWhether membership is confirmed
↳ createdAtnumberJoin timestamp in milliseconds
↳ joinedFromobjectOrigin of how the member joined
↳ originstringJoin origin identifier
countnumberNumber of members returned
paginationobjectPagination information
↳ hasNextbooleanWhether there are more pages
↳ countnumberItems in current page

vercel_get_user

Get information about the authenticated Vercel user

Entrée

ParamètreTypeObligatoireDescription
apiKeystringOuiVercel Access Token

Sortie

ParamètreTypeDescription
idstringUser ID
emailstringUser email
usernamestringUsername
namestringDisplay name
avatarstringSHA1 hash of the avatar
defaultTeamIdstringDefault team ID
createdAtnumberAccount creation timestamp in milliseconds
stagingPrefixstringPrefix for preview deployment URLs
softBlockobjectAccount restriction details if blocked
↳ blockedAtnumberWhen the account was blocked
↳ reasonstringReason for the block
hasTrialAvailablebooleanWhether a trial is available

On this page

Instructions d'utilisation
Outils
vercel_list_deployments
Entrée
Sortie
vercel_get_deployment
Entrée
Sortie
vercel_create_deployment
Entrée
Sortie
vercel_cancel_deployment
Entrée
Sortie
vercel_delete_deployment
Entrée
Sortie
vercel_get_deployment_events
Entrée
Sortie
vercel_list_deployment_files
Entrée
Sortie
vercel_promote_deployment
Entrée
Sortie
vercel_list_projects
Entrée
Sortie
vercel_get_project
Entrée
Sortie
vercel_create_project
Entrée
Sortie
vercel_update_project
Entrée
Sortie
vercel_delete_project
Entrée
Sortie
vercel_pause_project
Entrée
Sortie
vercel_unpause_project
Entrée
Sortie
vercel_list_project_domains
Entrée
Sortie
vercel_add_project_domain
Entrée
Sortie
vercel_remove_project_domain
Entrée
Sortie
vercel_update_project_domain
Entrée
Sortie
vercel_verify_project_domain
Entrée
Sortie
vercel_get_env_vars
Entrée
Sortie
vercel_create_env_var
Entrée
Sortie
vercel_update_env_var
Entrée
Sortie
vercel_delete_env_var
Entrée
Sortie
vercel_list_domains
Entrée
Sortie
vercel_get_domain
Entrée
Sortie
vercel_add_domain
Entrée
Sortie
vercel_delete_domain
Entrée
Sortie
vercel_get_domain_config
Entrée
Sortie
vercel_list_dns_records
Entrée
Sortie
vercel_create_dns_record
Entrée
Sortie
vercel_update_dns_record
Entrée
Sortie
vercel_delete_dns_record
Entrée
Sortie
vercel_list_aliases
Entrée
Sortie
vercel_get_alias
Entrée
Sortie
vercel_create_alias
Entrée
Sortie
vercel_delete_alias
Entrée
Sortie
vercel_list_edge_configs
Entrée
Sortie
vercel_get_edge_config
Entrée
Sortie
vercel_create_edge_config
Entrée
Sortie
vercel_get_edge_config_items
Entrée
Sortie
vercel_update_edge_config_items
Entrée
Sortie
vercel_delete_edge_config
Entrée
Sortie
vercel_list_webhooks
Entrée
Sortie
vercel_get_webhook
Entrée
Sortie
vercel_create_webhook
Entrée
Sortie
vercel_delete_webhook
Entrée
Sortie
vercel_create_check
Entrée
Sortie
vercel_get_check
Entrée
Sortie
vercel_list_checks
Entrée
Sortie
vercel_update_check
Entrée
Sortie
vercel_rerequest_check
Entrée
Sortie
vercel_list_teams
Entrée
Sortie
vercel_get_team
Entrée
Sortie
vercel_list_team_members
Entrée
Sortie
vercel_get_user
Entrée
Sortie