[metadata]
color-scheme: dark light
description: Interact programmatically with your Vercel account using the SDK or direct HTTP requests.
googlebot: index, max-video-preview:-1, max-image-preview:large, max-snippet:-1
initiator-trace: 00-0f79d17cd2e6bb03940c369382e43588-1fa3403ba0a12948-01
robots: index, follow
theme-color: #0a0a0a
trace-attributes: {"next.appdir":true}
viewport: width=device-width, initial-scale=1, maximum-scale=1, viewport-fit=cover

[canonical-links]
https://vercel.com/docs/rest-api

[document-links]
/home
AI Apps: /solutions/ai-apps
AI Gateway: /ai-gateway
AI Gateway: /docs/ai-gateway
AI Integrations: /docs/agent-resources/integrations-for-models
AI SDK: /ai-sdk
AI SDK: /docs/ai-sdk
APIs & SDKs: /docs/rest-api
About: /about
Academy: /academy
Acceptable Use Policy: /legal/acceptable-use-policy
Access Groups 11 endpoint s: /docs/rest-api/access-groups/reads-an-access-group
Agent Skills: https://skills.sh
Ai Gateway 4 endpoint s: /docs/rest-api/ai-gateway/list-rules
Aliases 6 endpoint s: /docs/rest-api/aliases/list-deployment-aliases
All frameworks: /docs/frameworks
Articles: /i
Artifacts 7 endpoint s: /docs/rest-api/artifacts/record-an-artifacts-cache-usage-event
Authentication 5 endpoint s: /docs/rest-api/authentication/sso-token-exchange
Billing 3 endpoint s: /docs/rest-api/billing/list-focus-billing-charges
Blog ↗: https://vercel.com/blog
Blog: /blog
Bot ID: /botid
Bot Management: /docs/bot-management
Bot Management: /security/bot-management
BotID: /docs/botid
Bulk Redirects 7 endpoint s: /docs/rest-api/bulk-redirects/gets-project-level-redirects
CI/CD: /products/previews
CLI: /docs/cli
Careers: /careers
Certs 5 endpoint s: /docs/rest-api/certs/get-cert-by-id
Changelog ↗: https://vercel.com/changelog
Changelog: /changelog
Chat SDK New: /chat
Checks V2 10 endpoint s: /docs/rest-api/checks-v2/list-all-checks-for-a-project
Commerce: /solutions/composable-commerce
Community ↗: https://community.vercel.com
Community: https://community.vercel.com
Compliance: /docs/security/compliance
Connect 5 endpoint s: /docs/rest-api/connect/create-a-connector
Connect New: /connect
Container Registry: /docs/container-registry
Content Delivery: /cdn
Cookie Policy: /legal/cookie-policy
Customers: /customers
DNS 4 endpoint s: /docs/rest-api/dns/list-existing-dns-records
DPA: /legal/dpa
Delivery Network: /docs/cdn
Deployment Protection: /docs/deployment-protection
Deployments 10 endpoint s: /docs/rest-api/deployments/get-deployment-events
Deployments: /docs/deployments
Design Engineers: /solutions/design-engineering
Docs: /docs
Domains 9 endpoint s: /docs/rest-api/domains/get-a-domain-s-configuration
Domains Registrar 17 endpoint s: /docs/rest-api/domains-registrar/get-supported-tlds
Domains: /docs/domains
Domains: /domains
Drains 6 endpoint s: /docs/rest-api/drains/retrieve-a-list-of-all-drains
Edge Cache 4 endpoint s: /docs/rest-api/edge-cache/invalidate-by-tag
Enterprise: /enterprise
Environment 11 endpoint s: /docs/rest-api/environment/lists-all-shared-environment-variables-for-a-team
Errors: /docs/rest-api/errors
Events: /events
FastAPI: /docs/frameworks/backend/fastapi
Feature Flags 21 endpoint s: /docs/rest-api/feature-flags/list-flags
Feature Flags: /docs/flags
Firewall: /docs/vercel-firewall
Flags SDK: /docs/flags/flags-sdk-reference
Fluid Compute: /fluid
Functions: /docs/functions
Getting Started: /docs/getting-started-with-vercel
GitHub: https://github.com/vercel
Global Config 18 endpoint s: /docs/rest-api/global-config/get-global-configs
Help: /help
Instagram: https://www.instagram.com/vercel/
Integrations 10 endpoint s: /docs/rest-api/deployments/update-deployment-integration-action
Integrations: /docs/integrations
Knowledge Base: /kb
Legal (all documents): /legal
LinkedIn: https://linkedin.com/company/vercel
Log In: /login
Logs 1 endpoint: /docs/rest-api/logs/get-logs-for-a-deployment
Marketing Sites: /solutions/marketing-sites
Marketplace 23 endpoint s: /docs/rest-api/marketplace/update-installation
Marketplace: /marketplace
Microfrontends 5 endpoint s: /docs/rest-api/microfrontends/list-microfrontends-groups
Microfrontends: /docs/microfrontends
Networking 6 endpoint s: /docs/rest-api/networking/list-secure-compute-networks
Next.js: /frameworks/nextjs
Nitro: /docs/frameworks/backend/nitro
Nuxt: /docs/frameworks/full-stack/nuxt
Observability 2 endpoint s: /docs/rest-api/observability/lists-disabled-observability-plus-projects
Observability: /docs/observability
Observability: /products/observability
Open Source Program: /open-source-program
Overview: /docs/rest-api
Partner Finder: /partners/solution-partners
Passport New: /passport
Platform Engineers: /solutions/platform-engineering
Platform Security: /security
Platforms: /solutions/multi-tenant-saas
Press: /press
Pricing: /pricing
Privacy Policy: /legal/privacy-policy
Project Routes 8 endpoint s: /docs/rest-api/project-routes/get-project-routing-rules
Projectmembers 3 endpoint s: /docs/rest-api/projectmembers/list-project-members
Projects 32 endpoint s: /docs/rest-api/projects/retrieve-a-list-of-projects
Queues SDK New: /docs/queues/sdk
Rolling Release 8 endpoint s: /docs/rest-api/rolling-release/get-rolling-release-billing-status
Sandbox: /docs/sandbox
Sandbox: /sandbox
Sandboxes 27 endpoint s: /docs/rest-api/sandboxes/list-sandboxes
Security 13 endpoint s: /docs/rest-api/security/update-attack-challenge-mode
Shipped on Vercel: /shipped
Sign Up: /signup
Startups: /startups
Static Ips 1 endpoint: /docs/rest-api/networking/configures-static-ips-for-a-project
Status: https://vercel-status.com
Storage 3 endpoint s: /docs/rest-api/storage/get-a-store
Storage: /docs/storage
Streamdown: https://streamdown.ai
SvelteKit: /docs/frameworks/full-stack/sveltekit
Tanstack Start: /docs/frameworks/full-stack/tanstack-start
Teams 16 endpoint s: /docs/rest-api/teams/list-team-members
Templates: /templates
Terms of Service: /legal/terms
Toolbar: /docs/vercel-toolbar
Trust Center: https://security.vercel.com
Turborepo: /solutions/turborepo
User 4 endpoint s: /docs/rest-api/user/list-user-events
VCR 27 endpoint s: /docs/rest-api/vcr/list-repositories
Vercel + AWS: /partners/aws
Vercel Agent: /agent
Vercel Agent: /docs/agent
Vercel Drop New: /drop
Vercel MCP: /docs/mcp
Vercel Plugin New: /plugin
Vercel REST API: /docs
Vercel SDK: /docs/rest-api/sdk
WAF: /security/web-application-firewall
Web Analytics 4 endpoint s: /docs/rest-api/web-analytics/aggregates-page-views
Web Apps: /solutions/web-apps
Webhooks 4 endpoint s: /docs/rest-api/webhooks/get-a-list-of-webhooks
Workflow SDK New: /workflows
Workflow: /docs/workflows
Workflows: /workflows
X: https://x.com/vercel
YouTube: https://youtube.com/@VercelHQ
account settings: https://vercel.com/account/tokens
eve New: /eve
eve New: https://eve.dev/
limits documentation: /docs/limits#rate-limits
v0 ↗: https://v0.app
v0: https://v0.app
xmcp: /docs/frameworks/backend/xmcp

[structured-data]
{"@context":"https://schema.org","@type":"WebSite","name":"Vercel Documentation","publisher":{"@type":"Organization","logo":{"@type":"ImageObject","url":"https://lishhsx6kmthaacj.public.blob.vercel-storage.com/vercel-wordmark.svg"},"name":"Vercel Inc.","sameAs":["https://x.com/vercel","https://github.com/vercel/vercel","https://www.linkedin.com/company/vercel/","https://bsky.app/profile/vercel.com"],"url":"https://vercel.com/"},"url":"https://vercel.com/docs"}

[content]
Vercel REST API Reference
Skip to content
Copy Logo as SVG
Copy Wordmark as SVG
Brand Guidelines
Docs
Build
Build with AI
AI Gateway
AI SDK
Sandbox
Container Registry
Workflow
Vercel Agent
v0
↗
Vercel MCP
AI Integrations
Deploy & scale
Deployments
CLI
Functions
Delivery Network
Storage
Integrations
Microfrontends
Domains
Operate & protect
Firewall
Observability
Feature Flags
Toolbar
Bot Management
BotID
Deployment Protection
Compliance
Learn
Resources
Changelog
↗
Blog
↗
Community
↗
Knowledge Base
APIs & SDKs
Templates
Getting Started
Ask AI
Log In
Sign Up
Build
Build with AI
AI Gateway
AI SDK
Sandbox
Container Registry
Workflow
Vercel Agent
v0
↗
Vercel MCP
AI Integrations
Deploy & scale
Deployments
CLI
Functions
Delivery Network
Storage
Integrations
Microfrontends
Domains
Operate & protect
Firewall
Observability
Feature Flags
Toolbar
Bot Management
BotID
Deployment Protection
Compliance
Learn
Resources
Changelog
↗
Blog
↗
Community
↗
Knowledge Base
APIs & SDKs
Templates
Getting Started
Ask AI
Sign Up
Log In
Vercel REST API
Overview
Errors
Access Groups
Ai Gateway
Aliases
Artifacts
Authentication
Billing
Bulk Redirects
Certs
Checks V2
Connect
Deployments
DNS
Domains
Domains Registrar
Drains
Edge Cache
Environment
Feature Flags
Global Config
Integrations
Logs
Marketplace
Microfrontends
Networking
Observability
Project Routes
Projectmembers
Projects
Rolling Release
Sandboxes
Security
Static Ips
Storage
Teams
User
VCR
Web Analytics
Webhooks
APIs & SDKs
Vercel REST API
Using the REST API
Interact programmatically with your Vercel account using the SDK or direct HTTP requests. You can deploy new versions of web applications, manage custom domains, retrieve information about deployments, and manage secrets and environment variables for projects.
The API supports any programming language or framework that can send HTTP requests.
API basics
The API is exposed as an HTTP/1 and HTTP/2 service over SSL. All endpoints live under the URL
https://api.vercel.com
and follow the REST architecture.
Authentication
Vercel Access Tokens are required to authenticate and use the Vercel API. Include the token in the
Authorization
header:
Authorization: Bearer <TOKEN>
Create and manage Access Tokens in your
account settings
.
Accessing team resources
By default, you can access resources in your personal account. To access resources owned by a team, append the Team ID as a query string:
https://api.vercel.com/v6/deployments?teamId=[teamID]
Rate limits
The API limits the number of calls you can make over a period of time. Rate limits are specified via response headers:
X-RateLimit-Limit
,
X-RateLimit-Remaining
, and
X-RateLimit-Reset
. See the
limits documentation
for details.
Endpoints
Browse all available REST API endpoints grouped by category.
Access Groups
11
endpoint
s
Ai Gateway
4
endpoint
s
Aliases
6
endpoint
s
Artifacts
7
endpoint
s
Authentication
5
endpoint
s
Billing
3
endpoint
s
Bulk Redirects
7
endpoint
s
Certs
5
endpoint
s
Checks V2
10
endpoint
s
Connect
5
endpoint
s
Deployments
10
endpoint
s
DNS
4
endpoint
s
Domains
9
endpoint
s
Domains Registrar
17
endpoint
s
Drains
6
endpoint
s
Edge Cache
4
endpoint
s
Environment
11
endpoint
s
Feature Flags
21
endpoint
s
Global Config
18
endpoint
s
Integrations
10
endpoint
s
Logs
1
endpoint
Marketplace
23
endpoint
s
Microfrontends
5
endpoint
s
Networking
6
endpoint
s
Observability
2
endpoint
s
Project Routes
8
endpoint
s
Projectmembers
3
endpoint
s
Projects
32
endpoint
s
Rolling Release
8
endpoint
s
Sandboxes
27
endpoint
s
Security
13
endpoint
s
Static Ips
1
endpoint
Storage
3
endpoint
s
Teams
16
endpoint
s
User
4
endpoint
s
VCR
27
endpoint
s
Web Analytics
4
endpoint
s
Webhooks
4
endpoint
s
On this page
API basics
Authentication
Accessing team resources
Rate limits
Endpoints
Agent Stack
AI SDK
AI Gateway
Sandbox
Workflows
Connect
New
Passport
New
eve
New
Core Platform
CI/CD
Content Delivery
Fluid Compute
Observability
Security
Platform Security
WAF
Bot Management
Bot ID
Tools
Vercel Drop
New
Vercel Agent
Vercel Plugin
New
Agent Skills
Next.js
Domains
v0
Frameworks
eve
New
Nuxt
SvelteKit
Nitro
Turborepo
Tanstack Start
FastAPI
xmcp
All frameworks
SDKs
Vercel SDK
Workflow SDK
New
Flags SDK
Chat SDK
New
Queues SDK
New
Streamdown
Build
AI Apps
Web Apps
Marketing Sites
Platforms
Commerce
Platform Engineers
Design Engineers
Learn
Docs
Blog
Changelog
Knowledge Base
Academy
Articles
Community
Explore
Customers
Marketplace
Templates
Partner Finder
Vercel + AWS
Company
About
Careers
Press
Events
Startups
Shipped on Vercel
Open Source Program
Enterprise
Pricing
Help
Legal & Trust
Privacy Policy
Terms of Service
Cookie Policy
DPA
Acceptable Use Policy
Legal (all documents)
Trust Center
Status
Cookie Preferences
Social
GitHub
X
LinkedIn
YouTube
Instagram
