feat(cli): add api command by tknickman · Pull Request #14715 · vercel/vercel

tknickman · 2026-01-23T19:10:05Z

Introduces a new vercel api command that allows making authenticated HTTP requests to the Vercel API. Similar in API to gh api

Designed to improve discovery of our APIs for agents.

Vercel CLI 50.4.11 api (beta) — https://vercel.com/feedback

  ▲ vercel api [endpoint] [options]

  Make authenticated HTTP requests to the Vercel API        

  Options:

  -F,  --field <KEY=VALUE>      Add a typed parameter       
                                (numbers, booleans parsed). 
                                Use @file for file contents 
       --format <FORMAT>        Output format for ls command
                                (table, json). Defaults to  
                                table                       
       --generate <FORMAT>      Generate output instead of  
                                executing (e.g.,            
                                --generate=curl)            
  -H,  --header <KEY:VALUE>     Add a custom HTTP header    
  -i,  --include                Include response headers in 
                                output                      
       --input <FILE>           Read request body from file 
                                (use - for stdin)           
  -X,  --method <METHOD>        HTTP method (GET, POST, PUT,
                                PATCH, DELETE). Defaults to 
                                GET, or POST if body is     
                                provided                    
       --paginate               Fetch all pages of results  
       --raw                    Output raw JSON without     
                                pretty-printing             
  -f,  --raw-field <KEY=VALUE>  Add a string parameter (no  
                                type parsing)               
       --refresh                Force refresh the cached    
                                OpenAPI spec                
       --silent                 Suppress response output    
       --verbose                Show debug information      
                                including full              
                                request/response              


  Examples:

  - Get current user information

    $ vercel api /v2/user

  - List projects with team scope

    $ vercel api /v9/projects --scope my-team

  - Create a new project

    $ vercel api /v10/projects -X POST -F name=my-project

  - Delete a deployment

    $ vercel api /v13/deployments/dpl_abc123 -X DELETE

  - Paginate through all deployments

    $ vercel api /v6/deployments --paginate

  - Post JSON from file

    $ vercel api /v10/projects -X POST --input config.json

  - Add custom header

    $ vercel api /v2/user -H "X-Custom-Header: value"

  - List all available API endpoints

    $ vercel api --ls

  - Interactive mode (select endpoint)

    $ vercel api

changeset-bot · 2026-01-23T19:10:10Z

🦋 Changeset detected

Latest commit: 5d28102

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package

Name	Type
vercel	Minor

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

github-actions · 2026-01-23T19:10:31Z

📦 CLI Tarball Ready

The Vercel CLI tarball for this PR is now available!

Quick Test

You can test this PR's CLI directly by running:

npx https://vercel-m85oxf7p1.vercel.sh/tarballs/vercel.tgz --help

Use in vercel.json

To use this CLI version in your project builds, add to your vercel.json:

{
  "build": {
    "env": {
      "VERCEL_CLI_VERSION": "vercel@https://vercel-m85oxf7p1.vercel.sh/tarballs/vercel.tgz"
    }
  }
}

github-actions · 2026-01-23T19:12:42Z

🧪 Unit Test Strategy

Comparing: 6888a3e → 5d28102 (view diff)

Strategy: Code changed outside of a package - running all unit tests

⚠️ All unit tests will run because global code changes could impact all packages.

Affected packages - 41 (100%)

@vercel-internals/get-package-json
@vercel/backends
@vercel/build-utils
@vercel/cervel
@vercel/cli-auth
@vercel/client
@vercel/config
@vercel/detect-agent
@vercel/edge
@vercel/elysia
@vercel/error-utils
@vercel/express
@vercel/fastify
@vercel/firewall
@vercel/frameworks
@vercel/fs-detectors
@vercel/functions
@vercel/gatsby-plugin-vercel-builder
@vercel/go
@vercel/h3
@vercel/hono
@vercel/hydrogen
@vercel/introspection
@vercel/koa
@vercel/nestjs
@vercel/next
@vercel/node
@vercel/oidc
@vercel/oidc-aws-credentials-provider
@vercel/python
@vercel/python-analysis
@vercel/redwood
@vercel/related-projects
@vercel/remix-builder
@vercel/routing-utils
@vercel/ruby
@vercel/rust
@vercel/static-build
@vercel/static-config
examples
vercel

Results

Unit tests: All affected packages will run unit tests
E2E tests: Handled separately (Version Packages PRs or run-e2e-tests label)
Type checks: All affected packages will run type checks

This comment is automatically generated based on the affected testing strategy

socket-security · 2026-01-23T19:23:40Z

Review the following changes in direct dependencies. Learn more about Socket for GitHub.

Diff	Package	Supply Chain Security	Vulnerability	Quality	Maintenance	License
	npm/@inquirer/search@2.0.1

View full report

Introduces a new vercel api command that allows making authenticated HTTP requests to the Vercel API

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

- Import RequestConfig type in index.ts - Fix ensureLoaded type assertion that caused never type with private spec - Add explicit type cast for Object.entries on properties - Add stub telemetry methods for field/raw-field (not tracked for privacy) - Fix trackCliSubcommand call signature Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

packages/cli/src/commands/api/command.ts

packages/cli/src/util/telemetry/commands/api/index.ts

- Fix example: change `api --ls` to `api ls` (ls is a subcommand, not a flag) - Track field/raw-field option usage with redacted count instead of not tracking Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

This PR was opened by the [Changesets release](https://github.com/changesets/action) GitHub action. When you're ready to do a release, you can merge this and the packages will be published to npm automatically. If you're not ready to do a release yet, that's fine, whenever you add more changesets to main, this PR will be updated. # Releases ## vercel@50.5.0 ### Minor Changes - New, consistent --format command for machine readable output ([#14609](#14609)) - api command ([#14715](#14715)) - Detect Augment and OpenCode agents ([#14635](#14635)) ### Patch Changes - Track CLI as source for marketplace integration installations ([#14713](#14713)) - Do not show default project settings when framework is detected ([#14608](#14608)) - Fix flakey link tests caused by Inquirer type-ahead search ([#14716](#14716)) - Updated dependencies \[[`64b4577b6d702335478af47c8395bf36daf4f311`](64b4577), [`1ba97e3af1c1240703df3297fbbf7af0f809dd56`](1ba97e3)]: - @vercel/python@6.3.1 - @vercel/detect-agent@1.1.0 ## @vercel/detect-agent@1.1.0 ### Minor Changes - Detect Augment and OpenCode agents ([#14635](#14635)) ## @vercel/python@6.3.1 ### Patch Changes - isInstalled check only needs to check for python on the path. ([#14712](#14712)) Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

tknickman requested a review from a team as a code owner January 23, 2026 19:10

tknickman requested a review from brookemosby January 23, 2026 19:10

vercel bot deployed to Preview January 23, 2026 19:53 View deployment

vercel bot deployed to Preview January 23, 2026 19:56 View deployment

vercel bot deployed to Preview January 23, 2026 20:12 View deployment

tknickman and others added 4 commits January 23, 2026 16:42

feat(cli): add api command

ad8a624

Introduces a new vercel api command that allows making authenticated HTTP requests to the Vercel API

docs(cli): add --ls example to api command help

887ac70

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

test(cli): add api command to commands map test

ccc9cb3

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

tknickman force-pushed the tknickman/vercel-api-cmd branch from 2a8b8e0 to ccc9cb3 Compare January 23, 2026 21:43

vercel bot deployed to Preview January 23, 2026 21:43 View deployment

onsclom suggested changes Jan 23, 2026

View reviewed changes

packages/cli/src/commands/api/command.ts Show resolved Hide resolved

packages/cli/src/util/telemetry/commands/api/index.ts Outdated Show resolved Hide resolved

onsclom approved these changes Jan 23, 2026

View reviewed changes

fix(cli): address PR review comments

5d28102

- Fix example: change `api --ls` to `api ls` (ls is a subcommand, not a flag) - Track field/raw-field option usage with redacted count instead of not tracking Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

vercel bot deployed to Preview January 23, 2026 23:26 View deployment

onsclom approved these changes Jan 23, 2026

View reviewed changes

tknickman enabled auto-merge (squash) January 23, 2026 23:27

tknickman merged commit de34a47 into main Jan 23, 2026
141 checks passed

tknickman deleted the tknickman/vercel-api-cmd branch January 23, 2026 23:37

vercel-release-bot mentioned this pull request Jan 23, 2026

Version Packages #14714

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(cli): add api command#14715

feat(cli): add api command#14715
tknickman merged 5 commits intomainfrom
tknickman/vercel-api-cmd

tknickman commented Jan 23, 2026

Uh oh!

changeset-bot bot commented Jan 23, 2026 •

edited

Loading

Uh oh!

github-actions bot commented Jan 23, 2026 •

edited

Loading

Uh oh!

github-actions bot commented Jan 23, 2026 •

edited

Loading

Uh oh!

socket-security bot commented Jan 23, 2026 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

tknickman commented Jan 23, 2026

Uh oh!

changeset-bot bot commented Jan 23, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🦋 Changeset detected

Uh oh!

github-actions bot commented Jan 23, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

📦 CLI Tarball Ready

Quick Test

Use in vercel.json

Uh oh!

github-actions bot commented Jan 23, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🧪 Unit Test Strategy

Results

Uh oh!

socket-security bot commented Jan 23, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

changeset-bot bot commented Jan 23, 2026 •

edited

Loading

github-actions bot commented Jan 23, 2026 •

edited

Loading

github-actions bot commented Jan 23, 2026 •

edited

Loading

socket-security bot commented Jan 23, 2026 •

edited

Loading