{"slug":"vercel-api-platform","title":"Vercel API and CLI: Deployments, Projects, Domains, and Env Vars","tags":["vercel","deployment","api","cli","domains","env-vars"],"agent_summary":"Vercel REST API and CLI reference — deployments, projects, domains, DNS, environment variables, teams, webhooks, edge config, and CI/CD automation. 200+ endpoints across 30 categories.","trigger_phrases":["Vercel API","Vercel deploy","Vercel CLI","Vercel env vars","Vercel domains","Vercel project","Vercel deployment logs","vercel --prod"],"runnable":false,"markdown":"\n## Overview\n\nThe Vercel platform API (`https://api.vercel.com`) exposes 200+ endpoints for deployments, projects, domains, DNS, environment variables, teams, and more. The CLI wraps most operations for local use.\n\n## Authentication\n\n```bash\n# Personal Access Token\ncurl -H \"Authorization: Bearer $VERCEL_TOKEN\" https://api.vercel.com/v2/user\n\n# Team scope (append to all requests)\nhttps://api.vercel.com/v6/deployments?teamId=team_xxxxx\n\n# CLI team scope\nvercel --scope my-team deploy --prod\n```\n\nToken types: Personal Access Token (vercel.com/account/tokens), OAuth (integrations), Scoped (limited-permission automation).\n\n## CLI Installation and Core Commands\n\n```bash\nnpm i -g vercel\n\n# Deploy\nvercel deploy --prod\n\n# Link project\nvercel link\n\n# Environment variables\nvercel env pull .env.local # Pull to local file\nvercel env add KEY production # Add to production\nvercel env ls # List all\n\n# Logs\nvercel logs \nvercel logs --follow # Stream live\n\n# Domains\nvercel domains add example.com\nvercel domains ls\n\n# Rollback\nvercel rollback \n\n# Project info\nvercel inspect \n```\n\n## REST API Endpoint Categories\n\n| Category | Key Operations |\n|----------|----------------|\n| **Projects** (27 endpoints) | CRUD, domains, env vars, members, settings |\n| **Deployments** (10) | Create, get, list, cancel, delete |\n| **Domains** (6) | Add, remove, verify, transfer |\n| **DNS** (4) | List, add, update, remove records |\n| **Environment** (11) | Create, update, delete, list per target |\n| **Aliases** (6) | Set, remove, list custom domain aliases |\n| **Teams** (14) | Create, invite, manage members |\n| **Logs** (1) | Runtime log retrieval (streaming) |\n| **Webhooks** (4) | Create, list, get, delete |\n| **Edge-Config** (17) | Create, read, update, delete |\n| **Checks** (10) | Deployment checks for CI integration |\n\n## Common API Patterns\n\n### List Deployments\n\n```bash\ncurl -H \"Authorization: Bearer $VERCEL_TOKEN\" \\\n \"https://api.vercel.com/v6/deployments?projectId=prj_xxx&limit=5\"\n```\n\n### Create Deployment via API\n\n```bash\ncurl -X POST \\\n -H \"Authorization: Bearer $VERCEL_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"name\":\"my-app\",\"gitSource\":{\"type\":\"github\",\"repoId\":\"123\",\"ref\":\"main\"}}' \\\n \"https://api.vercel.com/v13/deployments\"\n```\n\n### Set Environment Variable\n\n```bash\ncurl -X POST \\\n -H \"Authorization: Bearer $VERCEL_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"key\":\"DATABASE_URL\",\"value\":\"postgres://...\",\"target\":[\"production\"],\"type\":\"encrypted\"}' \\\n \"https://api.vercel.com/v10/projects/prj_xxx/env\"\n```\n\n### Add DNS Record\n\n```bash\ncurl -X POST \\\n -H \"Authorization: Bearer $VERCEL_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"name\":\"api\",\"type\":\"CNAME\",\"value\":\"target.example.com\"}' \\\n \"https://api.vercel.com/v2/domains/example.com/records\"\n```\n\n## Environment Variable Targets\n\n| Target | When Used |\n|--------|-----------|\n| `production` | `vercel deploy --prod` |\n| `preview` | Branch and PR deployments |\n| `development` | `vercel dev` local server |\n\nAlways set sensitive keys in Vercel dashboard, not in `.env` files committed to git.\n\n## Deploy from GitHub Actions\n\n```yaml\n- name: Deploy to Vercel\n env:\n VERCEL_TOKEN: ${{ secrets.VERCEL_TOKEN }}\n VERCEL_ORG_ID: ${{ secrets.VERCEL_ORG_ID }}\n VERCEL_PROJECT_ID: ${{ secrets.VERCEL_PROJECT_ID }}\n run: |\n npm i -g vercel\n vercel pull --yes --environment=production --token=$VERCEL_TOKEN\n vercel build --prod --token=$VERCEL_TOKEN\n vercel deploy --prebuilt --prod --token=$VERCEL_TOKEN\n```\n\n## Edge Config\n\nEdge Config is a global key-value store with sub-millisecond reads at the edge. Use for feature flags and A/B config.\n\n```bash\n# Create via API\ncurl -X POST -H \"Authorization: Bearer $VERCEL_TOKEN\" \\\n -d '{\"slug\":\"my-flags\"}' \\\n \"https://api.vercel.com/v1/edge-config\"\n\n# Read in code (Next.js)\nimport { get } from \"@vercel/edge-config\";\nconst isEnabled = await get(\"feature-x\");\n```\n\n## Webhooks\n\n```bash\ncurl -X POST -H \"Authorization: Bearer $VERCEL_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"url\":\"https://api.example.com/webhook\",\"events\":[\"deployment.created\",\"deployment.ready\"]}' \\\n \"https://api.vercel.com/v1/webhooks\"\n```\n\nEvents: `deployment.created`, `deployment.ready`, `deployment.error`, `deployment.canceled`.\n\n## Project Settings via API\n\n```bash\n# Get project\ncurl -H \"Authorization: Bearer $VERCEL_TOKEN\" \\\n \"https://api.vercel.com/v9/projects/prj_xxx\"\n\n# Update build command\ncurl -X PATCH -H \"Authorization: Bearer $VERCEL_TOKEN\" \\\n -d '{\"buildCommand\":\"npm run build:prod\"}' \\\n \"https://api.vercel.com/v9/projects/prj_xxx\"\n```\n","html":"

Overview

\n

The Vercel platform API (https://api.vercel.com) exposes 200+ endpoints for deployments, projects, domains, DNS, environment variables, teams, and more. The CLI wraps most operations for local use.

\n

Authentication

\n
# Personal Access Token\ncurl -H \"Authorization: Bearer $VERCEL_TOKEN\" https://api.vercel.com/v2/user\n\n# Team scope (append to all requests)\nhttps://api.vercel.com/v6/deployments?teamId=team_xxxxx\n\n# CLI team scope\nvercel --scope my-team deploy --prod\n
\n

Token types: Personal Access Token (vercel.com/account/tokens), OAuth (integrations), Scoped (limited-permission automation).

\n

CLI Installation and Core Commands

\n
npm i -g vercel\n\n# Deploy\nvercel deploy --prod\n\n# Link project\nvercel link\n\n# Environment variables\nvercel env pull .env.local        # Pull to local file\nvercel env add KEY production     # Add to production\nvercel env ls                     # List all\n\n# Logs\nvercel logs <deployment-url>\nvercel logs --follow              # Stream live\n\n# Domains\nvercel domains add example.com\nvercel domains ls\n\n# Rollback\nvercel rollback <deployment-url>\n\n# Project info\nvercel inspect <deployment-url>\n
\n

REST API Endpoint Categories

\n

| Category | Key Operations |\n|----------|----------------|\n| Projects (27 endpoints) | CRUD, domains, env vars, members, settings |\n| Deployments (10) | Create, get, list, cancel, delete |\n| Domains (6) | Add, remove, verify, transfer |\n| DNS (4) | List, add, update, remove records |\n| Environment (11) | Create, update, delete, list per target |\n| Aliases (6) | Set, remove, list custom domain aliases |\n| Teams (14) | Create, invite, manage members |\n| Logs (1) | Runtime log retrieval (streaming) |\n| Webhooks (4) | Create, list, get, delete |\n| Edge-Config (17) | Create, read, update, delete |\n| Checks (10) | Deployment checks for CI integration |

\n

Common API Patterns

\n

List Deployments

\n
curl -H \"Authorization: Bearer $VERCEL_TOKEN\" \\\n  \"https://api.vercel.com/v6/deployments?projectId=prj_xxx&limit=5\"\n
\n

Create Deployment via API

\n
curl -X POST \\\n  -H \"Authorization: Bearer $VERCEL_TOKEN\" \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\"name\":\"my-app\",\"gitSource\":{\"type\":\"github\",\"repoId\":\"123\",\"ref\":\"main\"}}' \\\n  \"https://api.vercel.com/v13/deployments\"\n
\n

Set Environment Variable

\n
curl -X POST \\\n  -H \"Authorization: Bearer $VERCEL_TOKEN\" \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\"key\":\"DATABASE_URL\",\"value\":\"postgres://...\",\"target\":[\"production\"],\"type\":\"encrypted\"}' \\\n  \"https://api.vercel.com/v10/projects/prj_xxx/env\"\n
\n

Add DNS Record

\n
curl -X POST \\\n  -H \"Authorization: Bearer $VERCEL_TOKEN\" \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\"name\":\"api\",\"type\":\"CNAME\",\"value\":\"target.example.com\"}' \\\n  \"https://api.vercel.com/v2/domains/example.com/records\"\n
\n

Environment Variable Targets

\n

| Target | When Used |\n|--------|-----------|\n| production | vercel deploy --prod |\n| preview | Branch and PR deployments |\n| development | vercel dev local server |

\n

Always set sensitive keys in Vercel dashboard, not in .env files committed to git.

\n

Deploy from GitHub Actions

\n
- name: Deploy to Vercel\n  env:\n    VERCEL_TOKEN: ${{ secrets.VERCEL_TOKEN }}\n    VERCEL_ORG_ID: ${{ secrets.VERCEL_ORG_ID }}\n    VERCEL_PROJECT_ID: ${{ secrets.VERCEL_PROJECT_ID }}\n  run: |\n    npm i -g vercel\n    vercel pull --yes --environment=production --token=$VERCEL_TOKEN\n    vercel build --prod --token=$VERCEL_TOKEN\n    vercel deploy --prebuilt --prod --token=$VERCEL_TOKEN\n
\n

Edge Config

\n

Edge Config is a global key-value store with sub-millisecond reads at the edge. Use for feature flags and A/B config.

\n
# Create via API\ncurl -X POST -H \"Authorization: Bearer $VERCEL_TOKEN\" \\\n  -d '{\"slug\":\"my-flags\"}' \\\n  \"https://api.vercel.com/v1/edge-config\"\n\n# Read in code (Next.js)\nimport { get } from \"@vercel/edge-config\";\nconst isEnabled = await get(\"feature-x\");\n
\n

Webhooks

\n
curl -X POST -H \"Authorization: Bearer $VERCEL_TOKEN\" \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\"url\":\"https://api.example.com/webhook\",\"events\":[\"deployment.created\",\"deployment.ready\"]}' \\\n  \"https://api.vercel.com/v1/webhooks\"\n
\n

Events: deployment.created, deployment.ready, deployment.error, deployment.canceled.

\n

Project Settings via API

\n
# Get project\ncurl -H \"Authorization: Bearer $VERCEL_TOKEN\" \\\n  \"https://api.vercel.com/v9/projects/prj_xxx\"\n\n# Update build command\ncurl -X PATCH -H \"Authorization: Bearer $VERCEL_TOKEN\" \\\n  -d '{\"buildCommand\":\"npm run build:prod\"}' \\\n  \"https://api.vercel.com/v9/projects/prj_xxx\"\n
\n"}