Vercel
Manage Vercel deployments, projects, and infrastructure
Integrate with Vercel to manage deployments, projects, domains, DNS records, environment variables, aliases, edge configs, teams, and more.
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
projectId | string | No | No description |
target | string | No | No description |
state | string | No | No description |
app | string | No | No description |
since | number | No | No description |
until | number | No | No description |
limit | number | No | No description |
teamId | string | No | No description |
| Parameter | Type | Description |
|---|
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 |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
deploymentId | string | Yes | No description |
withGitRepoInfo | string | No | No description |
teamId | string | No | No description |
| Parameter | Type | Description |
|---|
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 |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
name | string | Yes | No description |
project | string | No | No description |
deploymentId | string | No | No description |
target | string | No | No description |
gitSource | string | No | JSON string defining the Git Repository source to deploy (e.g. {"type":"github","repo":"owner/repo","ref":"main"}) |
forceNew | string | No | Forces a new deployment even if there is a previous similar deployment (0 or 1) |
teamId | string | No | No description |
| Parameter | Type | Description |
|---|
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 |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
deploymentId | string | Yes | No description |
teamId | string | No | No description |
| Parameter | Type | Description |
|---|
id | string | Deployment ID |
name | string | Deployment name |
state | string | Deployment state after cancellation |
url | string | Deployment URL |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
deploymentId | string | Yes | No description |
teamId | string | No | No description |
| Parameter | Type | Description |
|---|
uid | string | The removed deployment ID |
state | string | Deployment state after deletion (DELETED) |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
deploymentId | string | Yes | No description |
direction | string | No | No description |
follow | number | No | No description |
limit | number | No | No description |
since | number | No | No description |
until | number | No | No description |
teamId | string | No | No description |
| Parameter | Type | Description |
|---|
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 |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
deploymentId | string | Yes | No description |
teamId | string | No | No description |
| Parameter | Type | Description |
|---|
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 |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
search | string | No | No description |
limit | number | No | No description |
teamId | string | No | No description |
| Parameter | Type | Description |
|---|
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 |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
projectId | string | Yes | No description |
teamId | string | No | No description |
| Parameter | Type | Description |
|---|
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 |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
name | string | Yes | No description |
framework | string | No | No description |
gitRepository | json | No | No description |
buildCommand | string | No | No description |
outputDirectory | string | No | No description |
installCommand | string | No | No description |
teamId | string | No | No description |
| Parameter | Type | Description |
|---|
id | string | Project ID |
name | string | name output from the tool |
framework | string | Project framework |
createdAt | number | Creation timestamp |
updatedAt | number | Last updated timestamp |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
projectId | string | Yes | No description |
name | string | No | No description |
framework | string | No | No description |
buildCommand | string | No | No description |
outputDirectory | string | No | No description |
installCommand | string | No | No description |
teamId | string | No | No description |
| Parameter | Type | Description |
|---|
id | string | Project ID |
name | string | Project name |
framework | string | Project framework |
updatedAt | number | Last updated timestamp |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
projectId | string | Yes | No description |
teamId | string | No | No description |
| Parameter | Type | Description |
|---|
deleted | boolean | Whether the project was successfully deleted |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
projectId | string | Yes | No description |
teamId | string | No | No description |
| Parameter | Type | Description |
|---|
id | string | Project ID |
name | string | Project name |
paused | boolean | Whether the project is paused |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
projectId | string | Yes | No description |
teamId | string | No | No description |
| Parameter | Type | Description |
|---|
id | string | Project ID |
name | string | Project name |
paused | boolean | Whether the project is paused |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
projectId | string | Yes | No description |
teamId | string | No | No description |
limit | number | No | No description |
| Parameter | Type | Description |
|---|
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 |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
projectId | string | Yes | No description |
domain | string | Yes | No description |
redirect | string | No | No description |
redirectStatusCode | number | No | No description |
gitBranch | string | No | No description |
teamId | string | No | No description |
| Parameter | Type | Description |
|---|
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 | redirectStatusCode output from the tool |
createdAt | number | Creation timestamp |
updatedAt | number | Last updated timestamp |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
projectId | string | Yes | No description |
domain | string | Yes | No description |
teamId | string | No | No description |
| Parameter | Type | Description |
|---|
deleted | boolean | Whether the domain was successfully removed |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
projectId | string | Yes | No description |
teamId | string | No | No description |
| Parameter | Type | Description |
|---|
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 |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
projectId | string | Yes | No description |
key | string | Yes | No description |
value | string | Yes | No description |
target | string | Yes | No description |
type | string | No | No description |
gitBranch | string | No | No description |
comment | string | No | No description |
teamId | string | No | No description |
| Parameter | Type | Description |
|---|
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 |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
projectId | string | Yes | No description |
envId | string | Yes | No description |
key | string | No | No description |
value | string | No | No description |
target | string | No | No description |
type | string | No | No description |
gitBranch | string | No | No description |
comment | string | No | No description |
teamId | string | No | No description |
| Parameter | Type | Description |
|---|
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 |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
projectId | string | Yes | No description |
envId | string | Yes | No description |
teamId | string | No | No description |
| Parameter | Type | Description |
|---|
deleted | boolean | Whether the environment variable was successfully deleted |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
limit | number | No | No description |
teamId | string | No | No description |
| Parameter | Type | Description |
|---|
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 |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
domain | string | Yes | No description |
teamId | string | No | No description |
| Parameter | Type | Description |
|---|
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 |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
name | string | Yes | No description |
teamId | string | No | No description |
| Parameter | Type | Description |
|---|
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 |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
domain | string | Yes | No description |
teamId | string | No | No description |
| Parameter | Type | Description |
|---|
uid | string | The ID of the deleted domain |
deleted | boolean | Whether the domain was deleted |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
domain | string | Yes | No description |
teamId | string | No | No description |
| Parameter | Type | Description |
|---|
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 |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
domain | string | Yes | No description |
limit | number | No | No description |
teamId | string | No | No description |
| Parameter | Type | Description |
|---|
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 |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
domain | string | Yes | No description |
recordName | string | Yes | No description |
recordType | string | Yes | No description |
value | string | Yes | No description |
ttl | number | No | No description |
mxPriority | number | No | No description |
teamId | string | No | No description |
| Parameter | Type | Description |
|---|
uid | string | The DNS record ID |
updated | number | Timestamp of the update |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
domain | string | Yes | No description |
recordId | string | Yes | No description |
teamId | string | No | No description |
| Parameter | Type | Description |
|---|
deleted | boolean | Whether the record was deleted |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
projectId | string | No | No description |
domain | string | No | No description |
limit | number | No | No description |
teamId | string | No | No description |
| Parameter | Type | Description |
|---|
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 |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
aliasId | string | Yes | No description |
teamId | string | No | No description |
| Parameter | Type | Description |
|---|
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) |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
deploymentId | string | Yes | No description |
alias | string | Yes | No description |
teamId | string | No | No description |
| Parameter | Type | Description |
|---|
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 |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
aliasId | string | Yes | No description |
teamId | string | No | No description |
| Parameter | Type | Description |
|---|
status | string | Deletion status (SUCCESS) |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
teamId | string | No | No description |
| Parameter | Type | Description |
|---|
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 |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
edgeConfigId | string | Yes | No description |
teamId | string | No | No description |
| Parameter | Type | Description |
|---|
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 |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
slug | string | Yes | No description |
teamId | string | No | No description |
| Parameter | Type | Description |
|---|
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 |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
edgeConfigId | string | Yes | No description |
teamId | string | No | No description |
| Parameter | Type | Description |
|---|
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 |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
edgeConfigId | string | Yes | No description |
items | json | Yes | Array of operations: [{operation: "create"|"update"|"upsert"|"delete", key: string, value?: any}] |
teamId | string | No | No description |
| Parameter | Type | Description |
|---|
status | string | Operation status |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
projectId | string | No | No description |
teamId | string | No | No description |
| Parameter | Type | Description |
|---|
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 |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
url | string | Yes | No description |
events | string | Yes | No description |
projectIds | string | No | No description |
teamId | string | Yes | No description |
| Parameter | Type | Description |
|---|
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 |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
webhookId | string | Yes | No description |
teamId | string | No | No description |
| Parameter | Type | Description |
|---|
deleted | boolean | Whether the webhook was successfully deleted |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
deploymentId | string | Yes | No description |
name | string | Yes | No description |
blocking | boolean | Yes | No description |
path | string | No | No description |
detailsUrl | string | No | No description |
externalId | string | No | No description |
rerequestable | boolean | No | No description |
teamId | string | No | No description |
| Parameter | Type | Description |
|---|
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 | blocking output from the tool |
deploymentId | string | Associated deployment ID |
integrationId | string | Associated integration ID |
externalId | string | External identifier |
detailsUrl | string | detailsUrl output from the tool |
path | string | path output from the tool |
rerequestable | boolean | rerequestable output from the tool |
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 |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
deploymentId | string | Yes | No description |
checkId | string | Yes | No description |
teamId | string | No | No description |
| Parameter | Type | Description |
|---|
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 |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
deploymentId | string | Yes | No description |
teamId | string | No | No description |
| Parameter | Type | Description |
|---|
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 |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
deploymentId | string | Yes | No description |
checkId | string | Yes | No description |
name | string | No | No description |
status | string | No | No description |
conclusion | string | No | No description |
detailsUrl | string | No | No description |
externalId | string | No | No description |
path | string | No | No description |
output | string | No | No description |
teamId | string | No | No description |
| Parameter | Type | Description |
|---|
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 | detailsUrl output from the tool |
path | string | path output from the tool |
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 |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
deploymentId | string | Yes | No description |
checkId | string | Yes | No description |
teamId | string | No | No description |
| Parameter | Type | Description |
|---|
rerequested | boolean | Whether the check was successfully rerequested |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
limit | number | No | No description |
since | number | No | No description |
until | number | No | No description |
| Parameter | Type | Description |
|---|
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 |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
teamId | string | Yes | No description |
| Parameter | Type | Description |
|---|
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 |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
teamId | string | Yes | No description |
limit | number | No | No description |
role | string | No | Filter by role (OWNER, MEMBER, DEVELOPER, SECURITY, BILLING, VIEWER, VIEWER_FOR_PLUS, CONTRIBUTOR) |
since | number | No | No description |
until | number | No | No description |
search | string | No | No description |
| Parameter | Type | Description |
|---|
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 |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
| Parameter | Type | Description |
|---|
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 |