Vercel позиционирует себя как the AI Cloud: платформу с инструментами для разработчиков и облачной инфраструктурой, которая помогает создавать, масштабировать и защищать более быстрый и персонализированный веб-опыт. Vercel широко используется для разработки и доставки современных веб-приложений и AI-нагрузок, со встроенной поддержкой Git-воркфлоу, preview-деплоев и production-выпусков.
Vercel позволяет:
- Автоматизировать деплои: разворачивайте проекты из Git и управляйте preview- и production-релизами с минимальными операционными затратами
- Управлять проектами и командами: организуйте проекты, доступ команды и настройки в нескольких окружениях
- Контролировать инфраструктурные настройки: настраивайте домены, DNS, алиасы, переменные окружения и параметры edge в одном месте
- Мониторить и устранять проблемы: отслеживайте статус деплоев, изучайте логи и отлаживайте сборку или runtime
Интеграция Vercel в AACFlow позволяет вашим AI-агентам программно управлять деплоями, проектами, доменами, DNS-записями, алиасами, переменными окружения, edge-конфигами и командами прямо из воркфлоу. Вы можете автоматизировать деплои, реагировать на изменения статуса и выполнять инфраструктурные задачи в составе надёжных сквозных пайплайнов доставки.
Интегрируйте с Vercel to manage deployments, projects, domains, DNS records, environment variables, aliases, edge configs, teams, и more.
Список deployments для a Vercel project или 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 |
Получить 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 |
Создать новый deployment или 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 |
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 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) |
Получить build и runtime events для 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 |
Список 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 |
Список всех projects in a Vercel team или 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 |
Получить 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 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 |
Обновитьn 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 project
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Vercel Access Token |
projectId | string | Да | Project ID or name |
teamId | string | Нет | Team ID to scope the request |
| Параметр | Тип | Описание |
|---|
deleted | boolean | Произошла ли project was successfully deleted |
Приостановить 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 | Произошла ли project is paused |
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 | Произошла ли project is paused |
Список всех domains для 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 | Произошла ли 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 |
Добавить 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 | Произошла ли 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 |
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 | Произошла ли domain was successfully removed |
Получить environment variables для 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 |
Создать an environment variable для 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 С помощью 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 |
Обновитьn environment variable для 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 С помощью 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 |
Удалитьn 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 | Произошла ли environment variable was successfully deleted |
Список всех domains in a Vercel account или 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 |
Получить информацию о 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 |
Добавить новый domain to a Vercel account или 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 |
Удалить domain from a Vercel account или 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 | Произошла ли domain was deleted |
Получить configuration для 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 | Произошла ли 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 |
Список всех DNS records для 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 |
Создать a DNS record для 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 |
Удалить DNS record для 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 | Произошла ли record was deleted |
Список aliases для a Vercel project или 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 |
Получить details about a specific alias от ID или 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) |
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 |
Удалитьn 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) |
Список всех Edge Config stores для 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 |
Получить 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 |
Создать новый 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 |
Получить все 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 |
Create, update, upsert, или delete items in an Edge Config store
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Vercel Access Token |
edgeConfigId | string | Да | Edge Config ID to update items in |
items | json | Да | Массив operations: [{operation: "create"|"update"|"upsert"|"delete", key: string, value?: any}] |
teamId | string | Нет | Team ID to scope the request |
| Параметр | Тип | Описание |
|---|
status | string | Operation status |
Список webhooks для a Vercel project или 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 |
Создать новый webhook для 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 |
Удалить 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 | Произошла ли webhook was successfully deleted |
Создать новый 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 | Да | Произошла ли 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 | Нет | Произошла ли 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 | Произошла ли 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 | Произошла ли 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 |
Получить 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 | Произошла ли 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 | Произошла ли 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 |
Список всех checks для 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 | Произошла ли 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 | Произошла ли 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 |
Обновитьn 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 | Произошла ли 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 | Произошла ли 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 |
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 | Произошла ли check was successfully rerequested |
Список всех 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 |
постраничная выборка | object | Pagination information |
↳ count | number | Items in current page |
↳ next | number | Timestamp for next page request |
↳ prev | number | Timestamp for previous page request |
Получить информацию о 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 |
Список всех 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 |
постраничная выборка | object | Pagination information |
↳ hasNext | boolean | Произошла лиre are more pages |
↳ count | number | Items in current page |
Получить информацию о 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 |
