Overview
Add Vercel to any ModuleX agent or workflow. Manage Vercel deployments, projects, domains, DNS records, environment variables, aliases, edge configs, teams, webhooks, and deployment checks through the Vercel REST API (api.vercel.com).
Categories: Developer Tools & Infrastructure · Cloud Infrastructure · Tools · Auth: API Key · Actions: 56
Authentication
API Key Authentication
Authenticate using your Vercel Access Token1
Step 1
Sign in at https://vercel.com and open Account Settings → Tokens
2
Step 2
Click ‘Create Token’, enter a name and (recommended) an expiration
3
Step 3
Copy the generated token (it is shown only once)
4
Step 4
Paste the token below
Required Credentials
| Field | Description | Required | Format |
|---|---|---|---|
| Vercel Access Token | Your Vercel Access Token from the Account Tokens page | Yes | - |
Available Actions
list_deployments — List deployments for a Vercel project or team.
list_deployments — List deployments for a Vercel project or team.
Parameters
string
Filter deployments by project ID or name
string
Filter by environment: production or staging
string
Filter by state: BUILDING, ERROR, INITIALIZING, QUEUED, READY, CANCELED, BLOCKED
string
Filter by deployment name
integer
Get deployments created after this timestamp
integer
Get deployments created before this timestamp
integer
Maximum number of deployments to return
string
Team ID to scope the request
Response
{
"$defs": {
"DeploymentCreator": {
"additionalProperties": false,
"properties": {
"uid": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Uid"
},
"email": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Email"
},
"username": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Username"
}
},
"title": "DeploymentCreator",
"type": "object"
},
"DeploymentItem": {
"additionalProperties": false,
"properties": {
"uid": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Uid"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Name"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Url"
},
"state": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "State"
},
"target": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Target"
},
"created": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Created"
},
"project_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Project Id"
},
"source": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Source"
},
"inspector_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Inspector Url"
},
"checks_state": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Checks State"
},
"checks_conclusion": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Checks Conclusion"
},
"error_message": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error Message"
},
"creator": {
"anyOf": [
{
"$ref": "#/$defs/DeploymentCreator"
},
{
"type": "null"
}
],
"default": null
},
"meta": {
"additionalProperties": true,
"title": "Meta",
"type": "object"
}
},
"title": "DeploymentItem",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"deployments": {
"items": {
"$ref": "#/$defs/DeploymentItem"
},
"title": "Deployments",
"type": "array"
},
"count": {
"default": 0,
"title": "Count",
"type": "integer"
},
"has_more": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Has More"
}
},
"required": [
"success"
],
"title": "ListDeploymentsOutput",
"type": "object"
}
get_deployment — Get details of a specific Vercel deployment.
get_deployment — Get details of a specific Vercel deployment.
Parameters
string
required
The unique deployment identifier or hostname
string
Whether to add gitRepo information (true/false)
string
Team ID to scope the request
Response
{
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Name"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Url"
},
"ready_state": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Ready State"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Status"
},
"target": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Target"
},
"created_at": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Created At"
},
"building_at": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Building At"
},
"ready": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Ready"
},
"source": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Source"
},
"alias": {
"items": {
"type": "string"
},
"title": "Alias",
"type": "array"
},
"regions": {
"items": {
"type": "string"
},
"title": "Regions",
"type": "array"
},
"inspector_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Inspector Url"
},
"project_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Project Id"
},
"creator": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Creator"
},
"project": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Project"
},
"meta": {
"additionalProperties": true,
"title": "Meta",
"type": "object"
},
"git_source": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Git Source"
},
"error_code": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error Code"
},
"error_message": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error Message"
},
"alias_assigned": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Alias Assigned"
}
},
"required": [
"success"
],
"title": "GetDeploymentOutput",
"type": "object"
}
create_deployment — Create a new deployment or redeploy an existing one.
create_deployment — Create a new deployment or redeploy an existing one.
Parameters
string
required
Project name for the deployment
string
Project ID (overrides name for project lookup)
string
Existing deployment ID to redeploy
string
Target environment: production, staging, or a custom environment
object
Git Repository source to deploy (e.g. {“type”:“github”,“repo”:“owner/repo”,“ref”:“main”})
string
Force a new deployment even if a similar one exists (0 or 1)
string
Team ID to scope the request
Response
{
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Name"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Url"
},
"ready_state": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Ready State"
},
"project_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Project Id"
},
"created_at": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Created At"
},
"alias": {
"items": {
"type": "string"
},
"title": "Alias",
"type": "array"
},
"target": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Target"
},
"inspector_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Inspector Url"
},
"error_code": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error Code"
},
"error_message": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error Message"
},
"alias_assigned": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Alias Assigned"
}
},
"required": [
"success"
],
"title": "CreateDeploymentOutput",
"type": "object"
}
cancel_deployment — Cancel a running Vercel deployment.
cancel_deployment — Cancel a running Vercel deployment.
Parameters
string
required
The deployment ID to cancel
string
Team ID to scope the request
Response
{
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Name"
},
"state": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "State"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Url"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Status"
},
"project_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Project Id"
},
"inspector_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Inspector Url"
}
},
"required": [
"success"
],
"title": "CancelDeploymentOutput",
"type": "object"
}
delete_deployment — Delete a Vercel deployment.
delete_deployment — Delete a Vercel deployment.
Parameters
string
required
The deployment ID or URL to delete
string
Team ID to scope the request
Response
{
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"uid": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Uid"
},
"state": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "State"
}
},
"required": [
"success"
],
"title": "DeleteDeploymentOutput",
"type": "object"
}
get_deployment_events — Get build and runtime events for a Vercel deployment.
get_deployment_events — Get build and runtime events for a Vercel deployment.
Parameters
string
required
The unique deployment identifier or hostname
string
Order of events by timestamp: backward or forward
integer
When set to 1, returns live events as they happen
integer
Maximum number of events to return (-1 for all)
integer
Timestamp to start pulling build logs from
integer
Timestamp to stop pulling build logs at
string
Team ID to scope the request
Response
{
"$defs": {
"DeploymentEvent": {
"additionalProperties": false,
"properties": {
"type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Type"
},
"created": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Created"
},
"date": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Date"
},
"text": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Text"
},
"serial": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Serial"
},
"deployment_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Deployment Id"
},
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"level": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Level"
},
"info": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Info"
}
},
"title": "DeploymentEvent",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"events": {
"items": {
"$ref": "#/$defs/DeploymentEvent"
},
"title": "Events",
"type": "array"
},
"count": {
"default": 0,
"title": "Count",
"type": "integer"
}
},
"required": [
"success"
],
"title": "GetDeploymentEventsOutput",
"type": "object"
}
list_deployment_files — List file-tree metadata for a Vercel deployment.
list_deployment_files — List file-tree metadata for a Vercel deployment.
Parameters
string
required
The deployment ID to list files for
string
Team ID to scope the request
Response
{
"$defs": {
"DeploymentFile": {
"additionalProperties": false,
"properties": {
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Name"
},
"type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Type"
},
"uid": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Uid"
},
"mode": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Mode"
},
"content_type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Content Type"
},
"children": {
"items": {},
"title": "Children",
"type": "array"
}
},
"title": "DeploymentFile",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"files": {
"items": {
"$ref": "#/$defs/DeploymentFile"
},
"title": "Files",
"type": "array"
},
"count": {
"default": 0,
"title": "Count",
"type": "integer"
}
},
"required": [
"success"
],
"title": "ListDeploymentFilesOutput",
"type": "object"
}
promote_deployment — Promote a deployment to production for the given project.
promote_deployment — Promote a deployment to production for the given project.
Parameters
string
required
Project ID or name
string
required
The ID of the deployment to promote to production
string
Team ID to scope the request
Response
{
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"promoted": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Promoted"
}
},
"required": [
"success"
],
"title": "PromoteDeploymentOutput",
"type": "object"
}
list_projects — List all projects in a Vercel team or account.
list_projects — List all projects in a Vercel team or account.
Parameters
string
Search projects by name
integer
Maximum number of projects to return
string
Team ID to scope the request
Response
{
"$defs": {
"ProjectItem": {
"additionalProperties": false,
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Name"
},
"framework": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Framework"
},
"created_at": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Created At"
},
"updated_at": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Updated At"
}
},
"title": "ProjectItem",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"projects": {
"items": {
"$ref": "#/$defs/ProjectItem"
},
"title": "Projects",
"type": "array"
},
"count": {
"default": 0,
"title": "Count",
"type": "integer"
},
"has_more": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Has More"
}
},
"required": [
"success"
],
"title": "ListProjectsOutput",
"type": "object"
}
get_project — Get details of a specific Vercel project.
get_project — Get details of a specific Vercel project.
Parameters
string
required
Project ID or name
string
Team ID to scope the request
Response
{
"$defs": {
"ProjectLink": {
"additionalProperties": false,
"properties": {
"type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Type"
},
"repo": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Repo"
},
"org": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Org"
}
},
"title": "ProjectLink",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Name"
},
"framework": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Framework"
},
"created_at": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Created At"
},
"updated_at": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Updated At"
},
"link": {
"anyOf": [
{
"$ref": "#/$defs/ProjectLink"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"success"
],
"title": "GetProjectOutput",
"type": "object"
}
create_project — Create a new Vercel project.
create_project — Create a new Vercel project.
Parameters
string
required
Project name
string
Project framework (e.g. nextjs, remix, vite)
object
Git repository connection object with type and repo
string
Custom build command
string
Custom output directory
string
Custom install command
string
Team ID to scope the request
Response
{
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Name"
},
"framework": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Framework"
},
"created_at": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Created At"
},
"updated_at": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Updated At"
}
},
"required": [
"success"
],
"title": "CreateProjectOutput",
"type": "object"
}
update_project — Update an existing Vercel project.
update_project — Update an existing Vercel project.
Parameters
string
required
Project ID or name
string
New project name
string
Project framework (e.g. nextjs, remix, vite)
string
Custom build command
string
Custom output directory
string
Custom install command
string
Team ID to scope the request
Response
{
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Name"
},
"framework": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Framework"
},
"updated_at": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Updated At"
}
},
"required": [
"success"
],
"title": "UpdateProjectOutput",
"type": "object"
}
delete_project — Delete a Vercel project.
delete_project — Delete a Vercel project.
Parameters
string
required
Project ID or name
string
Team ID to scope the request
Response
{
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"deleted": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Deleted"
}
},
"required": [
"success"
],
"title": "DeleteProjectOutput",
"type": "object"
}
pause_project — Pause a Vercel project.
pause_project — Pause a Vercel project.
Parameters
string
required
Project ID or name
string
Team ID to scope the request
Response
{
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Name"
},
"paused": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Paused"
}
},
"required": [
"success"
],
"title": "PauseProjectOutput",
"type": "object"
}
unpause_project — Unpause a Vercel project.
unpause_project — Unpause a Vercel project.
Parameters
string
required
Project ID or name
string
Team ID to scope the request
Response
{
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Name"
},
"paused": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Paused"
}
},
"required": [
"success"
],
"title": "UnpauseProjectOutput",
"type": "object"
}
list_project_domains — List all domains for a Vercel project.
list_project_domains — List all domains for a Vercel project.
Parameters
string
required
Project ID or name
string
Team ID to scope the request
integer
Maximum number of domains to return
Response
{
"$defs": {
"DomainVerification": {
"additionalProperties": false,
"properties": {
"type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Type"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Domain"
},
"value": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Value"
},
"reason": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Reason"
}
},
"title": "DomainVerification",
"type": "object"
},
"ProjectDomainItem": {
"additionalProperties": false,
"properties": {
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Name"
},
"apex_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Apex Name"
},
"redirect": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Redirect"
},
"redirect_status_code": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Redirect Status Code"
},
"verified": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Verified"
},
"git_branch": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Git Branch"
},
"created_at": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Created At"
},
"updated_at": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Updated At"
},
"project_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Project Id"
},
"verification": {
"items": {
"$ref": "#/$defs/DomainVerification"
},
"title": "Verification",
"type": "array"
}
},
"title": "ProjectDomainItem",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"domains": {
"items": {
"$ref": "#/$defs/ProjectDomainItem"
},
"title": "Domains",
"type": "array"
},
"count": {
"default": 0,
"title": "Count",
"type": "integer"
},
"has_more": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Has More"
}
},
"required": [
"success"
],
"title": "ListProjectDomainsOutput",
"type": "object"
}
add_project_domain — Add a domain to a Vercel project.
add_project_domain — Add a domain to a Vercel project.
Parameters
string
required
Project ID or name
string
required
Domain name to add
string
Target domain for redirect
integer
HTTP status code for redirect (301, 302, 307, 308)
string
Git branch to link the domain to
string
Team ID to scope the request
Response
{
"$defs": {
"DomainVerification": {
"additionalProperties": false,
"properties": {
"type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Type"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Domain"
},
"value": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Value"
},
"reason": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Reason"
}
},
"title": "DomainVerification",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Name"
},
"apex_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Apex Name"
},
"project_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Project Id"
},
"verified": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Verified"
},
"git_branch": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Git Branch"
},
"redirect": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Redirect"
},
"redirect_status_code": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Redirect Status Code"
},
"verification": {
"items": {
"$ref": "#/$defs/DomainVerification"
},
"title": "Verification",
"type": "array"
},
"created_at": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Created At"
},
"updated_at": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Updated At"
}
},
"required": [
"success"
],
"title": "AddProjectDomainOutput",
"type": "object"
}
update_project_domain — Update a project domain's configuration on Vercel.
update_project_domain — Update a project domain's configuration on Vercel.
Parameters
string
required
Project ID or name
string
required
Domain name to update
string
Target destination domain for redirect
integer
HTTP status code for redirect (301, 302, 307, 308)
string
Git branch to link the domain to
string
Team ID to scope the request
Response
{
"$defs": {
"DomainVerification": {
"additionalProperties": false,
"properties": {
"type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Type"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Domain"
},
"value": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Value"
},
"reason": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Reason"
}
},
"title": "DomainVerification",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Name"
},
"apex_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Apex Name"
},
"project_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Project Id"
},
"verified": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Verified"
},
"redirect": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Redirect"
},
"redirect_status_code": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Redirect Status Code"
},
"git_branch": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Git Branch"
},
"created_at": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Created At"
},
"updated_at": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Updated At"
},
"verification": {
"items": {
"$ref": "#/$defs/DomainVerification"
},
"title": "Verification",
"type": "array"
}
},
"required": [
"success"
],
"title": "UpdateProjectDomainOutput",
"type": "object"
}
verify_project_domain — Verify a Vercel project domain by checking its verification challenge.
verify_project_domain — Verify a Vercel project domain by checking its verification challenge.
Parameters
string
required
Project ID or name
string
required
Domain name to verify
string
Team ID to scope the request
Response
{
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Name"
},
"apex_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Apex Name"
},
"project_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Project Id"
},
"verified": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Verified"
},
"redirect": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Redirect"
},
"redirect_status_code": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Redirect Status Code"
},
"git_branch": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Git Branch"
},
"created_at": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Created At"
},
"updated_at": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Updated At"
}
},
"required": [
"success"
],
"title": "VerifyProjectDomainOutput",
"type": "object"
}
remove_project_domain — Remove a domain from a Vercel project.
remove_project_domain — Remove a domain from a Vercel project.
Parameters
string
required
Project ID or name
string
required
Domain name to remove
string
Team ID to scope the request
Response
{
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"deleted": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Deleted"
}
},
"required": [
"success"
],
"title": "RemoveProjectDomainOutput",
"type": "object"
}
get_env_vars — Retrieve environment variables for a Vercel project.
get_env_vars — Retrieve environment variables for a Vercel project.
Parameters
string
required
Project ID or name
string
Team ID to scope the request
Response
{
"$defs": {
"EnvVarItem": {
"additionalProperties": false,
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Key"
},
"value": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Value"
},
"type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Type"
},
"target": {
"items": {
"type": "string"
},
"title": "Target",
"type": "array"
},
"git_branch": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Git Branch"
},
"comment": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Comment"
},
"created_at": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Created At"
},
"updated_at": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Updated At"
}
},
"title": "EnvVarItem",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"envs": {
"items": {
"$ref": "#/$defs/EnvVarItem"
},
"title": "Envs",
"type": "array"
},
"count": {
"default": 0,
"title": "Count",
"type": "integer"
}
},
"required": [
"success"
],
"title": "GetEnvVarsOutput",
"type": "object"
}
create_env_var — Create an environment variable for a Vercel project.
create_env_var — Create an environment variable for a Vercel project.
Parameters
string
required
Project ID or name
string
required
Environment variable name
string
required
Environment variable value
string
required
Comma-separated target environments (production, preview, development)
string
Variable type: system, encrypted, plain, or sensitive (Default:
plain)string
Git branch to associate (requires target to include preview)
string
Comment to add context (max 500 characters)
string
Team ID to scope the request
Response
{
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Key"
},
"value": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Value"
},
"type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Type"
},
"target": {
"items": {
"type": "string"
},
"title": "Target",
"type": "array"
},
"git_branch": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Git Branch"
},
"comment": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Comment"
},
"created_at": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Created At"
},
"updated_at": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Updated At"
}
},
"required": [
"success"
],
"title": "CreateEnvVarOutput",
"type": "object"
}
update_env_var — Update an environment variable for a Vercel project.
update_env_var — Update an environment variable for a Vercel project.
Parameters
string
required
Project ID or name
string
required
Environment variable ID to update
string
New variable name
string
New variable value
string
Comma-separated target environments (production, preview, development)
string
Variable type: system, encrypted, plain, or sensitive
string
Git branch to associate (requires target to include preview)
string
Comment to add context (max 500 characters)
string
Team ID to scope the request
Response
{
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Key"
},
"value": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Value"
},
"type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Type"
},
"target": {
"items": {
"type": "string"
},
"title": "Target",
"type": "array"
},
"git_branch": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Git Branch"
},
"comment": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Comment"
},
"created_at": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Created At"
},
"updated_at": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Updated At"
}
},
"required": [
"success"
],
"title": "UpdateEnvVarOutput",
"type": "object"
}
delete_env_var — Delete an environment variable from a Vercel project.
delete_env_var — Delete an environment variable from a Vercel project.
Parameters
string
required
Project ID or name
string
required
Environment variable ID to delete
string
Team ID to scope the request
Response
{
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"deleted": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Deleted"
}
},
"required": [
"success"
],
"title": "DeleteEnvVarOutput",
"type": "object"
}
list_domains — List all domains in a Vercel account or team.
list_domains — List all domains in a Vercel account or team.
Parameters
integer
Maximum number of domains to return
string
Team ID to scope the request
Response
{
"$defs": {
"DomainCreator": {
"additionalProperties": false,
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"username": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Username"
},
"email": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Email"
}
},
"title": "DomainCreator",
"type": "object"
},
"DomainItem": {
"additionalProperties": false,
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Name"
},
"verified": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Verified"
},
"created_at": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Created At"
},
"expires_at": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Expires At"
},
"service_type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Service Type"
},
"nameservers": {
"items": {
"type": "string"
},
"title": "Nameservers",
"type": "array"
},
"intended_nameservers": {
"items": {
"type": "string"
},
"title": "Intended Nameservers",
"type": "array"
},
"renew": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Renew"
},
"bought_at": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Bought At"
},
"transferred_at": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Transferred At"
},
"creator": {
"anyOf": [
{
"$ref": "#/$defs/DomainCreator"
},
{
"type": "null"
}
],
"default": null
}
},
"title": "DomainItem",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"domains": {
"items": {
"$ref": "#/$defs/DomainItem"
},
"title": "Domains",
"type": "array"
},
"count": {
"default": 0,
"title": "Count",
"type": "integer"
},
"has_more": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Has More"
}
},
"required": [
"success"
],
"title": "ListDomainsOutput",
"type": "object"
}
get_domain — Get information about a specific domain in a Vercel account.
get_domain — Get information about a specific domain in a Vercel account.
Parameters
string
required
The domain name to retrieve
string
Team ID to scope the request
Response
{
"$defs": {
"DomainCreator": {
"additionalProperties": false,
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"username": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Username"
},
"email": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Email"
}
},
"title": "DomainCreator",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Name"
},
"verified": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Verified"
},
"created_at": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Created At"
},
"expires_at": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Expires At"
},
"service_type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Service Type"
},
"nameservers": {
"items": {
"type": "string"
},
"title": "Nameservers",
"type": "array"
},
"intended_nameservers": {
"items": {
"type": "string"
},
"title": "Intended Nameservers",
"type": "array"
},
"custom_nameservers": {
"items": {
"type": "string"
},
"title": "Custom Nameservers",
"type": "array"
},
"renew": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Renew"
},
"bought_at": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Bought At"
},
"transferred_at": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Transferred At"
},
"creator": {
"anyOf": [
{
"$ref": "#/$defs/DomainCreator"
},
{
"type": "null"
}
],
"default": null
},
"user_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "User Id"
},
"team_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Team Id"
},
"transfer_started_at": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Transfer Started At"
}
},
"required": [
"success"
],
"title": "GetDomainOutput",
"type": "object"
}
add_domain — Add a new domain to a Vercel account or team.
add_domain — Add a new domain to a Vercel account or team.
Parameters
string
required
The domain name to add
string
Team ID to scope the request
Response
{
"$defs": {
"DomainCreator": {
"additionalProperties": false,
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"username": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Username"
},
"email": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Email"
}
},
"title": "DomainCreator",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Name"
},
"verified": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Verified"
},
"created_at": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Created At"
},
"service_type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Service Type"
},
"nameservers": {
"items": {
"type": "string"
},
"title": "Nameservers",
"type": "array"
},
"intended_nameservers": {
"items": {
"type": "string"
},
"title": "Intended Nameservers",
"type": "array"
},
"expires_at": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Expires At"
},
"custom_nameservers": {
"items": {
"type": "string"
},
"title": "Custom Nameservers",
"type": "array"
},
"renew": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Renew"
},
"bought_at": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Bought At"
},
"transferred_at": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Transferred At"
},
"creator": {
"anyOf": [
{
"$ref": "#/$defs/DomainCreator"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"success"
],
"title": "AddDomainOutput",
"type": "object"
}
delete_domain — Delete a domain from a Vercel account or team.
delete_domain — Delete a domain from a Vercel account or team.
Parameters
string
required
The domain name to delete
string
Team ID to scope the request
Response
{
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"uid": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Uid"
},
"deleted": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Deleted"
}
},
"required": [
"success"
],
"title": "DeleteDomainOutput",
"type": "object"
}
get_domain_config — Get the configuration for a domain in a Vercel account.
get_domain_config — Get the configuration for a domain in a Vercel account.
Parameters
string
required
The domain name to get configuration for
string
Team ID to scope the request
Response
{
"$defs": {
"DomainConfigCnameRecommendation": {
"additionalProperties": false,
"properties": {
"rank": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Rank"
},
"value": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Value"
}
},
"title": "DomainConfigCnameRecommendation",
"type": "object"
},
"DomainConfigIpv4Recommendation": {
"additionalProperties": false,
"properties": {
"rank": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Rank"
},
"value": {
"items": {
"type": "string"
},
"title": "Value",
"type": "array"
}
},
"title": "DomainConfigIpv4Recommendation",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"configured_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Configured By"
},
"accepted_challenges": {
"items": {
"type": "string"
},
"title": "Accepted Challenges",
"type": "array"
},
"misconfigured": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Misconfigured"
},
"recommended_ipv4": {
"items": {
"$ref": "#/$defs/DomainConfigIpv4Recommendation"
},
"title": "Recommended Ipv4",
"type": "array"
},
"recommended_cname": {
"items": {
"$ref": "#/$defs/DomainConfigCnameRecommendation"
},
"title": "Recommended Cname",
"type": "array"
}
},
"required": [
"success"
],
"title": "GetDomainConfigOutput",
"type": "object"
}
list_dns_records — List all DNS records for a domain in a Vercel account.
list_dns_records — List all DNS records for a domain in a Vercel account.
Parameters
string
required
The domain name to list records for
integer
Maximum number of records to return
string
Team ID to scope the request
Response
{
"$defs": {
"DnsRecordItem": {
"additionalProperties": false,
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"slug": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Slug"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Name"
},
"type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Type"
},
"value": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Value"
},
"ttl": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Ttl"
},
"mx_priority": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Mx Priority"
},
"priority": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Priority"
},
"creator": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Creator"
},
"created_at": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Created At"
},
"updated_at": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Updated At"
},
"comment": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Comment"
}
},
"title": "DnsRecordItem",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"records": {
"items": {
"$ref": "#/$defs/DnsRecordItem"
},
"title": "Records",
"type": "array"
},
"count": {
"default": 0,
"title": "Count",
"type": "integer"
},
"has_more": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Has More"
}
},
"required": [
"success"
],
"title": "ListDnsRecordsOutput",
"type": "object"
}
create_dns_record — Create a DNS record for a domain in a Vercel account.
create_dns_record — Create a DNS record for a domain in a Vercel account.
Parameters
string
required
The domain name to create the record for
string
required
The subdomain or record name
string
required
DNS record type (A, AAAA, ALIAS, CAA, CNAME, HTTPS, MX, SRV, TXT, NS)
string
required
The value of the DNS record
integer
Time to live in seconds
integer
Priority for MX records
string
Team ID to scope the request
Response
{
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"uid": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Uid"
},
"updated": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Updated"
}
},
"required": [
"success"
],
"title": "CreateDnsRecordOutput",
"type": "object"
}
update_dns_record — Update an existing DNS record for a domain in a Vercel account.
update_dns_record — Update an existing DNS record for a domain in a Vercel account.
Parameters
string
required
The ID of the DNS record to update
string
The name of the DNS record
string
The value of the DNS record
string
DNS record type (A, AAAA, ALIAS, CAA, CNAME, HTTPS, MX, SRV, TXT, NS)
integer
Time to live in seconds (60 to 2147483647)
integer
Priority for MX records
string
Comment to add context (max 500 characters)
string
Team ID to scope the request
Response
{
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Name"
},
"type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Type"
},
"value": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Value"
},
"creator": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Creator"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Domain"
},
"ttl": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Ttl"
},
"comment": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Comment"
},
"record_type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Record Type"
},
"created_at": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Created At"
}
},
"required": [
"success"
],
"title": "UpdateDnsRecordOutput",
"type": "object"
}
delete_dns_record — Delete a DNS record for a domain in a Vercel account.
delete_dns_record — Delete a DNS record for a domain in a Vercel account.
Parameters
string
required
The domain name the record belongs to
string
required
The ID of the DNS record to delete
string
Team ID to scope the request
Response
{
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"deleted": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Deleted"
}
},
"required": [
"success"
],
"title": "DeleteDnsRecordOutput",
"type": "object"
}
list_aliases — List aliases for a Vercel project or team.
list_aliases — List aliases for a Vercel project or team.
Parameters
string
Filter aliases by project ID
string
Filter aliases by domain
integer
Maximum number of aliases to return
string
Team ID to scope the request
Response
{
"$defs": {
"AliasItem": {
"additionalProperties": false,
"properties": {
"uid": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Uid"
},
"alias": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Alias"
},
"deployment_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Deployment Id"
},
"project_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Project Id"
},
"created_at": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Created At"
},
"updated_at": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Updated At"
},
"deployment": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Deployment"
},
"redirect": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Redirect"
},
"redirect_status_code": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Redirect Status Code"
}
},
"title": "AliasItem",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"aliases": {
"items": {
"$ref": "#/$defs/AliasItem"
},
"title": "Aliases",
"type": "array"
},
"count": {
"default": 0,
"title": "Count",
"type": "integer"
},
"has_more": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Has More"
}
},
"required": [
"success"
],
"title": "ListAliasesOutput",
"type": "object"
}
get_alias — Get details about a specific alias by ID or hostname.
get_alias — Get details about a specific alias by ID or hostname.
Parameters
string
required
Alias ID or hostname to look up
string
Team ID to scope the request
Response
{
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"uid": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Uid"
},
"alias": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Alias"
},
"deployment_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Deployment Id"
},
"project_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Project Id"
},
"created_at": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Created At"
},
"updated_at": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Updated At"
},
"redirect": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Redirect"
},
"redirect_status_code": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Redirect Status Code"
},
"deployment": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Deployment"
}
},
"required": [
"success"
],
"title": "GetAliasOutput",
"type": "object"
}
create_alias — Assign an alias (domain/subdomain) to a deployment.
create_alias — Assign an alias (domain/subdomain) to a deployment.
Parameters
string
required
Deployment ID to assign the alias to
string
required
The domain or subdomain to assign as an alias
string
Team ID to scope the request
Response
{
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"uid": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Uid"
},
"alias": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Alias"
},
"created": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Created"
},
"old_deployment_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Old Deployment Id"
}
},
"required": [
"success"
],
"title": "CreateAliasOutput",
"type": "object"
}
delete_alias — Delete an alias by its ID.
delete_alias — Delete an alias by its ID.
Parameters
string
required
Alias ID to delete
string
Team ID to scope the request
Response
{
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Status"
}
},
"required": [
"success"
],
"title": "DeleteAliasOutput",
"type": "object"
}
list_edge_configs — List all Edge Config stores for a team.
list_edge_configs — List all Edge Config stores for a team.
Parameters
string
Team ID to scope the request
Response
{
"$defs": {
"EdgeConfigStore": {
"additionalProperties": false,
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"slug": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Slug"
},
"owner_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Owner Id"
},
"digest": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Digest"
},
"created_at": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Created At"
},
"updated_at": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Updated At"
},
"item_count": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Item Count"
},
"size_in_bytes": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Size In Bytes"
}
},
"title": "EdgeConfigStore",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"edge_configs": {
"items": {
"$ref": "#/$defs/EdgeConfigStore"
},
"title": "Edge Configs",
"type": "array"
},
"count": {
"default": 0,
"title": "Count",
"type": "integer"
}
},
"required": [
"success"
],
"title": "ListEdgeConfigsOutput",
"type": "object"
}
get_edge_config — Get details about a specific Edge Config store.
get_edge_config — Get details about a specific Edge Config store.
Parameters
string
required
Edge Config ID to look up
string
Team ID to scope the request
Response
{
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"slug": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Slug"
},
"owner_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Owner Id"
},
"digest": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Digest"
},
"created_at": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Created At"
},
"updated_at": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Updated At"
},
"item_count": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Item Count"
},
"size_in_bytes": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Size In Bytes"
}
},
"required": [
"success"
],
"title": "GetEdgeConfigOutput",
"type": "object"
}
create_edge_config — Create a new Edge Config store.
create_edge_config — Create a new Edge Config store.
Parameters
string
required
The name/slug for the new Edge Config
string
Team ID to scope the request
Response
{
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"slug": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Slug"
},
"owner_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Owner Id"
},
"digest": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Digest"
},
"created_at": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Created At"
},
"updated_at": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Updated At"
},
"item_count": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Item Count"
},
"size_in_bytes": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Size In Bytes"
}
},
"required": [
"success"
],
"title": "CreateEdgeConfigOutput",
"type": "object"
}
get_edge_config_items — Get all items in an Edge Config store.
get_edge_config_items — Get all items in an Edge Config store.
Parameters
string
required
Edge Config ID to get items from
string
Team ID to scope the request
Response
{
"$defs": {
"EdgeConfigItem": {
"additionalProperties": false,
"properties": {
"key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Key"
},
"value": {
"default": null,
"title": "Value"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Description"
},
"edge_config_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Edge Config Id"
},
"created_at": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Created At"
},
"updated_at": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Updated At"
}
},
"title": "EdgeConfigItem",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"items": {
"items": {
"$ref": "#/$defs/EdgeConfigItem"
},
"title": "Items",
"type": "array"
},
"count": {
"default": 0,
"title": "Count",
"type": "integer"
}
},
"required": [
"success"
],
"title": "GetEdgeConfigItemsOutput",
"type": "object"
}
update_edge_config_items — Create, update, upsert, or delete items in an Edge Config store.
update_edge_config_items — Create, update, upsert, or delete items in an Edge Config store.
Parameters
string
required
Edge Config ID to update items in
array
required
Array of operations: [{“operation”: “create|update|upsert|delete”, “key”: ”…”, “value”: …}]
string
Team ID to scope the request
Response
{
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Status"
}
},
"required": [
"success"
],
"title": "UpdateEdgeConfigItemsOutput",
"type": "object"
}
delete_edge_config — Delete an Edge Config store by ID.
delete_edge_config — Delete an Edge Config store by ID.
Parameters
string
required
Edge Config ID to delete
string
Team ID to scope the request
Response
{
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"deleted": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Deleted"
}
},
"required": [
"success"
],
"title": "DeleteEdgeConfigOutput",
"type": "object"
}
list_webhooks — List webhooks for a Vercel project or team.
list_webhooks — List webhooks for a Vercel project or team.
Parameters
string
Filter webhooks by project ID
string
Team ID to scope the request
Response
{
"$defs": {
"WebhookItem": {
"additionalProperties": false,
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Url"
},
"events": {
"items": {
"type": "string"
},
"title": "Events",
"type": "array"
},
"owner_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Owner Id"
},
"project_ids": {
"items": {
"type": "string"
},
"title": "Project Ids",
"type": "array"
},
"projects_metadata": {
"items": {},
"title": "Projects Metadata",
"type": "array"
},
"created_at": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Created At"
},
"updated_at": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Updated At"
}
},
"title": "WebhookItem",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"webhooks": {
"items": {
"$ref": "#/$defs/WebhookItem"
},
"title": "Webhooks",
"type": "array"
},
"count": {
"default": 0,
"title": "Count",
"type": "integer"
}
},
"required": [
"success"
],
"title": "ListWebhooksOutput",
"type": "object"
}
get_webhook — Get details about a specific Vercel webhook.
get_webhook — Get details about a specific Vercel webhook.
Parameters
string
required
Webhook ID to look up
string
Team ID to scope the request
Response
{
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Url"
},
"events": {
"items": {
"type": "string"
},
"title": "Events",
"type": "array"
},
"owner_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Owner Id"
},
"project_ids": {
"items": {
"type": "string"
},
"title": "Project Ids",
"type": "array"
},
"created_at": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Created At"
},
"updated_at": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Updated At"
}
},
"required": [
"success"
],
"title": "GetWebhookOutput",
"type": "object"
}
create_webhook — Create a new webhook for a Vercel team or account.
create_webhook — Create a new webhook for a Vercel team or account.
Parameters
string
required
Webhook URL (must be https)
string
required
Comma-separated event names to subscribe to
string
Comma-separated project IDs to scope the webhook to
string
Team ID to scope the request
Response
{
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Url"
},
"secret": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Secret"
},
"events": {
"items": {
"type": "string"
},
"title": "Events",
"type": "array"
},
"owner_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Owner Id"
},
"project_ids": {
"items": {
"type": "string"
},
"title": "Project Ids",
"type": "array"
},
"created_at": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Created At"
},
"updated_at": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Updated At"
}
},
"required": [
"success"
],
"title": "CreateWebhookOutput",
"type": "object"
}
delete_webhook — Delete a webhook from a Vercel team or account.
delete_webhook — Delete a webhook from a Vercel team or account.
Parameters
string
required
The webhook ID to delete
string
Team ID to scope the request
Response
{
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"deleted": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Deleted"
}
},
"required": [
"success"
],
"title": "DeleteWebhookOutput",
"type": "object"
}
create_check — Create a new deployment check.
create_check — Create a new deployment check.
Parameters
string
required
Deployment ID to create the check for
string
required
Name of the check (max 100 characters)
boolean
required
Whether the check blocks the deployment
string
Page path being checked
string
URL with details about the check
string
External identifier for the check
boolean
Whether the check can be rerequested
string
Team ID to scope the request
Response
{
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Name"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Status"
},
"conclusion": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Conclusion"
},
"blocking": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Blocking"
},
"deployment_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Deployment Id"
},
"integration_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Integration Id"
},
"external_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "External Id"
},
"details_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Details Url"
},
"path": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Path"
},
"rerequestable": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Rerequestable"
},
"created_at": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Created At"
},
"updated_at": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Updated At"
},
"started_at": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Started At"
},
"completed_at": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Completed At"
},
"output": {
"default": null,
"title": "Output"
}
},
"required": [
"success"
],
"title": "CheckOutput",
"type": "object"
}
get_check — Get details of a specific deployment check.
get_check — Get details of a specific deployment check.
Parameters
string
required
Deployment ID the check belongs to
string
required
Check ID to retrieve
string
Team ID to scope the request
Response
{
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Name"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Status"
},
"conclusion": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Conclusion"
},
"blocking": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Blocking"
},
"deployment_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Deployment Id"
},
"integration_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Integration Id"
},
"external_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "External Id"
},
"details_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Details Url"
},
"path": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Path"
},
"rerequestable": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Rerequestable"
},
"created_at": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Created At"
},
"updated_at": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Updated At"
},
"started_at": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Started At"
},
"completed_at": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Completed At"
},
"output": {
"default": null,
"title": "Output"
}
},
"required": [
"success"
],
"title": "GetCheckOutput",
"type": "object"
}
list_checks — List all checks for a deployment.
list_checks — List all checks for a deployment.
Parameters
string
required
Deployment ID to list checks for
string
Team ID to scope the request
Response
{
"$defs": {
"CheckItem": {
"additionalProperties": false,
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Name"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Status"
},
"conclusion": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Conclusion"
},
"blocking": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Blocking"
},
"deployment_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Deployment Id"
},
"integration_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Integration Id"
},
"external_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "External Id"
},
"details_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Details Url"
},
"path": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Path"
},
"rerequestable": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Rerequestable"
},
"created_at": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Created At"
},
"updated_at": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Updated At"
},
"started_at": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Started At"
},
"completed_at": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Completed At"
},
"output": {
"default": null,
"title": "Output"
}
},
"title": "CheckItem",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"checks": {
"items": {
"$ref": "#/$defs/CheckItem"
},
"title": "Checks",
"type": "array"
},
"count": {
"default": 0,
"title": "Count",
"type": "integer"
}
},
"required": [
"success"
],
"title": "ListChecksOutput",
"type": "object"
}
update_check — Update an existing deployment check.
update_check — Update an existing deployment check.
Parameters
string
required
Deployment ID the check belongs to
string
required
Check ID to update
string
Updated name of the check
string
Updated status: running or completed
string
Check conclusion: canceled, failed, neutral, succeeded, or skipped
string
URL with details about the check
string
External identifier for the check
string
Page path being checked
object
Check output metrics object
string
Team ID to scope the request
Response
{
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Name"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Status"
},
"conclusion": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Conclusion"
},
"blocking": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Blocking"
},
"deployment_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Deployment Id"
},
"integration_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Integration Id"
},
"external_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "External Id"
},
"details_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Details Url"
},
"path": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Path"
},
"rerequestable": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Rerequestable"
},
"created_at": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Created At"
},
"updated_at": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Updated At"
},
"started_at": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Started At"
},
"completed_at": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Completed At"
},
"output": {
"default": null,
"title": "Output"
}
},
"required": [
"success"
],
"title": "UpdateCheckOutput",
"type": "object"
}
rerequest_check — Rerequest a deployment check.
rerequest_check — Rerequest a deployment check.
Parameters
string
required
Deployment ID the check belongs to
string
required
Check ID to rerequest
string
Team ID to scope the request
Response
{
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"rerequested": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Rerequested"
}
},
"required": [
"success"
],
"title": "RerequestCheckOutput",
"type": "object"
}
list_teams — List all teams in a Vercel account.
list_teams — List all teams in a Vercel account.
Parameters
integer
Maximum number of teams to return
integer
Only include teams created since this timestamp (ms)
integer
Only include teams created until this timestamp (ms)
Response
{
"$defs": {
"TeamItem": {
"additionalProperties": false,
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"slug": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Slug"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Name"
},
"avatar": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Avatar"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Description"
},
"staging_prefix": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Staging Prefix"
},
"created_at": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Created At"
},
"updated_at": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Updated At"
},
"creator_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Creator Id"
},
"membership": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Membership"
}
},
"title": "TeamItem",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"teams": {
"items": {
"$ref": "#/$defs/TeamItem"
},
"title": "Teams",
"type": "array"
},
"count": {
"default": 0,
"title": "Count",
"type": "integer"
},
"pagination": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Pagination"
}
},
"required": [
"success"
],
"title": "ListTeamsOutput",
"type": "object"
}
get_team — Get information about a specific Vercel team.
get_team — Get information about a specific Vercel team.
Parameters
string
required
The team ID to retrieve
Response
{
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"slug": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Slug"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Name"
},
"avatar": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Avatar"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Description"
},
"staging_prefix": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Staging Prefix"
},
"created_at": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Created At"
},
"updated_at": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Updated At"
},
"creator_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Creator Id"
},
"membership": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Membership"
}
},
"required": [
"success"
],
"title": "GetTeamOutput",
"type": "object"
}
list_team_members — List all members of a Vercel team.
list_team_members — List all members of a Vercel team.
Parameters
string
required
The team ID to list members for
integer
Maximum number of members to return
string
Filter by role (OWNER, MEMBER, DEVELOPER, SECURITY, BILLING, VIEWER, CONTRIBUTOR)
integer
Only include members added since this timestamp (ms)
integer
Only include members added until this timestamp (ms)
string
Search members by name, username, and email
Response
{
"$defs": {
"TeamMember": {
"additionalProperties": false,
"properties": {
"uid": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Uid"
},
"email": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Email"
},
"username": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Username"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Name"
},
"avatar": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Avatar"
},
"role": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Role"
},
"confirmed": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Confirmed"
},
"created_at": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Created At"
},
"access_requested_at": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Access Requested At"
},
"is_enterprise_managed": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Is Enterprise Managed"
},
"joined_from": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Joined From"
}
},
"title": "TeamMember",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"members": {
"items": {
"$ref": "#/$defs/TeamMember"
},
"title": "Members",
"type": "array"
},
"count": {
"default": 0,
"title": "Count",
"type": "integer"
},
"pagination": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Pagination"
}
},
"required": [
"success"
],
"title": "ListTeamMembersOutput",
"type": "object"
}
get_user — Get information about the authenticated Vercel user.
get_user — Get information about the authenticated Vercel user.
Response
{
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"email": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Email"
},
"username": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Username"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Name"
},
"avatar": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Avatar"
},
"default_team_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Default Team Id"
},
"created_at": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Created At"
},
"staging_prefix": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Staging Prefix"
},
"soft_block": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Soft Block"
},
"has_trial_available": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Has Trial Available"
}
},
"required": [
"success"
],
"title": "GetUserOutput",
"type": "object"
}
Limits & Quotas
- Rate limits: the Vercel REST API enforces per-endpoint rate
limits; on
429the response carries aRetry-Afterheader. Plan for retries on the agent side based on the error string. - API versioning: each endpoint pins its own version in the path
(e.g.
/v13/deployments,/v9/projects,/v2/teams,/v1/edge-config); these are preserved as documented by Vercel. - Error model: non-2xx responses and timeouts are caught and
returned as
success=False+errorrather than raising.