[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-1d86a48b3c401f86411227193c0a9c82-bdad650c2ca5b333-01
robots: index, follow
theme-color: #000000
theme-color: #fafafa
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 Agents on Vercel: https://vercel.com/kb/guide/ai-agents?from=graph
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
API Ai Gateway 5 endpoint s: /docs/rest-api/api-ai-gateway/get-virtual-model-config
API Keys: https://vercel.com/docs/ai-gateway/authentication-and-byok/api-keys?from=graph
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
Access tokens: https://vercel.com/docs/accounts/access-tokens?from=graph
Account Management: https://vercel.com/docs/accounts?from=graph
Add an existing domain to the Vercel platform: https://vercel.com/docs/rest-api/domains/add-an-existing-domain-to-the-vercel-platform?from=graph
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
Assign an Alias: https://vercel.com/docs/rest-api/aliases/assign-an-alias?from=graph
Authentication 5 endpoint s: /docs/rest-api/authentication/sso-token-exchange
Authentication: https://vercel.com/docs/connect/concepts/authentication?from=graph
Authentication: https://vercel.com/docs/kms/concepts/authentication?from=graph
Azure DevOps: https://vercel.com/docs/git/vercel-for-azure-pipelines?from=graph
Billing 3 endpoint s: /docs/rest-api/billing/list-focus-billing-charges
Blog ↗: https://vercel.com/blog
Blog: /blog
Bot Management: /docs/bot-management
Bot Management: /security/bot-management
BotID: /botid
BotID: /docs/botid
Build Output Configuration: https://vercel.com/docs/build-output-api/configuration?from=graph
Build System: https://vercel.com/docs/fundamentals/builds?from=graph
Build a multi-tenant app with Next.js and Vercel: https://vercel.com/kb/guide/nextjs-multi-tenant-application?from=graph
Building Integrations with Vercel REST API: https://vercel.com/docs/integrations/create-integration/vercel-api-integrations?from=graph
Bulk Redirects 7 endpoint s: /docs/rest-api/bulk-redirects/gets-project-level-redirects
Buy a domain: https://vercel.com/docs/rest-api/domains-registrar/buy-a-domain?from=graph
Buy multiple domains: https://vercel.com/docs/rest-api/domains-registrar/buy-multiple-domains?from=graph
CI/CD: /products/previews
CLI: /docs/cli
CLI: https://vercel.com/docs/cli?from=graph
Cancel a deployment: https://vercel.com/docs/rest-api/deployments/cancel-a-deployment?from=graph
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
Check if a cache artifact exists: https://vercel.com/docs/rest-api/artifacts/check-if-a-cache-artifact-exists?from=graph
Checks Reference: https://vercel.com/docs/checks/creating-checks?from=graph
Checks V2 10 endpoint s: /docs/rest-api/checks-v2/list-all-checks-for-a-project
Claim Domain Ownership: https://vercel.com/docs/rest-api/domains/claim-domain-ownership?from=graph
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
Connect: https://vercel.com/docs/connect?from=graph
Container Registry: /docs/container-registry
Content Delivery: /cdn
Cookie Policy: /legal/cookie-policy
Create a Connect authorization request: https://vercel.com/docs/rest-api/connect/create-a-connect-authorization-request?from=graph
Create a Connect installation request: https://vercel.com/docs/rest-api/connect/create-a-connect-installation-request?from=graph
Create a DNS record: https://vercel.com/docs/rest-api/dns/create-a-dns-record?from=graph
Create a check run: https://vercel.com/docs/rest-api/checks-v2/create-a-check-run?from=graph
Create a check: https://vercel.com/docs/rest-api/checks-v2/create-a-check?from=graph
Create a connector: https://vercel.com/docs/rest-api/connect/create-a-connector?from=graph
Create a new deployment: https://vercel.com/docs/rest-api/deployments/create-a-new-deployment?from=graph
Create an Auth Token: https://vercel.com/docs/rest-api/authentication/create-an-auth-token?from=graph
Create an access group project: https://vercel.com/docs/rest-api/access-groups/create-an-access-group-project?from=graph
Create rule: https://vercel.com/docs/rest-api/ai-gateway/create-rule?from=graph
Create virtual model config: https://vercel.com/docs/rest-api/api-ai-gateway/create-virtual-model-config?from=graph
Creates an access group: https://vercel.com/docs/rest-api/access-groups/creates-an-access-group?from=graph
Customers: /customers
DNS 4 endpoint s: /docs/rest-api/dns/list-existing-dns-records
DPA: /legal/dpa
Delete a DNS record: https://vercel.com/docs/rest-api/dns/delete-a-dns-record?from=graph
Delete a Deployment: https://vercel.com/docs/rest-api/deployments/delete-a-deployment?from=graph
Delete a check: https://vercel.com/docs/rest-api/checks-v2/delete-a-check?from=graph
Delete all cache artifacts: https://vercel.com/docs/rest-api/artifacts/delete-all-cache-artifacts?from=graph
Delete an Alias: https://vercel.com/docs/rest-api/aliases/delete-an-alias?from=graph
Delete an access group project: https://vercel.com/docs/rest-api/access-groups/delete-an-access-group-project?from=graph
Delete an authentication token: https://vercel.com/docs/rest-api/authentication/delete-an-authentication-token?from=graph
Delete project-level redirects.: https://vercel.com/docs/rest-api/bulk-redirects/delete-project-level-redirects?from=graph
Delete rule: https://vercel.com/docs/rest-api/ai-gateway/delete-rule?from=graph
Delete virtual model config: https://vercel.com/docs/rest-api/api-ai-gateway/delete-virtual-model-config?from=graph
Deletes an access group: https://vercel.com/docs/rest-api/access-groups/deletes-an-access-group?from=graph
Delivery Network: /docs/cdn
Deployment Policies: https://vercel.com/docs/deployments/deployment-policy?from=graph
Deployment Protection: /docs/deployment-protection
Deployment integration actions: https://vercel.com/docs/integrations/create-integration/deployment-integration-action?from=graph
Deployments 10 endpoint s: /docs/rest-api/deployments/get-deployment-events
Deployments: /docs/deployments
Deployments: https://vercel.com/docs/deployments?from=graph
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
Download a cache artifact: https://vercel.com/docs/rest-api/artifacts/download-a-cache-artifact?from=graph
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
Edit a project-level redirect.: https://vercel.com/docs/rest-api/bulk-redirects/edit-a-project-level-redirect?from=graph
Enterprise: /enterprise
Environment 11 endpoint s: /docs/rest-api/environment/lists-all-shared-environment-variables-for-a-team
Environments: https://vercel.com/docs/deployments/environments?from=graph
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 Terraform Configuration: https://vercel.com/kb/guide/firewall-terraform-configuration?from=graph
Firewall: /docs/vercel-firewall
Flags SDK: /docs/flags/flags-sdk-reference
Fluid Compute: /fluid
Functions: /docs/functions
Get Auth Token Metadata: https://vercel.com/docs/rest-api/authentication/get-auth-token-metadata?from=graph
Get Deployment File Contents: https://vercel.com/docs/rest-api/deployments/get-deployment-file-contents?from=graph
Get Global Configs: https://vercel.com/docs/rest-api/global-config/get-global-configs?from=graph
Get TLD price data: https://vercel.com/docs/rest-api/domains-registrar/get-tld-price-data?from=graph
Get TLD: https://vercel.com/docs/rest-api/domains-registrar/get-tld?from=graph
Get a Connect token: https://vercel.com/docs/rest-api/connect/get-a-connect-token?from=graph
Get a Global Config: https://vercel.com/docs/rest-api/global-config/get-a-global-config?from=graph
Get a check run: https://vercel.com/docs/rest-api/checks-v2/get-a-check-run?from=graph
Get a check: https://vercel.com/docs/rest-api/checks-v2/get-a-check?from=graph
Get a deployment by ID or URL: https://vercel.com/docs/rest-api/deployments/get-a-deployment-by-id-or-url?from=graph
Get a domain order: https://vercel.com/docs/rest-api/domains-registrar/get-a-domain-order?from=graph
Get a domain's transfer status: https://vercel.com/docs/rest-api/domains-registrar/get-a-domain-s-transfer-status?from=graph
Get an Alias: https://vercel.com/docs/rest-api/aliases/get-an-alias?from=graph
Get availability for a domain: https://vercel.com/docs/rest-api/domains-registrar/get-availability-for-a-domain?from=graph
Get availability for multiple domains: https://vercel.com/docs/rest-api/domains-registrar/get-availability-for-multiple-domains?from=graph
Get cert by id: https://vercel.com/docs/rest-api/certs/get-cert-by-id?from=graph
Get certs: https://vercel.com/docs/rest-api/certs/get-certs?from=graph
Get contact info schema: https://vercel.com/docs/rest-api/domains-registrar/get-contact-info-schema?from=graph
Get contact verification status for a domain: https://vercel.com/docs/rest-api/domains-registrar/get-contact-verification-status-for-a-domain?from=graph
Get deployment events: https://vercel.com/docs/rest-api/deployments/get-deployment-events?from=graph
Get price data for a domain: https://vercel.com/docs/rest-api/domains-registrar/get-price-data-for-a-domain?from=graph
Get status of Remote Caching for this principal: https://vercel.com/docs/rest-api/artifacts/get-status-of-remote-caching-for-this-principal?from=graph
Get the auth code for a domain: https://vercel.com/docs/rest-api/domains-registrar/get-the-auth-code-for-a-domain?from=graph
Get the version history for a project's redirects.: https://vercel.com/docs/rest-api/bulk-redirects/get-the-version-history-for-a-project-s-redirects?from=graph
Get virtual model config: https://vercel.com/docs/rest-api/api-ai-gateway/get-virtual-model-config?from=graph
Gets project-level redirects.: https://vercel.com/docs/rest-api/bulk-redirects/gets-project-level-redirects?from=graph
Getting Started: /docs/getting-started-with-vercel
GitHub: https://github.com/vercel
Give your agents secure access to third-party APIs: https://vercel.com/kb/guide/vercel-connect?from=graph
Global Config 18 endpoint s: /docs/rest-api/global-config/get-global-configs
Global Config SDK: https://vercel.com/docs/global-config/global-config-sdk?from=graph
Global Config: https://vercel.com/docs/global-config?from=graph
Global Configs & REST API: https://vercel.com/docs/global-config/vercel-api?from=graph
Glossary: https://vercel.com/docs/glossary?from=graph
Help: /help
How do I add a domain using the Vercel API?: https://vercel.com/kb/guide/how-do-i-add-a-domain-using-the-vercel-api?from=graph
How do I use a Vercel API Access Token?: https://vercel.com/kb/guide/how-do-i-use-a-vercel-api-access-token?from=graph
How to Utilize Vercel’s Bot Management Features: https://vercel.com/kb/guide/how-to-utilize-vercels-bot-management-features?from=graph
How to build a honeypot with Vercel Web Application Firewall: https://vercel.com/kb/guide/how-to-build-a-honeypot-with-vercel-web-application-firewall?from=graph
How to move a domain between Vercel projects with "Zero Downtime"?: https://vercel.com/kb/guide/how-to-move-a-domain-between-vercel-projects-with-zero-downtime?from=graph
Import Connect tokens: https://vercel.com/docs/rest-api/connect/import-connect-tokens?from=graph
Instagram: https://www.instagram.com/vercel/
Integrations 10 endpoint s: /docs/rest-api/deployments/update-deployment-integration-action
Integrations: /docs/integrations
Issue a new cert: https://vercel.com/docs/rest-api/certs/issue-a-new-cert?from=graph
Kms 13 endpoint s: /docs/rest-api/kms/list-issuers
Knowledge Base: /kb
Legal (all documents): /legal
Limits: https://vercel.com/docs/limits?from=graph
Limits: https://vercel.com/docs/platforms/multi-tenant-platforms/limits?from=graph
LinkedIn: https://linkedin.com/company/vercel
List Auth Tokens: https://vercel.com/docs/rest-api/authentication/list-auth-tokens?from=graph
List Deployment Aliases: https://vercel.com/docs/rest-api/aliases/list-deployment-aliases?from=graph
List Deployment Files: https://vercel.com/docs/rest-api/deployments/list-deployment-files?from=graph
List FOCUS billing charges: https://vercel.com/docs/rest-api/billing/list-focus-billing-charges?from=graph
List FOCUS contract commitments: https://vercel.com/docs/rest-api/billing/list-focus-contract-commitments?from=graph
List access groups for a team, project or member: https://vercel.com/docs/rest-api/access-groups/list-access-groups-for-a-team-project-or-member?from=graph
List aliases: https://vercel.com/docs/rest-api/aliases/list-aliases?from=graph
List all checks for a project: https://vercel.com/docs/rest-api/checks-v2/list-all-checks-for-a-project?from=graph
List check runs for a deployment: https://vercel.com/docs/rest-api/checks-v2/list-check-runs-for-a-deployment?from=graph
List deployments: https://vercel.com/docs/rest-api/deployments/list-deployments?from=graph
List existing DNS records: https://vercel.com/docs/rest-api/dns/list-existing-dns-records?from=graph
List members of an access group: https://vercel.com/docs/rest-api/access-groups/list-members-of-an-access-group?from=graph
List projects of an access group: https://vercel.com/docs/rest-api/access-groups/list-projects-of-an-access-group?from=graph
List rules: https://vercel.com/docs/rest-api/ai-gateway/list-rules?from=graph
List runs for a check: https://vercel.com/docs/rest-api/checks-v2/list-runs-for-a-check?from=graph
List virtual model configs: https://vercel.com/docs/rest-api/api-ai-gateway/list-virtual-model-configs?from=graph
Log In: /login
Logs 1 endpoint: /docs/rest-api/logs/get-logs-for-a-deployment
Managing Builds: https://vercel.com/docs/builds/managing-builds?from=graph
Managing Deployments: https://vercel.com/docs/deployments/managing-deployments?from=graph
Managing Redirects from your CMS using Vercel Bulk Redirects: https://vercel.com/kb/guide/managing-redirects-from-your-cms-using-vercel-bulk-redirects?from=graph
Managing projects: https://vercel.com/docs/projects/managing-projects?from=graph
Marketing Sites: /solutions/marketing-sites
Marketplace 24 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
Promote a staging version to production or restore a previous production version.: https://vercel.com/docs/rest-api/bulk-redirects/promote-a-staging-version-to-production-or-restore-a-previous-production-version?from=graph
Purchase credits: https://vercel.com/docs/rest-api/billing/purchase-credits?from=graph
Query information about an artifact: https://vercel.com/docs/rest-api/artifacts/query-information-about-an-artifact?from=graph
Queues SDK New: /docs/queues/sdk
Reads an access group project: https://vercel.com/docs/rest-api/access-groups/reads-an-access-group-project?from=graph
Reads an access group: https://vercel.com/docs/rest-api/access-groups/reads-an-access-group?from=graph
Record an artifacts cache usage event: https://vercel.com/docs/rest-api/artifacts/record-an-artifacts-cache-usage-event?from=graph
Reference: https://vercel.com/docs/platforms/multi-project-platforms/reference?from=graph
Remove cert: https://vercel.com/docs/rest-api/certs/remove-cert?from=graph
Removing a Domain: https://vercel.com/docs/domains/working-with-domains/remove-a-domain?from=graph
Renew a domain: https://vercel.com/docs/rest-api/domains-registrar/renew-a-domain?from=graph
Restore staged project-level redirects to their production version.: https://vercel.com/docs/rest-api/bulk-redirects/restore-staged-project-level-redirects-to-their-production-version?from=graph
Rolling Release 8 endpoint s: /docs/rest-api/rolling-release/get-rolling-release-billing-status
SSO Token Exchange: https://vercel.com/docs/rest-api/authentication/sso-token-exchange?from=graph
Sandbox: /docs/sandbox
Sandbox: /sandbox
Sandboxes 30 endpoint s: /docs/rest-api/sandboxes/list-sandboxes
Security 13 endpoint s: /docs/rest-api/security/update-attack-challenge-mode
Sensitive Environment Variables: https://vercel.com/docs/environment-variables/sensitive-environment-variables?from=graph
Shipped on Vercel: /shipped
Sign Up: /signup
Stages new redirects for a project.: https://vercel.com/docs/rest-api/bulk-redirects/stages-new-redirects-for-a-project?from=graph
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
Transfer-in a domain: https://vercel.com/docs/rest-api/domains-registrar/transfer-in-a-domain?from=graph
Trust Center: https://security.vercel.com
Turborepo: /solutions/turborepo
Update a check run: https://vercel.com/docs/rest-api/checks-v2/update-a-check-run?from=graph
Update a check: https://vercel.com/docs/rest-api/checks-v2/update-a-check?from=graph
Update an access group project: https://vercel.com/docs/rest-api/access-groups/update-an-access-group-project?from=graph
Update an access group: https://vercel.com/docs/rest-api/access-groups/update-an-access-group?from=graph
Update an existing DNS record: https://vercel.com/docs/rest-api/dns/update-an-existing-dns-record?from=graph
Update auto-renew for a domain: https://vercel.com/docs/rest-api/domains-registrar/update-auto-renew-for-a-domain?from=graph
Update deployment integration action: https://vercel.com/docs/rest-api/deployments/update-deployment-integration-action?from=graph
Update nameservers for a domain: https://vercel.com/docs/rest-api/domains-registrar/update-nameservers-for-a-domain?from=graph
Update rule: https://vercel.com/docs/rest-api/ai-gateway/update-rule?from=graph
Update the protection bypass for a URL: https://vercel.com/docs/rest-api/aliases/update-the-protection-bypass-for-a-url?from=graph
Update virtual model config: https://vercel.com/docs/rest-api/api-ai-gateway/update-virtual-model-config?from=graph
Upload Deployment Files: https://vercel.com/docs/rest-api/deployments/upload-deployment-files?from=graph
Upload a cache artifact: https://vercel.com/docs/rest-api/artifacts/upload-a-cache-artifact?from=graph
Upload a cert: https://vercel.com/docs/rest-api/certs/upload-a-cert?from=graph
User 4 endpoint s: /docs/rest-api/user/list-user-events
Using Domains API: https://vercel.com/docs/domains/registrar-api?from=graph
Using Global Config: https://vercel.com/docs/global-config/using-global-config?from=graph
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 Drop vs Netlify Drop: https://vercel.com/kb/guide/vercel-drop-vs-netlify-drop?from=graph
Vercel Drop: https://vercel.com/docs/drop?from=graph
Vercel MCP: /docs/mcp
Vercel Plugin New: /plugin
Vercel Primitives: https://vercel.com/docs/build-output-api/primitives?from=graph
Vercel REST API: /docs
Vercel SDK: /docs/rest-api/sdk
Vercel SDK: https://vercel.com/docs/rest-api/sdk?from=graph
WAF: /security/web-application-firewall
Web Analytics 4 endpoint s: /docs/rest-api/web-analytics/aggregates-page-views
Web Analytics API: https://vercel.com/docs/analytics/web-analytics-api?from=graph
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/
https://vercel.com/docs/graph.json: https://vercel.com/docs/graph.json
limits documentation: /docs/limits#rate-limits
v0 ↗: https://v0.app
v0: https://v0.app
vercel alias: https://vercel.com/docs/cli/alias?from=graph
vercel api: https://vercel.com/docs/cli/api?from=graph
vercel global-config: https://vercel.com/docs/cli/global-config?from=graph
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 Wordmark
Copy Logo
Download Brand Assets
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
API Ai Gateway
Artifacts
Authentication
Billing
Bulk Redirects
Certs
Checks V2
Connect
Deployments
DNS
Domains
Domains Registrar
Drains
Edge Cache
Environment
Feature Flags
Global Config
Integrations
Kms
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
API Ai Gateway
5
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
Kms
13
endpoint
s
Logs
1
endpoint
Marketplace
24
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
30
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
Related Vercel documentation
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
BotID
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
Cross-link map: Rest API (/docs/rest-api)
From the Vercel docs graph (built 2026-08-20T05:54:11.139Z), spanning vercel.com docs + KB, nextjs.org, ai-sdk.dev, and other Vercel documentation sites. Full graph as JSON:
https://vercel.com/docs/graph.json
Semantically closest pages
Vercel SDK
— Learn about vercel sdk on Vercel.
vercel global-config
— Manage Global Config stores from the Vercel CLI: list, create, inspect, update, remove, and manage items, read tokens, a
Global Configs & REST API
— Learn how to use the Vercel REST API to create and update Global Configs. You can also read data stored in Global Config
Get Global Configs
Get a Global Config
This page links to (369)
Create an access group project
Creates an access group
Delete an access group project
Deletes an access group
List access groups for a team, project or member
List members of an access group
List projects of an access group
Reads an access group
Reads an access group project
Update an access group
Update an access group project
Create rule
Delete rule
List rules
Update rule
Assign an Alias
Delete an Alias
Get an Alias
List aliases
List Deployment Aliases
Update the protection bypass for a URL
Create virtual model config
Delete virtual model config
Get virtual model config
List virtual model configs
Update virtual model config
Check if a cache artifact exists
Delete all cache artifacts
Download a cache artifact
Get status of Remote Caching for this principal
Query information about an artifact
Record an artifacts cache usage event
Upload a cache artifact
Create an Auth Token
Delete an authentication token
Get Auth Token Metadata
List Auth Tokens
SSO Token Exchange
List FOCUS billing charges
List FOCUS contract commitments
Purchase credits
Delete project-level redirects.
Edit a project-level redirect.
Get the version history for a project's redirects.
Gets project-level redirects.
Promote a staging version to production or restore a previous production version.
Restore staged project-level redirects to their production version.
Stages new redirects for a project.
Get cert by id
Get certs
Issue a new cert
Remove cert
Upload a cert
Create a check
Create a check run
Delete a check
Get a check
Get a check run
List all checks for a project
List check runs for a deployment
List runs for a check
Update a check
Update a check run
Create a Connect authorization request
Create a Connect installation request
Create a connector
Get a Connect token
Import Connect tokens
Cancel a deployment
Create a new deployment
Delete a Deployment
Get a deployment by ID or URL
Get deployment events
Get Deployment File Contents
List Deployment Files
List deployments
Update deployment integration action
Upload Deployment Files
Create a DNS record
Delete a DNS record
List existing DNS records
Update an existing DNS record
Buy a domain
Buy multiple domains
Get a domain order
Get a domain's transfer status
Get availability for a domain
Get availability for multiple domains
Get contact info schema
Get contact verification status for a domain
Get price data for a domain
Get the auth code for a domain
Get TLD
Get TLD price data
Renew a domain
Transfer-in a domain
Update auto-renew for a domain
Update nameservers for a domain
Add an existing domain to the Vercel platform
Claim Domain Ownership
…and 269 more — full list in
https://vercel.com/docs/graph.json
Pages that link here (426)
By site: vercel-kb (11) · vercel-docs (415)
From vercel-kb
AI Agents on Vercel
— This guide provides an overview of how to build and deploy AI agents on Vercel.
Firewall Terraform Configuration
— Learn how to create scalable firewall configurations with Terraform
How do I add a domain using the Vercel API?
— Information on adding a domain using the Vercel API.
How do I use a Vercel API Access Token?
— An Access Token is required in order to use the Vercel API. Tokens can be created and managed at the level of your accou
How to build a honeypot with Vercel Web Application Firewall
— Learn how to build a honeypot with Vercel Web Application Firewall \(WAF\) that catches bots ignoring your robots.txt. C
How to move a domain between Vercel projects with "Zero Downtime"?
— Information about how to move your domain between Vercel projects without downtime.
How to Utilize Vercel’s Bot Management Features
— A practical, step-by-step guide to identifying unwanted automated traffic and securing your Vercel apps with Bot Protect
Managing Redirects from your CMS using Vercel Bulk Redirects
— Learn how to sync redirect rules from your CMS to Vercel at build time with vercel.ts, allowing non-technical teams to m
Build a multi-tenant app with Next.js and Vercel
— Create a Next.js application with multi-tenancy and custom domain support on Vercel.
Give your agents secure access to third-party APIs
— Use Vercel Connect to call provider APIs like Slack, GitHub, Linear, Discord, Notion, Figma, Snowflake, and Salesforce f
Vercel Drop vs Netlify Drop
— Compare Vercel Drop and Netlify Drop for drag-and-drop deployment: framework builds, static sites, updates, size limits,
From vercel-docs
Account Management
— Learn how to manage your Vercel account and team members.
Access tokens
— Create and scope Vercel access tokens to your full account, a team, or a single project, then use them to authenticate A
API Keys
— Create, view, and delete AI Gateway API keys from the dashboard, CLI, or API.
Web Analytics API
— Learn how Web Analytics concepts map to API queries for custom reports, dashboards, and insights.
Build Output Configuration
— Learn about the Build Output Configuration file, which is used to configure the behavior of a Deployment.
Vercel Primitives
— Learn about the Vercel platform primitives and how they work together to create a Vercel Deployment.
Managing Builds
— Vercel allows you to increase the speed of your builds when needed in specific situations and workflows.
Checks Reference
— Learn how to create your own Checks with Vercel Integrations. You can build your own Integration in order to register an
CLI
— Learn how to use the Vercel command-line interface \(CLI\) to manage and configure your Vercel Projects from the command
vercel alias
— Learn how to apply custom domain aliases to your Vercel deployments using the vercel alias CLI command.
vercel api
— Learn how to make authenticated HTTP requests to the Vercel API using the vercel api CLI command.
Connect
— Use Vercel Connect to create connectors, authorize provider access, request provider tokens at runtime, and run agent wo
Authentication
— Every Vercel Connect token request has two legs that both have to authenticate: the caller calling Vercel Connect, and V
Deployments
— Learn how to create and manage deployments on Vercel.
Deployment Policies
— Use a deployment policy to control which Git sources and deployment mechanisms can deploy to your team and projects, per
Environments
— Environments are for developing locally, testing changes in a pre-production environment, and serving end-users in produ
Managing Deployments
— Learn how to manage your current and previously deployed projects to Vercel through the dashboard. You can redeploy at a
Using Domains API
— Programmatically search, price, purchase, renew, and manage domains with Vercel's domains registrar API endpoints.
Removing a Domain
— Learn how to remove a domain from a Project and from your account completely with this guide.
Vercel Drop
— Vercel Drop lets you deploy a file or folder by dragging it into your browser, with no Git or CLI required.
Sensitive Environment Variables
— Environment variables that cannot be decrypted once created.
Build System
— Learn how Vercel transforms your source code into optimized assets ready to serve globally.
Azure DevOps
— ​Vercel for Azure DevOps allows you to deploy from Azure Pipelines to Vercel automatically.
Global Config
— A Global Config is a global data store that enables experimentation with feature flags, A/B testing, critical redirects,
Global Config SDK
— The Global Config client SDK is the most ergonomic way to read data from Global Configs. Learn how to set up the SDK so
Using Global Config
— Learn how to use Global Configs in your projects.
Global Configs & REST API
— Learn how to use the Vercel REST API to create and update Global Configs. You can also read data stored in Global Config
Glossary
— Learn about the terms and concepts used in Vercel's products and documentation.
Deployment integration actions
— These actions allow integration providers to set up automated tasks with Vercel deployments.
Building Integrations with Vercel REST API
— Learn how to use Vercel REST API to build your integrations and work with redirect URLs.
Authentication
— How Vercel KMS authorizes signing requests with a deployment OIDC token, authorizes management requests with a Vercel ac
Limits
— Look up account limits, usage summaries, rate limits, and resource constraints for every Vercel plan.
Reference
— API reference, error codes, troubleshooting, and FAQ for multi-project platforms on Vercel.
Limits
— Understand the limits and features available for Vercel for Platforms.
Managing projects
— Learn how to manage your projects through the Vercel Dashboard.
Create an access group project
Creates an access group
Delete an access group project
Deletes an access group
List access groups for a team, project or member
List members of an access group
List projects of an access group
Reads an access group
Reads an access group project
Update an access group
Update an access group project
Create rule
Delete rule
List rules
Update rule
Assign an Alias
Delete an Alias
Get an Alias
List aliases
List Deployment Aliases
Update the protection bypass for a URL
Create virtual model config
Delete virtual model config
Get virtual model config
List virtual model configs
Update virtual model config
Check if a cache artifact exists
Delete all cache artifacts
Download a cache artifact
Get status of Remote Caching for this principal
Query information about an artifact
Record an artifacts cache usage event
Upload a cache artifact
Create an Auth Token
Delete an authentication token
Get Auth Token Metadata
List Auth Tokens
SSO Token Exchange
List FOCUS billing charges
List FOCUS contract commitments
Purchase credits
Delete project-level redirects.
Edit a project-level redirect.
Get the version history for a project's redirects.
Gets project-level redirects.
Promote a staging version to production or restore a previous production version.
Restore staged project-level redirects to their production version.
Stages new redirects for a project.
Get cert by id
Get certs
Issue a new cert
Remove cert
Upload a cert
Create a check
…and 326 more — full list in
https://vercel.com/docs/graph.json
