GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — GitHub - vercel/sdk: Vercel SDK is a type-safe Typescript SDK that gives you access to the Vercel REST API.

BranchesTags
Open more actions menu

Latest commit

 

History

327 Commits
327 Commits

Folders and files

NameName
Last commit message
Last commit date
.devcontainer
.devcontainer
 
 
.github
.github
 
 
.speakeasy
.speakeasy
 
 
docs
docs
 
 
examples
examples
 
 
src
src
 
 
tests
tests
 
 
.gitattributes
.gitattributes
 
 
.gitignore
.gitignore
 
 
.npmignore
.npmignore
 
 
.oxlintrc.json
.oxlintrc.json
 
 
CONTRIBUTING.md
CONTRIBUTING.md
 
 
FUNCTIONS.md
FUNCTIONS.md
 
 
LICENSE
LICENSE
 
 
README.md
README.md
 
 
RELEASES.md
RELEASES.md
 
 
RUNTIMES.md
RUNTIMES.md
 
 
USAGE.md
USAGE.md
 
 
backup.yaml
backup.yaml
 
 
jsr.json
jsr.json
 
 
overlay-title.yaml
overlay-title.yaml
 
 
package-lock.json
package-lock.json
 
 
package.json
package.json
 
 
pnpm-lock.yaml
pnpm-lock.yaml
 
 
pnpm-workspace.yaml
pnpm-workspace.yaml
 
 
tsconfig.json
tsconfig.json
 
 
vercel-spec.json
vercel-spec.json
 
 

Repository files navigation

Vercel

Develop. Preview. Ship.

Join the Vercel Community

@vercel/sdk

The @vercel/sdk is a type-safe Typescript SDK that gives you full control over the entire Vercel platform through the Vercel REST API.

Table of Contents

  • @vercel/sdk
    • SDK Installation
    • Requirements
    • Access Tokens
    • Authentication
    • SDK Example Usage
    • Available Resources and Operations
    • Standalone functions
    • File uploads
    • Retries
    • Error Handling
    • Server Selection
    • Custom HTTP Client
    • Debugging
  • Development
    • Maturity
    • Contributions

SDK Installation

The SDK can be installed with either npm, pnpm, bun or yarn package managers.

NPM

npm add @vercel/sdk

PNPM

pnpm add @vercel/sdk

Bun

bun add @vercel/sdk

Yarn

yarn add @vercel/sdk

Note

This package is published as an ES Module (ESM) only. For applications using CommonJS, use await import("@vercel/sdk") to import and use this package.

Requirements

For supported JavaScript runtimes, please consult RUNTIMES.md.

Access Tokens

You need to pass a valid access token to be able to use any resource or operation. Refer to Creating an Access Token to learn how to create one. Make sure that you create a token with the correct Vercel scope. If you face permission (403) errors when you are already sending a token, it can be one of the following problems:

  • The token you are using has expired. Check the expiry date of the token in the Vercel dashboard.
  • The token does not have access to the correct scope, either not the right team or it does not have account level access.
  • The resource or operation you are trying to use is not available for that team. For example, AccessGroups is an Enterprise only feature and you are using a token for a team on the pro plan.

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

Name Type Scheme
bearerToken http HTTP Bearer

To authenticate with the API the bearerToken parameter must be set when initializing the SDK client instance. For example:

import { Vercel } from "@vercel/sdk";

const vercel = new Vercel({
  bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const result = await vercel.replaceDomainsByDomainRecords({
    domain: "example.com",
    teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
    slug: "my-team-url-slug",
  });

  console.log(result);
}

run();

SDK Example Usage

Update an existing project

Update the fields of a project using either its name or id.

import { Vercel } from "@vercel/sdk";

const vercel = new Vercel({
  bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const result = await vercel.projects.updateProject({
    idOrName: "prj_12HKQaOmR5t5Uy6vdcQsNIiZgHGB",
    teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
    slug: "my-team-url-slug",
    requestBody: {
      name: "a-project-name",
      sandbox: {
        region: "iad1",
        failoverRegions: [
          "sfo1",
          "cle1",
        ],
      },
    },
  });

  console.log(result);
}

run();

Available Resources and Operations

Available methods

Vercel SDK

  • replaceDomainsByDomainRecords
  • getDomainsRecordsByRecordId
  • createApiKeys
  • createObservabilityQuery
  • getObservabilitySchema
  • getObservabilitySchemaByMetricId
  • createSpeedInsightsToggle
  • createWebInsightsToggle

AccessGroups

  • readAccessGroup - Reads an access group
  • updateAccessGroup - Update an access group
  • deleteAccessGroup - Deletes an access group
  • listAccessGroupMembers - List members of an access group
  • listAccessGroups - List access groups for a team, project or member
  • createAccessGroup - Creates an access group
  • listAccessGroupProjects - List projects of an access group
  • createAccessGroupProject - Create an access group project
  • readAccessGroupProject - Reads an access group project
  • updateAccessGroupProject - Update an access group project
  • deleteAccessGroupProject - Delete an access group project

AiGateway

  • createAiGatewayByokCredential - Create a BYOK credential
  • listAiGatewayByokCredentials - List BYOK credentials
  • getAiGatewayByokCredential - Get a BYOK credential
  • updateAiGatewayByokCredential - Update a BYOK credential
  • deleteAiGatewayByokCredential - Delete a BYOK credential
  • createAiGatewayVirtualModelConfig - Create virtual model config
  • getAiGatewayVirtualModelConfig - Get virtual model config
  • updateAiGatewayVirtualModelConfig - Update virtual model config
  • deleteAiGatewayVirtualModelConfig - Delete virtual model config
  • listAiGatewayVirtualModelConfigs - List virtual model configs
  • getAiGatewayVirtualModelConfigBySlug - Get virtual model config
  • updateAiGatewayVirtualModelConfigBySlug - Update virtual model config
  • deleteAiGatewayVirtualModelConfigBySlug - Delete virtual model config
  • listAiGatewayRouters - List AI Gateway routers
  • createAiGatewayRule - Create rule
  • listAiGatewayRules - List rules
  • updateAiGatewayRule - Update rule
  • deleteAiGatewayRule - Delete rule
  • listAiGatewayBudgets - List AI Gateway budgets
  • upsertAiGatewayBudget - Upsert AI Gateway budget
  • archiveAiGatewayBudget - Archive AI Gateway budget
  • listAiGatewayBudgetDefaults - List AI Gateway budget defaults
  • upsertAiGatewayBudgetDefault - Upsert AI Gateway budget default
  • archiveAiGatewayBudgetDefault - Archive AI Gateway budget default
  • updateApiKeyQuota - Update an AI Gateway API key budget

Aliases

  • listDeploymentAliases - List Deployment Aliases
  • assignAlias - Assign an Alias
  • listAliases - List aliases
  • getAlias - Get an Alias
  • deleteAlias - Delete an Alias
  • patchUrlProtectionBypass - Update the protection bypass for a URL

Artifacts

  • recordEvents - Record an artifacts cache usage event
  • status - Get status of Remote Caching for this principal
  • uploadArtifact - Upload a cache artifact
  • downloadArtifact - Download a cache artifact
  • artifactExists - Check if a cache artifact exists
  • artifactQuery - Query information about an artifact
  • deleteAllArtifacts - Delete all cache artifacts

Authentication

  • exchangeSsoToken - SSO Token Exchange
  • listAuthTokens - List Auth Tokens
  • createAuthToken - Create an Auth Token
  • getAuthToken - Get Auth Token Metadata
  • deleteAuthToken - Delete an authentication token

Billing

  • buyCredits - Purchase credits

BulkRedirects

  • stageRedirects - Stages new redirects for a project.
  • getRedirects - Gets project-level redirects.
  • deleteRedirects - Delete project-level redirects.
  • editRedirect - Edit a project-level redirect.
  • restoreRedirects - Restore staged project-level redirects to their production version.
  • getVersions - Get the version history for a project's redirects.
  • updateVersion - Promote a staging version to production or restore a previous production version.

Certs

  • getCertById - Get cert by id
  • removeCert - Remove cert
  • getCerts - Get certs
  • issueCert - Issue a new cert
  • uploadCert - Upload a cert

Checks

  • createCheck - Creates a new Check ⚠️ Deprecated
  • getAllChecks - Retrieve a list of all checks ⚠️ Deprecated
  • getCheck - Get a single check ⚠️ Deprecated
  • updateCheck - Update a check ⚠️ Deprecated
  • rerequestCheck - Rerequest a check ⚠️ Deprecated

ChecksV2

  • listProjectChecks - List all checks for a project
  • createProjectCheck - Create a check
  • getProjectCheck - Get a check
  • updateProjectCheck - Update a check
  • deleteProjectCheck - Delete a check
  • listCheckRuns - List runs for a check
  • listDeploymentCheckRuns - List check runs for a deployment
  • createDeploymentCheckRun - Create a check run
  • getDeploymentCheckRun - Get a check run
  • updateDeploymentCheckRun - Update a check run

Connect

  • listConnectors - List connectors
  • getConnector - Get a connector
  • deleteConnector - Delete a connector
  • updateConnector - Update a connector
  • replaceConnectorTriggerDestinations - Update connector trigger destinations
  • ejectManagedConnector - Eject a managed connector
  • listConnectorProjectConnections - List projects for a connector
  • getConnectorProjectConnection - Get a connector project connection
  • upsertConnectorProjectConnection - Create or update a connector project connection
  • deleteConnectorProjectConnection - Disconnect a connector from a project
  • disconnectConnectorProjectEnvironment - Disconnect a connector from a project environment
  • listProjectConnectorConnections - List connectors for a project

Daemons

  • getProjectBoxes - Get project daemons
  • putProjectDaemonInstances - Override a project daemon's instance counts
  • restartProjectDaemonInstance - Force restart a project daemon instance

Deployments

  • getDeploymentEvents - Get deployment events
  • updateIntegrationDeploymentAction - Update deployment integration action
  • getDeployment - Get a deployment by ID or URL
  • createDeployment - Create a new deployment
  • cancelDeployment - Cancel a deployment
  • uploadFile - Upload Deployment Files
  • listDeploymentFiles - List Deployment Files
  • getDeploymentFileContents - Get Deployment File Contents
  • getDeployments - List deployments
  • deleteDeployment - Delete a Deployment

Dns

  • getRecords - List existing DNS records
  • createRecord - Create a DNS record
  • updateRecord - Update an existing DNS record
  • removeRecord - Delete a DNS record

Domains

  • getDomainConfig - Get a Domain's configuration
  • getDomainVerificationRecord - Get Domain Verification Record
  • claimDomainOwnership - Claim Domain Ownership
  • getDomainProjectDomains - List Project Domains by Apex Domain
  • getDomain - Get Information for a Single Domain
  • getDomains - List all the domains
  • createOrTransferDomain - Add an existing domain to the Vercel platform
  • patchDomain - Update or move apex domain
  • deleteDomain - Remove a domain by name

DomainsRegistrar

  • searchDomains - Get Domain Availability and Pricing
  • getSupportedTlds - Get supported TLDs
  • getTld - Get TLD
  • getTldPrice - Get TLD price data
  • getDomainAvailability - Get availability for a domain
  • getDomainPrice - Get price data for a domain
  • getBulkPrice - Get price data for multiple domains
  • getBulkAvailability - Get availability for multiple domains
  • getContactInfoSchema - Get contact info schema
  • getDomainAuthCode - Get the auth code for a domain
  • buySingleDomain - Buy a domain
  • buyDomains - Buy multiple domains
  • transferInDomain - Transfer-in a domain
  • getDomainTransferIn - Get a domain's transfer status
  • renewDomain - Renew a domain
  • updateDomainAutoRenew - Update auto-renew for a domain
  • updateDomainNameservers - Update nameservers for a domain
  • getDomainContactVerification - Get contact verification status for a domain
  • getOrder - Get a domain order

Drains

  • createDrain - Create a new Drain
  • getDrains - Retrieve a list of all Drains
  • deleteDrain - Delete a drain
  • getDrain - Find a Drain by id
  • updateDrain - Update an existing Drain
  • testDrain - Validate Drain delivery configuration

Drives

  • listDrivesV1 - List drives
  • getDriveV1 - Get a drive
  • getOrCreateDriveV1 - Get or create a drive
  • deleteDriveV1 - Delete a drive
  • forkDriveV1 - Fork a drive

EdgeCache

  • invalidateByTags - Invalidate by tag
  • dangerouslyDeleteByTags - Dangerously delete by tag
  • invalidateBySrcImages - Invalidate by source image
  • dangerouslyDeleteBySrcImages - Dangerously delete by source image

Environment

  • createSharedEnvVariable - Create one or more shared environment variables
  • listSharedEnvVariable - Lists all Shared Environment Variables for a team
  • updateSharedEnvVariable - Updates one or more shared environment variables
  • deleteSharedEnvVariable - Delete one or more Env Var
  • getSharedEnvVar - Retrieve the decrypted value of a Shared Environment Variable by id.
  • unlinkSharedEnvVariable - Disconnects a shared environment variable for a given project
  • createCustomEnvironment - Create a custom environment for the current project.
  • getProjectsByIdOrNameCustomEnvironments - Retrieve custom environments
  • getCustomEnvironment - Retrieve a custom environment
  • updateCustomEnvironment - Update a custom environment
  • removeCustomEnvironment - Remove a custom environment

FeatureFlags

  • listFlagsV2 - List flags
  • listFlags - List flags
  • createFlag - Create a flag
  • getFlag - Get a flag
  • updateFlag - Update a flag
  • deleteFlag - Delete a flag
  • listFlagVersions - List flag versions
  • getFlagSettings - Get project flag settings
  • updateFlagSettings - Update project flag settings
  • listFlagLabels - List attribute labels
  • listFlagLabelCounts - List attribute label counts
  • lookupFlagLabels - Look up attribute labels
  • listTeamFlagSettings - List team project flag settings
  • listTeamFlagsV2 - List all flags for a team
  • listTeamFlags - List all flags for a team
  • createFlagSegment - Create a segment
  • listFlagSegments - List segments
  • getFlagSegment - Get a segment
  • deleteFlagSegment - Delete a segment
  • updateFlagSegment - Update a segment
  • getDeploymentFeatureFlags - Retrieve the feature flags of a deployment
  • getSDKKeys - Get all SDK keys
  • createSDKKey - Create an SDK key
  • deleteSDKKey - Delete an SDK key
  • getFlagsProjectConnections - List flags project connections
  • createFlagsProjectConnection - Connect a project to the flags of this project
  • deleteFlagsProjectConnection - Disconnect a project from the flags of this project

GlobalConfig

  • getEdgeConfigs - Get Global Configs
  • createEdgeConfig - Create a Global Config
  • getEdgeConfig - Get a Global Config
  • updateEdgeConfig - Update a Global Config
  • deleteEdgeConfig - Delete a Global Config
  • getEdgeConfigItems - Get Global Config items
  • patchEdgeConfigItems - Update Global Config items in batch
  • getEdgeConfigSchema - Get Global Config schema
  • patchEdgeConfigSchema - Update Global Config schema
  • deleteEdgeConfigSchema - Delete a Global Config's schema
  • getEdgeConfigItem - Get a Global Config item
  • getEdgeConfigTokens - Get all tokens of a Global Config
  • deleteEdgeConfigTokens - Delete one or more Global Config tokens
  • getEdgeConfigToken - Get Global Config token meta data
  • createEdgeConfigToken - Create a Global Config token
  • getEdgeConfigBackup - Get Global Config backup
  • restoreEdgeConfigBackup - Restore Global Config backup
  • getEdgeConfigBackups - Get Global Config backups

Integrations

  • updateIntegrationDeploymentAction - Update deployment integration action
  • gitNamespaces - List git namespaces by provider
  • searchRepo - List git repositories linked to namespace by provider
  • getBillingPlans - List integration billing plans
  • connectIntegrationResourceToProject - Connect integration resource to project
  • getConfigurations - Get configurations for the authenticated user or team
  • getConfiguration - Retrieve an integration configuration
  • deleteConfiguration - Delete an integration configuration
  • getConfigurationProducts - List products for integration configuration
  • createIntegrationStoreDirect - Create integration store (free and paid plans)

Kms

  • signKmsMessage - Sign a message
  • signKmsToken - Sign a token
  • listKmsIssuers - List issuers
  • createKmsIssuer - Create an issuer
  • createKmsSigningKey - Create a signing key
  • activateKmsSigningKey - Activate a signing key
  • revokeKmsSigningKey - Revoke a signing key
  • getKmsIssuer - Get an issuer
  • updateKmsIssuer - Update an issuer
  • deleteKmsIssuer - Delete an issuer
  • createKmsIssuerPolicy - Create an issuer policy
  • updateKmsIssuerPolicy - Update an issuer policy
  • deleteKmsIssuerPolicy - Delete an issuer policy

LogDrains

  • getConfigurableLogDrain - Retrieves a Configurable Log Drain (deprecated)
  • deleteConfigurableLogDrain - Deletes a Configurable Log Drain (deprecated)
  • getAllLogDrains - Retrieves a list of all the Log Drains (deprecated)
  • createConfigurableLogDrain - Creates a Configurable Log Drain (deprecated)
  • getIntegrationLogDrains - Retrieves a list of Integration log drains (deprecated)
  • createLogDrain - Creates a new Integration Log Drain (deprecated)
  • deleteIntegrationLogDrain - Deletes the Integration log drain with the provided id (deprecated)

Logs

  • getRuntimeLogs - Get logs for a deployment

Marketplace

  • updateInstallation - Update Installation
  • getAccountInfo - Get Account Information
  • getMember - Get Member Information
  • rotateInstallationCredential - Rotate Installation Credential
  • revokeInstallationCredential - Revoke Installation Credential
  • createEvent - Create Event
  • getIntegrationResources - Get Integration Resources
  • getIntegrationResource - Get Integration Resource
  • deleteIntegrationResource - Delete Integration Resource
  • importResource - Import Resource
  • updateResource - Update Resource
  • submitBillingData - Submit Billing Data
  • submitInvoice - Submit Invoice
  • finalizeInstallation - Finalize Installation
  • getInvoice - Get Invoice
  • updateInvoice - Invoice Actions
  • submitPrepaymentBalances - Submit Prepayment Balances
  • updateResourceSecrets - Deprecated: true. Update Resource Secrets (Deprecated) ⚠️ Deprecated
  • updateResourceSecretsById - Update Resource Secrets
  • exchangeSsoToken - SSO Token Exchange
  • createInstallationIntegrationConfiguration - Create one or multiple experimentation items
  • updateInstallationIntegrationConfiguration - Patch an existing experimentation item
  • deleteInstallationIntegrationConfiguration - Delete an existing experimentation item
  • headInstallationsByIntegrationConfigurationIdResourcesByResourceIdExperimentationGlobalConfig - Get the data of a user-provided Global Config
  • getInstallationsByIntegrationConfigurationIdResourcesByResourceIdExperimentationGlobalConfig - Get the data of a user-provided Global Config
  • replaceInstallationsByIntegrationConfigurationIdResourcesByResourceIdExperimentationGlobalConfig - Push data into a user-provided Global Config

Microfrontends

  • getMicrofrontendsGroups - List microfrontends groups
  • getMicrofrontendsInGroup - List projects in a microfrontends group
  • getMicrofrontendsConfig - Get microfrontends config for a deployment
  • getMicrofrontendsConfigForProject - Get microfrontends config for a project
  • createMicrofrontendsGroupWithApplications - Create a microfrontends group with applications

Networking

  • listNetworks - List Secure Compute networks
  • createNetwork - Create a Secure Compute network
  • deleteNetwork - Delete a Secure Compute network
  • updateNetwork - Update a Secure Compute network
  • readNetwork - Read a Secure Compute network
  • createPrivateLinkEndpoint - Create a PrivateLink endpoint
  • listPrivateLinkEndpoints - List PrivateLink endpoints
  • readPrivateLinkEndpoint - Read a PrivateLink endpoint
  • deletePrivateLinkEndpoint - Delete a PrivateLink endpoint
  • updatePrivateLinkEndpoint - Update a PrivateLink endpoint
  • updateStaticIps - Configures Static IPs for a project

Observability

  • getObservabilityConfigurationProjects - Lists disabled Observability Plus projects
  • updateObservabilityConfigurationProject - Updates a disabled Observability Plus project setting

Organizations

  • createOrganization - Create an Organization
  • listOrganizations - List Organizations
  • getOrganization - Get an Organization
  • updateOrganization - Update an Organization
  • listOrganizationTeams - List Organization Teams
  • removeOrganizationTeam - Delete Team from Organization

ProjectRoutes

  • getRoutes - Get project routing rules
  • stageRoutes - Stage routing rules
  • addRoute - Add a routing rule
  • deleteRoutes - Delete routing rules
  • editRoute - Edit a routing rule
  • generateRoute - Generate a routing rule from natural language
  • getRouteVersions - Get routing rule version history
  • updateRouteVersions - Promote, restore, or discard a routing rule version

ProjectMembers

  • getProjectMembers - List project members
  • addProjectMember - Adds a new member to a project.
  • removeProjectMember - Remove a Project Member

Projects

  • getProjects - Retrieve a list of projects
  • getProjectTrace - Get a project trace by request ID
  • createProject - Create a new project
  • getProjectToken - Generate a project OIDC token
  • createTraceSession - Create a trace session token for a deployment
  • getProject - Find a project by id or name
  • updateProject - Update an existing project
  • deleteProject - Delete a Project
  • uploadProjectAvatar - Upload a project avatar
  • deleteProjectAvatar - Delete a project avatar
  • getProjectDomains - Retrieve project domains by project by id or name
  • getProjectDomain - Get a project domain
  • updateProjectDomain - Update a project domain
  • removeProjectDomain - Remove a domain from a project
  • addProjectDomain - Add a domain to a project
  • moveProjectDomain - Move a project domain
  • verifyProjectDomain - Verify project domain
  • filterProjectEnvs - Retrieve the environment variables of a project by id or name
  • createProjectEnv - Create one or more environment variables
  • getProjectEnv - Retrieve the decrypted value of an environment variable of a project by id
  • removeProjectEnv - Remove an environment variable
  • editProjectEnv - Edit an environment variable
  • batchRemoveProjectEnv - Batch remove environment variables
  • createProjectTransferRequest - Create project transfer request
  • acceptProjectTransferRequest - Accept project transfer request
  • updateProjectProtectionBypass - Update Protection Bypass for Automation
  • requestRollback - Point production traffic to a previous production deployment by ID
  • updateProjectsByProjectIdRollbackByDeploymentIdUpdateDescription - Updates the description for a rollback
  • updateMicrofrontends - Update the microfrontends settings
  • requestPromote - Point production traffic to a given deployment
  • listPromoteAliases - Gets a list of aliases with status for the current promote
  • pauseProject - Pause a project
  • unpauseProject - Unpause a project

RollingRelease

  • getRollingReleaseBillingStatus - Get rolling release billing status
  • getRollingReleaseConfig - Get rolling release configuration
  • deleteRollingReleaseConfig - Delete rolling release configuration
  • updateRollingReleaseConfig - Update the rolling release settings for the project
  • getRollingRelease - Get the active rolling release information for a project
  • approveRollingReleaseStage - Update the active rolling release to the next stage for a project
  • startRollingRelease - Start a rolling release for the project
  • completeRollingRelease - Complete the rolling release for the project

Sandboxes

  • listNamedSandboxes - List sandboxes
  • listDrives - Deprecated: Use GET /v1/drives. Requires the read:drive app scope instead of read:sandbox, and drive:list instead of vercelRun:read. List drives ⚠️ Deprecated
  • getDrive - Deprecated: Use GET /v1/drives/:nameOrId. Requires the read:drive app scope instead of read:sandbox, and drive:read instead of vercelRun:read. Get a drive ⚠️ Deprecated
  • getOrCreateDrive - Deprecated: Use POST /v1/drives/:name. Requires the read-write:drive app scope instead of read-write:sandbox, and drive:create instead of vercelRun:create. Emits drive-created activity events instead of sandbox-drive-created. Get or create a drive ⚠️ Deprecated
  • deleteDrive - Deprecated: Use DELETE /v1/drives/:name. Requires the read-write:drive app scope instead of read-write:sandbox, and drive:delete instead of vercelRun:delete. Emits drive-deleted activity events instead of sandbox-drive-deleted. Delete a drive ⚠️ Deprecated
  • forkDrive - Deprecated: Use POST /v1/drives/:name/fork. Requires the read-write:drive app scope instead of read-write:sandbox, and drive:read and drive:create instead of vercelRun:read and vercelRun:create. Emits drive-created activity events instead of sandbox-drive-created. Fork a drive ⚠️ Deprecated
  • listSessionSnapshots - List snapshots
  • getSessionSnapshot - Get a snapshot
  • deleteSessionSnapshot - Delete a snapshot
  • listSessions - List sessions
  • getSession - Get a session
  • getNamedSandbox - Get a named sandbox
  • deleteSandbox - Delete a sandbox
  • listSessionCommands - List commands
  • getSessionCommand - Get a command
  • killSessionCommand - Kill a command
  • writeSessionCommandStdin - Write to command stdin
  • stopSession - Stop a session
  • extendSessionTimeout - Extend session timeout
  • updateSessionNetworkPolicy - Update network policy
  • readSessionFile - Read a file
  • createSessionDirectory - Create a directory
  • writeSessionFiles - Write files
  • createSandboxesSessionsBySessionIdSnapshotV2 - Create a snapshot
  • createSandboxesSessionsBySessionIdSnapshotV3 - Create a snapshot

Security

  • updateAttackChallengeMode - Update Attack Challenge mode
  • getSecurityFirewallConfig - Returns activated WAF config
  • putFirewallConfig - Put Firewall Configuration
  • updateFirewallConfig - Update Firewall Configuration
  • getFirewallConfig - Read Firewall Configuration
  • deleteSecurityFirewallConfigByConfigVersion - Returns activated WAF config
  • createSecurityFirewallConfigByConfigVersionActivate - Returns activated WAF config
  • getActiveAttackStatus - Read active attack data
  • getBypassIp - Read System Bypass
  • addBypassIp - Create System Bypass Rule
  • removeBypassIp - Remove System Bypass Rule
  • getConditionalBypass - Get conditional firewall bypasses
  • createConditionalBypass - Create conditional firewall bypass
  • updateConditionalBypass - Update conditional firewall bypass
  • deleteConditionalBypass - Delete conditional firewall bypass
  • getSecurityFirewallEvents - Read Firewall Actions by Project
  • getSecurityFirewallEventsSummary - Read Firewall Actions Summary by Project
  • generateFirewallRule - Generate a firewall rule from natural language

StaticIps

  • updateStaticIps - Configures Static IPs for a project

Storage

  • getStorageStoresById - Get a store
  • createStorageStoresBlob - Create a Blob store
  • deleteStorageStoresBlobById - Delete a Blob store

Teams

  • getTeamMembers - List team members
  • inviteUserToTeam - Invite a user
  • requestAccessToTeam - Request access to a team
  • getTeamAccessRequest - Get access request status
  • joinTeam - Join a team
  • updateTeamMember - Update a Team Member
  • removeTeamMember - Remove a Team Member
  • getTeam - Get a Team
  • patchTeam - Update a Team
  • getTeams - List all teams
  • createTeam - Create a Team
  • postTeamDsyncRoles - Update Team Directory Sync Role Mappings
  • deleteTeam - Delete a Team
  • deleteTeamInviteCode - Delete a Team invite code
  • updateMicrofrontendsGroup - Update a microfrontends group
  • deleteMicrofrontendsGroup - Delete a microfrontends group

User

  • listUserEvents - List User Events
  • listEventTypes - List Event Types
  • getAuthUser - Get the User
  • requestDelete - Delete User Account

Vcr

  • createRepository - Create a repository
  • listRepositories - List repositories
  • getRepository - Get a repository
  • deleteRepository - Delete a repository
  • listRepositoryImages - List repository images
  • addRepositoryPermission - Add a repository permission
  • removeRepositoryPermission - Remove a repository permission
  • listRepositoryPermissions - List repository permissions
  • clearRepositoryPermissions - Clear all repository permissions
  • listRepositoryTags - List repository tags
  • getRepositoryTag - Get a repository tag
  • getRepositoryImage - Get a repository image
  • deleteRepositoryImage - Delete a repository image
  • getRoot - Check registry API version support
  • headByTeamSlugByProjectSlugByRepositoryNameBlobsByDigest - Check if a blob exists
  • getByTeamSlugByProjectSlugByRepositoryNameBlobsByDigest - Download a blob
  • deleteByTeamSlugByProjectSlugByRepositoryNameBlobsByDigest - Delete a blob
  • getByTeamSlugByProjectSlugByRepositoryNameBlobsUploadsByUuid - Get blob upload status
  • deleteByTeamSlugByProjectSlugByRepositoryNameBlobsUploadsByUuid - Cancel a blob upload
  • updateByTeamSlugByProjectSlugByRepositoryNameBlobsUploadsByUuid - Upload a blob chunk
  • replaceByTeamSlugByProjectSlugByRepositoryNameBlobsUploadsByUuid - Complete a blob upload
  • createByTeamSlugByProjectSlugByRepositoryNameBlobsUploads - Start a blob upload
  • replaceByTeamSlugByProjectSlugByRepositoryNameManifestsByReference - Push an image manifest
  • headByTeamSlugByProjectSlugByRepositoryNameManifestsByReference - Check if a manifest exists
  • getByTeamSlugByProjectSlugByRepositoryNameManifestsByReference - Pull an image manifest
  • deleteByTeamSlugByProjectSlugByRepositoryNameManifestsByReference - Delete an image manifest
  • getByTeamSlugByProjectSlugByRepositoryNameTagsList - List image tags

VercelCi

  • getVercelCiRepositorySettings - Get Vercel CI settings for a connected repository
  • updateVercelCiRepositorySettings - Enable or disable Vercel CI for a connected repository
  • listVercelCiInvocations - List invocations for a team, optionally filtered by repository and invocation metadata
  • listVercelCiBranches - List Vercel CI branch suggestions for a team
  • createVercelCiTaskAnalysis - Start an asynchronous Vercel CI task analysis
  • getVercelCiTaskAnalysis - Get the current status of a Vercel CI task analysis
  • createVercelCiTaskConfigurationPullRequest - Create a GitHub pull request that adds Vercel CI tags for the completed analysis
  • listVercelCiTaskAnalysisTasks - List discovered tasks for a completed Vercel CI task analysis
  • listVercelCiInvocationAttempts - List all attempts for an invocation
  • getVercelCiInvocationTree - Get an invocation with its jobs and tasks
  • getVercelCiInvocation - Get a specific invocation attempt
  • retryVercelCiInvocation - Retry a terminal Vercel CI invocation attempt
  • listVercelCiJobDefinitions - List job definitions for an invocation attempt
  • getVercelCiJobDefinition - Get a specific job definition
  • listVercelCiJobRuns - List all runs for a job definition
  • getVercelCiJobRun - Get a specific job run attempt
  • listVercelCiTaskDefinitions - List all task definitions for a job run
  • listVercelCiTaskRuns - List task runs for a job run
  • getVercelCiInvocationLogs - Get log lines for an invocation attempt
  • getVercelCiTaskLogs - Get log lines for the tasks of an invocation attempt
  • searchVercelCiLogs - Search the task logs of several invocation attempts
  • getVercelCiJobRunLogs - Get log lines for a specific job run attempt
  • getVercelCiTaskRunLogs - Get log lines for a specific task run attempt

WebAnalytics

  • aggregatePageviews - Aggregates page views
  • aggregateEvents - Aggregates custom events
  • countPageviews - Counts page views
  • countEvents - Counts custom events

Webhooks

  • createWebhook - Creates a webhook
  • getWebhooks - Get a list of webhooks
  • getWebhook - Get a webhook
  • deleteWebhook - Deletes a webhook

Standalone functions

All the methods listed above are available as standalone functions. These functions are ideal for use in applications running in the browser, serverless runtimes or other environments where application bundle size is a primary concern. When using a bundler to build your application, all unused functionality will be either excluded from the final bundle or tree-shaken away.

To read more about standalone functions, check FUNCTIONS.md.

Available standalone functions
  • accessGroupsCreateAccessGroup - Creates an access group
  • accessGroupsCreateAccessGroupProject - Create an access group project
  • accessGroupsDeleteAccessGroup - Deletes an access group
  • accessGroupsDeleteAccessGroupProject - Delete an access group project
  • accessGroupsListAccessGroupMembers - List members of an access group
  • accessGroupsListAccessGroupProjects - List projects of an access group
  • accessGroupsListAccessGroups - List access groups for a team, project or member
  • accessGroupsReadAccessGroup - Reads an access group
  • accessGroupsReadAccessGroupProject - Reads an access group project
  • accessGroupsUpdateAccessGroup - Update an access group
  • accessGroupsUpdateAccessGroupProject - Update an access group project
  • aiGatewayArchiveAiGatewayBudget - Archive AI Gateway budget
  • aiGatewayArchiveAiGatewayBudgetDefault - Archive AI Gateway budget default
  • aiGatewayCreateAiGatewayByokCredential - Create a BYOK credential
  • aiGatewayCreateAiGatewayRule - Create rule
  • aiGatewayCreateAiGatewayVirtualModelConfig - Create virtual model config
  • aiGatewayDeleteAiGatewayByokCredential - Delete a BYOK credential
  • aiGatewayDeleteAiGatewayRule - Delete rule
  • aiGatewayDeleteAiGatewayVirtualModelConfig - Delete virtual model config
  • aiGatewayDeleteAiGatewayVirtualModelConfigBySlug - Delete virtual model config
  • aiGatewayGetAiGatewayByokCredential - Get a BYOK credential
  • aiGatewayGetAiGatewayVirtualModelConfig - Get virtual model config
  • aiGatewayGetAiGatewayVirtualModelConfigBySlug - Get virtual model config
  • aiGatewayListAiGatewayBudgetDefaults - List AI Gateway budget defaults
  • aiGatewayListAiGatewayBudgets - List AI Gateway budgets
  • aiGatewayListAiGatewayByokCredentials - List BYOK credentials
  • aiGatewayListAiGatewayRouters - List AI Gateway routers
  • aiGatewayListAiGatewayRules - List rules
  • aiGatewayListAiGatewayVirtualModelConfigs - List virtual model configs
  • aiGatewayUpdateAiGatewayByokCredential - Update a BYOK credential
  • aiGatewayUpdateAiGatewayRule - Update rule
  • aiGatewayUpdateAiGatewayVirtualModelConfig - Update virtual model config
  • aiGatewayUpdateAiGatewayVirtualModelConfigBySlug - Update virtual model config
  • aiGatewayUpdateApiKeyQuota - Update an AI Gateway API key budget
  • aiGatewayUpsertAiGatewayBudget - Upsert AI Gateway budget
  • aiGatewayUpsertAiGatewayBudgetDefault - Upsert AI Gateway budget default
  • aliasesAssignAlias - Assign an Alias
  • aliasesDeleteAlias - Delete an Alias
  • aliasesGetAlias - Get an Alias
  • aliasesListAliases - List aliases
  • aliasesListDeploymentAliases - List Deployment Aliases
  • aliasesPatchUrlProtectionBypass - Update the protection bypass for a URL
  • artifactsArtifactExists - Check if a cache artifact exists
  • artifactsArtifactQuery - Query information about an artifact
  • artifactsDeleteAllArtifacts - Delete all cache artifacts
  • artifactsDownloadArtifact - Download a cache artifact
  • artifactsRecordEvents - Record an artifacts cache usage event
  • artifactsStatus - Get status of Remote Caching for this principal
  • artifactsUploadArtifact - Upload a cache artifact
  • authenticationCreateAuthToken - Create an Auth Token
  • authenticationDeleteAuthToken - Delete an authentication token
  • authenticationGetAuthToken - Get Auth Token Metadata
  • authenticationListAuthTokens - List Auth Tokens
  • billingBuyCredits - Purchase credits
  • bulkRedirectsDeleteRedirects - Delete project-level redirects.
  • bulkRedirectsEditRedirect - Edit a project-level redirect.
  • bulkRedirectsGetRedirects - Gets project-level redirects.
  • bulkRedirectsGetVersions - Get the version history for a project's redirects.
  • bulkRedirectsRestoreRedirects - Restore staged project-level redirects to their production version.
  • bulkRedirectsStageRedirects - Stages new redirects for a project.
  • bulkRedirectsUpdateVersion - Promote a staging version to production or restore a previous production version.
  • certsGetCertById - Get cert by id
  • certsGetCerts - Get certs
  • certsIssueCert - Issue a new cert
  • certsRemoveCert - Remove cert
  • certsUploadCert - Upload a cert
  • checksV2CreateDeploymentCheckRun - Create a check run
  • checksV2CreateProjectCheck - Create a check
  • checksV2DeleteProjectCheck - Delete a check
  • checksV2GetDeploymentCheckRun - Get a check run
  • checksV2GetProjectCheck - Get a check
  • checksV2ListCheckRuns - List runs for a check
  • checksV2ListDeploymentCheckRuns - List check runs for a deployment
  • checksV2ListProjectChecks - List all checks for a project
  • checksV2UpdateDeploymentCheckRun - Update a check run
  • checksV2UpdateProjectCheck - Update a check
  • connectDeleteConnector - Delete a connector
  • connectDeleteConnectorProjectConnection - Disconnect a connector from a project
  • connectDisconnectConnectorProjectEnvironment - Disconnect a connector from a project environment
  • connectEjectManagedConnector - Eject a managed connector
  • connectGetConnector - Get a connector
  • connectGetConnectorProjectConnection - Get a connector project connection
  • connectListConnectorProjectConnections - List projects for a connector
  • connectListConnectors - List connectors
  • connectListProjectConnectorConnections - List connectors for a project
  • connectReplaceConnectorTriggerDestinations - Update connector trigger destinations
  • connectUpdateConnector - Update a connector
  • connectUpsertConnectorProjectConnection - Create or update a connector project connection
  • createApiKeys
  • createObservabilityQuery
  • createSpeedInsightsToggle
  • createWebInsightsToggle
  • daemonsGetProjectBoxes - Get project daemons
  • daemonsPutProjectDaemonInstances - Override a project daemon's instance counts
  • daemonsRestartProjectDaemonInstance - Force restart a project daemon instance
  • deploymentsCancelDeployment - Cancel a deployment
  • deploymentsCreateDeployment - Create a new deployment
  • deploymentsDeleteDeployment - Delete a Deployment
  • deploymentsGetDeployment - Get a deployment by ID or URL
  • deploymentsGetDeploymentEvents - Get deployment events
  • deploymentsGetDeploymentFileContents - Get Deployment File Contents
  • deploymentsGetDeployments - List deployments
  • deploymentsListDeploymentFiles - List Deployment Files
  • deploymentsUpdateIntegrationDeploymentAction - Update deployment integration action
  • deploymentsUpdateIntegrationDeploymentAction - Update deployment integration action
  • deploymentsUploadFile - Upload Deployment Files
  • dnsCreateRecord - Create a DNS record
  • dnsGetRecords - List existing DNS records
  • dnsRemoveRecord - Delete a DNS record
  • dnsUpdateRecord - Update an existing DNS record
  • domainsClaimDomainOwnership - Claim Domain Ownership
  • domainsCreateOrTransferDomain - Add an existing domain to the Vercel platform
  • domainsDeleteDomain - Remove a domain by name
  • domainsGetDomain - Get Information for a Single Domain
  • domainsGetDomainConfig - Get a Domain's configuration
  • domainsGetDomainProjectDomains - List Project Domains by Apex Domain
  • domainsGetDomains - List all the domains
  • domainsGetDomainVerificationRecord - Get Domain Verification Record
  • domainsPatchDomain - Update or move apex domain
  • domainsRegistrarBuyDomains - Buy multiple domains
  • domainsRegistrarBuySingleDomain - Buy a domain
  • domainsRegistrarGetBulkAvailability - Get availability for multiple domains
  • domainsRegistrarGetBulkPrice - Get price data for multiple domains
  • domainsRegistrarGetContactInfoSchema - Get contact info schema
  • domainsRegistrarGetDomainAuthCode - Get the auth code for a domain
  • domainsRegistrarGetDomainAvailability - Get availability for a domain
  • domainsRegistrarGetDomainContactVerification - Get contact verification status for a domain
  • domainsRegistrarGetDomainPrice - Get price data for a domain
  • domainsRegistrarGetDomainTransferIn - Get a domain's transfer status
  • domainsRegistrarGetOrder - Get a domain order
  • domainsRegistrarGetSupportedTlds - Get supported TLDs
  • domainsRegistrarGetTld - Get TLD
  • domainsRegistrarGetTldPrice - Get TLD price data
  • domainsRegistrarRenewDomain - Renew a domain
  • domainsRegistrarSearchDomains - Get Domain Availability and Pricing
  • domainsRegistrarTransferInDomain - Transfer-in a domain
  • domainsRegistrarUpdateDomainAutoRenew - Update auto-renew for a domain
  • domainsRegistrarUpdateDomainNameservers - Update nameservers for a domain
  • drainsCreateDrain - Create a new Drain
  • drainsDeleteDrain - Delete a drain
  • drainsGetDrain - Find a Drain by id
  • drainsGetDrains - Retrieve a list of all Drains
  • drainsTestDrain - Validate Drain delivery configuration
  • drainsUpdateDrain - Update an existing Drain
  • drivesDeleteDriveV1 - Delete a drive
  • drivesForkDriveV1 - Fork a drive
  • drivesGetDriveV1 - Get a drive
  • drivesGetOrCreateDriveV1 - Get or create a drive
  • drivesListDrivesV1 - List drives
  • edgeCacheDangerouslyDeleteBySrcImages - Dangerously delete by source image
  • edgeCacheDangerouslyDeleteByTags - Dangerously delete by tag
  • edgeCacheInvalidateBySrcImages - Invalidate by source image
  • edgeCacheInvalidateByTags - Invalidate by tag
  • environmentCreateCustomEnvironment - Create a custom environment for the current project.
  • environmentCreateSharedEnvVariable - Create one or more shared environment variables
  • environmentDeleteSharedEnvVariable - Delete one or more Env Var
  • environmentGetCustomEnvironment - Retrieve a custom environment
  • environmentGetProjectsByIdOrNameCustomEnvironments - Retrieve custom environments
  • environmentGetSharedEnvVar - Retrieve the decrypted value of a Shared Environment Variable by id.
  • environmentListSharedEnvVariable - Lists all Shared Environment Variables for a team
  • environmentRemoveCustomEnvironment - Remove a custom environment
  • environmentUnlinkSharedEnvVariable - Disconnects a shared environment variable for a given project
  • environmentUpdateCustomEnvironment - Update a custom environment
  • environmentUpdateSharedEnvVariable - Updates one or more shared environment variables
  • featureFlagsCreateFlag - Create a flag
  • featureFlagsCreateFlagSegment - Create a segment
  • featureFlagsCreateFlagsProjectConnection - Connect a project to the flags of this project
  • featureFlagsCreateSDKKey - Create an SDK key
  • featureFlagsDeleteFlag - Delete a flag
  • featureFlagsDeleteFlagSegment - Delete a segment
  • featureFlagsDeleteFlagsProjectConnection - Disconnect a project from the flags of this project
  • featureFlagsDeleteSDKKey - Delete an SDK key
  • featureFlagsGetDeploymentFeatureFlags - Retrieve the feature flags of a deployment
  • featureFlagsGetFlag - Get a flag
  • featureFlagsGetFlagSegment - Get a segment
  • featureFlagsGetFlagSettings - Get project flag settings
  • featureFlagsGetFlagsProjectConnections - List flags project connections
  • featureFlagsGetSDKKeys - Get all SDK keys
  • featureFlagsListFlagLabelCounts - List attribute label counts
  • featureFlagsListFlagLabels - List attribute labels
  • featureFlagsListFlags - List flags
  • featureFlagsListFlagSegments - List segments
  • featureFlagsListFlagsV2 - List flags
  • featureFlagsListFlagVersions - List flag versions
  • featureFlagsListTeamFlags - List all flags for a team
  • featureFlagsListTeamFlagSettings - List team project flag settings
  • featureFlagsListTeamFlagsV2 - List all flags for a team
  • featureFlagsLookupFlagLabels - Look up attribute labels
  • featureFlagsUpdateFlag - Update a flag
  • featureFlagsUpdateFlagSegment - Update a segment
  • featureFlagsUpdateFlagSettings - Update project flag settings
  • getDomainsRecordsByRecordId
  • getObservabilitySchema
  • getObservabilitySchemaByMetricId
  • globalConfigCreateEdgeConfig - Create a Global Config
  • globalConfigCreateEdgeConfigToken - Create a Global Config token
  • globalConfigDeleteEdgeConfig - Delete a Global Config
  • globalConfigDeleteEdgeConfigSchema - Delete a Global Config's schema
  • globalConfigDeleteEdgeConfigTokens - Delete one or more Global Config tokens
  • globalConfigGetEdgeConfig - Get a Global Config
  • globalConfigGetEdgeConfigBackup - Get Global Config backup
  • globalConfigGetEdgeConfigBackups - Get Global Config backups
  • globalConfigGetEdgeConfigItem - Get a Global Config item
  • globalConfigGetEdgeConfigItems - Get Global Config items
  • globalConfigGetEdgeConfigs - Get Global Configs
  • globalConfigGetEdgeConfigSchema - Get Global Config schema
  • globalConfigGetEdgeConfigToken - Get Global Config token meta data
  • globalConfigGetEdgeConfigTokens - Get all tokens of a Global Config
  • globalConfigPatchEdgeConfigItems - Update Global Config items in batch
  • globalConfigPatchEdgeConfigSchema - Update Global Config schema
  • globalConfigRestoreEdgeConfigBackup - Restore Global Config backup
  • globalConfigUpdateEdgeConfig - Update a Global Config
  • integrationsConnectIntegrationResourceToProject - Connect integration resource to project
  • integrationsCreateIntegrationStoreDirect - Create integration store (free and paid plans)
  • integrationsDeleteConfiguration - Delete an integration configuration
  • integrationsGetBillingPlans - List integration billing plans
  • integrationsGetConfiguration - Retrieve an integration configuration
  • integrationsGetConfigurationProducts - List products for integration configuration
  • integrationsGetConfigurations - Get configurations for the authenticated user or team
  • integrationsGitNamespaces - List git namespaces by provider
  • integrationsSearchRepo - List git repositories linked to namespace by provider
  • kmsActivateKmsSigningKey - Activate a signing key
  • kmsCreateKmsIssuer - Create an issuer
  • kmsCreateKmsIssuerPolicy - Create an issuer policy
  • kmsCreateKmsSigningKey - Create a signing key
  • kmsDeleteKmsIssuer - Delete an issuer
  • kmsDeleteKmsIssuerPolicy - Delete an issuer policy
  • kmsGetKmsIssuer - Get an issuer
  • kmsListKmsIssuers - List issuers
  • kmsRevokeKmsSigningKey - Revoke a signing key
  • kmsSignKmsMessage - Sign a message
  • kmsSignKmsToken - Sign a token
  • kmsUpdateKmsIssuer - Update an issuer
  • kmsUpdateKmsIssuerPolicy - Update an issuer policy
  • logDrainsCreateConfigurableLogDrain - Creates a Configurable Log Drain (deprecated)
  • logDrainsCreateLogDrain - Creates a new Integration Log Drain (deprecated)
  • logDrainsDeleteConfigurableLogDrain - Deletes a Configurable Log Drain (deprecated)
  • logDrainsDeleteIntegrationLogDrain - Deletes the Integration log drain with the provided id (deprecated)
  • logDrainsGetAllLogDrains - Retrieves a list of all the Log Drains (deprecated)
  • logDrainsGetConfigurableLogDrain - Retrieves a Configurable Log Drain (deprecated)
  • logDrainsGetIntegrationLogDrains - Retrieves a list of Integration log drains (deprecated)
  • logsGetRuntimeLogs - Get logs for a deployment
  • marketplaceCreateEvent - Create Event
  • marketplaceCreateInstallationIntegrationConfiguration - Create one or multiple experimentation items
  • marketplaceDeleteInstallationIntegrationConfiguration - Delete an existing experimentation item
  • marketplaceDeleteIntegrationResource - Delete Integration Resource
  • marketplaceExchangeSsoToken - SSO Token Exchange
  • marketplaceExchangeSsoToken - SSO Token Exchange
  • marketplaceFinalizeInstallation - Finalize Installation
  • marketplaceGetAccountInfo - Get Account Information
  • marketplaceGetInstallationsByIntegrationConfigurationIdResourcesByResourceIdExperimentationGlobalConfig - Get the data of a user-provided Global Config
  • marketplaceGetIntegrationResource - Get Integration Resource
  • marketplaceGetIntegrationResources - Get Integration Resources
  • marketplaceGetInvoice - Get Invoice
  • marketplaceGetMember - Get Member Information
  • marketplaceHeadInstallationsByIntegrationConfigurationIdResourcesByResourceIdExperimentationGlobalConfig - Get the data of a user-provided Global Config
  • marketplaceImportResource - Import Resource
  • marketplaceReplaceInstallationsByIntegrationConfigurationIdResourcesByResourceIdExperimentationGlobalConfig - Push data into a user-provided Global Config
  • marketplaceRevokeInstallationCredential - Revoke Installation Credential
  • marketplaceRotateInstallationCredential - Rotate Installation Credential
  • marketplaceSubmitBillingData - Submit Billing Data
  • marketplaceSubmitInvoice - Submit Invoice
  • marketplaceSubmitPrepaymentBalances - Submit Prepayment Balances
  • marketplaceUpdateInstallation - Update Installation
  • marketplaceUpdateInstallationIntegrationConfiguration - Patch an existing experimentation item
  • marketplaceUpdateInvoice - Invoice Actions
  • marketplaceUpdateResource - Update Resource
  • marketplaceUpdateResourceSecretsById - Update Resource Secrets
  • microfrontendsCreateMicrofrontendsGroupWithApplications - Create a microfrontends group with applications
  • microfrontendsGetMicrofrontendsConfig - Get microfrontends config for a deployment
  • microfrontendsGetMicrofrontendsConfigForProject - Get microfrontends config for a project
  • microfrontendsGetMicrofrontendsGroups - List microfrontends groups
  • microfrontendsGetMicrofrontendsInGroup - List projects in a microfrontends group
  • networkingCreateNetwork - Create a Secure Compute network
  • networkingCreatePrivateLinkEndpoint - Create a PrivateLink endpoint
  • networkingDeleteNetwork - Delete a Secure Compute network
  • networkingDeletePrivateLinkEndpoint - Delete a PrivateLink endpoint
  • networkingListNetworks - List Secure Compute networks
  • networkingListPrivateLinkEndpoints - List PrivateLink endpoints
  • networkingReadNetwork - Read a Secure Compute network
  • networkingReadPrivateLinkEndpoint - Read a PrivateLink endpoint
  • networkingUpdateNetwork - Update a Secure Compute network
  • networkingUpdatePrivateLinkEndpoint - Update a PrivateLink endpoint
  • networkingUpdateStaticIps - Configures Static IPs for a project
  • networkingUpdateStaticIps - Configures Static IPs for a project
  • observabilityGetObservabilityConfigurationProjects - Lists disabled Observability Plus projects
  • observabilityUpdateObservabilityConfigurationProject - Updates a disabled Observability Plus project setting
  • organizationsCreateOrganization - Create an Organization
  • organizationsGetOrganization - Get an Organization
  • organizationsListOrganizations - List Organizations
  • organizationsListOrganizationTeams - List Organization Teams
  • organizationsRemoveOrganizationTeam - Delete Team from Organization
  • organizationsUpdateOrganization - Update an Organization
  • projectMembersAddProjectMember - Adds a new member to a project.
  • projectMembersGetProjectMembers - List project members
  • projectMembersRemoveProjectMember - Remove a Project Member
  • projectRoutesAddRoute - Add a routing rule
  • projectRoutesDeleteRoutes - Delete routing rules
  • projectRoutesEditRoute - Edit a routing rule
  • projectRoutesGenerateRoute - Generate a routing rule from natural language
  • projectRoutesGetRoutes - Get project routing rules
  • projectRoutesGetRouteVersions - Get routing rule version history
  • projectRoutesStageRoutes - Stage routing rules
  • projectRoutesUpdateRouteVersions - Promote, restore, or discard a routing rule version
  • projectsAcceptProjectTransferRequest - Accept project transfer request
  • projectsAddProjectDomain - Add a domain to a project
  • projectsBatchRemoveProjectEnv - Batch remove environment variables
  • projectsCreateProject - Create a new project
  • projectsCreateProjectEnv - Create one or more environment variables
  • projectsCreateProjectTransferRequest - Create project transfer request
  • projectsCreateTraceSession - Create a trace session token for a deployment
  • projectsDeleteProject - Delete a Project
  • projectsDeleteProjectAvatar - Delete a project avatar
  • projectsEditProjectEnv - Edit an environment variable
  • projectsFilterProjectEnvs - Retrieve the environment variables of a project by id or name
  • projectsGetProject - Find a project by id or name
  • projectsGetProjectDomain - Get a project domain
  • projectsGetProjectDomains - Retrieve project domains by project by id or name
  • projectsGetProjectEnv - Retrieve the decrypted value of an environment variable of a project by id
  • projectsGetProjects - Retrieve a list of projects
  • projectsGetProjectToken - Generate a project OIDC token
  • projectsGetProjectTrace - Get a project trace by request ID
  • projectsListPromoteAliases - Gets a list of aliases with status for the current promote
  • projectsMoveProjectDomain - Move a project domain
  • projectsPauseProject - Pause a project
  • projectsRemoveProjectDomain - Remove a domain from a project
  • projectsRemoveProjectEnv - Remove an environment variable
  • projectsRequestPromote - Point production traffic to a given deployment
  • projectsRequestRollback - Point production traffic to a previous production deployment by ID
  • projectsUnpauseProject - Unpause a project
  • projectsUpdateMicrofrontends - Update the microfrontends settings
  • projectsUpdateProject - Update an existing project
  • projectsUpdateProjectDomain - Update a project domain
  • projectsUpdateProjectProtectionBypass - Update Protection Bypass for Automation
  • projectsUpdateProjectsByProjectIdRollbackByDeploymentIdUpdateDescription - Updates the description for a rollback
  • projectsUploadProjectAvatar - Upload a project avatar
  • projectsVerifyProjectDomain - Verify project domain
  • replaceDomainsByDomainRecords
  • rollingReleaseApproveRollingReleaseStage - Update the active rolling release to the next stage for a project
  • rollingReleaseCompleteRollingRelease - Complete the rolling release for the project
  • rollingReleaseDeleteRollingReleaseConfig - Delete rolling release configuration
  • rollingReleaseGetRollingRelease - Get the active rolling release information for a project
  • rollingReleaseGetRollingReleaseBillingStatus - Get rolling release billing status
  • rollingReleaseGetRollingReleaseConfig - Get rolling release configuration
  • rollingReleaseStartRollingRelease - Start a rolling release for the project
  • rollingReleaseUpdateRollingReleaseConfig - Update the rolling release settings for the project
  • sandboxesCreateSandboxesSessionsBySessionIdSnapshotV2 - Create a snapshot
  • sandboxesCreateSandboxesSessionsBySessionIdSnapshotV3 - Create a snapshot
  • sandboxesCreateSessionDirectory - Create a directory
  • sandboxesDeleteSandbox - Delete a sandbox
  • sandboxesDeleteSessionSnapshot - Delete a snapshot
  • sandboxesExtendSessionTimeout - Extend session timeout
  • sandboxesGetNamedSandbox - Get a named sandbox
  • sandboxesGetSession - Get a session
  • sandboxesGetSessionCommand - Get a command
  • sandboxesGetSessionSnapshot - Get a snapshot
  • sandboxesKillSessionCommand - Kill a command
  • sandboxesListNamedSandboxes - List sandboxes
  • sandboxesListSessionCommands - List commands
  • sandboxesListSessions - List sessions
  • sandboxesListSessionSnapshots - List snapshots
  • sandboxesReadSessionFile - Read a file
  • sandboxesStopSession - Stop a session
  • sandboxesUpdateSessionNetworkPolicy - Update network policy
  • sandboxesWriteSessionCommandStdin - Write to command stdin
  • sandboxesWriteSessionFiles - Write files
  • securityAddBypassIp - Create System Bypass Rule
  • securityCreateConditionalBypass - Create conditional firewall bypass
  • securityCreateSecurityFirewallConfigByConfigVersionActivate - Returns activated WAF config
  • securityDeleteConditionalBypass - Delete conditional firewall bypass
  • securityDeleteSecurityFirewallConfigByConfigVersion - Returns activated WAF config
  • securityGenerateFirewallRule - Generate a firewall rule from natural language
  • securityGetActiveAttackStatus - Read active attack data
  • securityGetBypassIp - Read System Bypass
  • securityGetConditionalBypass - Get conditional firewall bypasses
  • securityGetFirewallConfig - Read Firewall Configuration
  • securityGetSecurityFirewallConfig - Returns activated WAF config
  • securityGetSecurityFirewallEvents - Read Firewall Actions by Project
  • securityGetSecurityFirewallEventsSummary - Read Firewall Actions Summary by Project
  • securityPutFirewallConfig - Put Firewall Configuration
  • securityRemoveBypassIp - Remove System Bypass Rule
  • securityUpdateAttackChallengeMode - Update Attack Challenge mode
  • securityUpdateConditionalBypass - Update conditional firewall bypass
  • securityUpdateFirewallConfig - Update Firewall Configuration
  • storageCreateStorageStoresBlob - Create a Blob store
  • storageDeleteStorageStoresBlobById - Delete a Blob store
  • storageGetStorageStoresById - Get a store
  • teamsCreateTeam - Create a Team
  • teamsDeleteMicrofrontendsGroup - Delete a microfrontends group
  • teamsDeleteTeam - Delete a Team
  • teamsDeleteTeamInviteCode - Delete a Team invite code
  • teamsGetTeam - Get a Team
  • teamsGetTeamAccessRequest - Get access request status
  • teamsGetTeamMembers - List team members
  • teamsGetTeams - List all teams
  • teamsInviteUserToTeam - Invite a user
  • teamsJoinTeam - Join a team
  • teamsPatchTeam - Update a Team
  • teamsPostTeamDsyncRoles - Update Team Directory Sync Role Mappings
  • teamsRemoveTeamMember - Remove a Team Member
  • teamsRequestAccessToTeam - Request access to a team
  • teamsUpdateMicrofrontendsGroup - Update a microfrontends group
  • teamsUpdateTeamMember - Update a Team Member
  • userGetAuthUser - Get the User
  • userListEventTypes - List Event Types
  • userListUserEvents - List User Events
  • userRequestDelete - Delete User Account
  • vcrAddRepositoryPermission - Add a repository permission
  • vcrClearRepositoryPermissions - Clear all repository permissions
  • vcrCreateByTeamSlugByProjectSlugByRepositoryNameBlobsUploads - Start a blob upload
  • vcrCreateRepository - Create a repository
  • vcrDeleteByTeamSlugByProjectSlugByRepositoryNameBlobsByDigest - Delete a blob
  • vcrDeleteByTeamSlugByProjectSlugByRepositoryNameBlobsUploadsByUuid - Cancel a blob upload
  • vcrDeleteByTeamSlugByProjectSlugByRepositoryNameManifestsByReference - Delete an image manifest
  • vcrDeleteRepository - Delete a repository
  • vcrDeleteRepositoryImage - Delete a repository image
  • vcrGetByTeamSlugByProjectSlugByRepositoryNameBlobsByDigest - Download a blob
  • vcrGetByTeamSlugByProjectSlugByRepositoryNameBlobsUploadsByUuid - Get blob upload status
  • vcrGetByTeamSlugByProjectSlugByRepositoryNameManifestsByReference - Pull an image manifest
  • vcrGetByTeamSlugByProjectSlugByRepositoryNameTagsList - List image tags
  • vcrGetRepository - Get a repository
  • vcrGetRepositoryImage - Get a repository image
  • vcrGetRepositoryTag - Get a repository tag
  • vcrGetRoot - Check registry API version support
  • vcrHeadByTeamSlugByProjectSlugByRepositoryNameBlobsByDigest - Check if a blob exists
  • vcrHeadByTeamSlugByProjectSlugByRepositoryNameManifestsByReference - Check if a manifest exists
  • vcrListRepositories - List repositories
  • vcrListRepositoryImages - List repository images
  • vcrListRepositoryPermissions - List repository permissions
  • vcrListRepositoryTags - List repository tags
  • vcrRemoveRepositoryPermission - Remove a repository permission
  • vcrReplaceByTeamSlugByProjectSlugByRepositoryNameBlobsUploadsByUuid - Complete a blob upload
  • vcrReplaceByTeamSlugByProjectSlugByRepositoryNameManifestsByReference - Push an image manifest
  • vcrUpdateByTeamSlugByProjectSlugByRepositoryNameBlobsUploadsByUuid - Upload a blob chunk
  • vercelCiCreateVercelCiTaskAnalysis - Start an asynchronous Vercel CI task analysis
  • vercelCiCreateVercelCiTaskConfigurationPullRequest - Create a GitHub pull request that adds Vercel CI tags for the completed analysis
  • vercelCiGetVercelCiInvocation - Get a specific invocation attempt
  • vercelCiGetVercelCiInvocationLogs - Get log lines for an invocation attempt
  • vercelCiGetVercelCiInvocationTree - Get an invocation with its jobs and tasks
  • vercelCiGetVercelCiJobDefinition - Get a specific job definition
  • vercelCiGetVercelCiJobRun - Get a specific job run attempt
  • vercelCiGetVercelCiJobRunLogs - Get log lines for a specific job run attempt
  • vercelCiGetVercelCiRepositorySettings - Get Vercel CI settings for a connected repository
  • vercelCiGetVercelCiTaskAnalysis - Get the current status of a Vercel CI task analysis
  • vercelCiGetVercelCiTaskLogs - Get log lines for the tasks of an invocation attempt
  • vercelCiGetVercelCiTaskRunLogs - Get log lines for a specific task run attempt
  • vercelCiListVercelCiBranches - List Vercel CI branch suggestions for a team
  • vercelCiListVercelCiInvocationAttempts - List all attempts for an invocation
  • vercelCiListVercelCiInvocations - List invocations for a team, optionally filtered by repository and invocation metadata
  • vercelCiListVercelCiJobDefinitions - List job definitions for an invocation attempt
  • vercelCiListVercelCiJobRuns - List all runs for a job definition
  • vercelCiListVercelCiTaskAnalysisTasks - List discovered tasks for a completed Vercel CI task analysis
  • vercelCiListVercelCiTaskDefinitions - List all task definitions for a job run
  • vercelCiListVercelCiTaskRuns - List task runs for a job run
  • vercelCiRetryVercelCiInvocation - Retry a terminal Vercel CI invocation attempt
  • vercelCiSearchVercelCiLogs - Search the task logs of several invocation attempts
  • vercelCiUpdateVercelCiRepositorySettings - Enable or disable Vercel CI for a connected repository
  • webAnalyticsAggregateEvents - Aggregates custom events
  • webAnalyticsAggregatePageviews - Aggregates page views
  • webAnalyticsCountEvents - Counts custom events
  • webAnalyticsCountPageviews - Counts page views
  • webhooksCreateWebhook - Creates a webhook
  • webhooksDeleteWebhook - Deletes a webhook
  • webhooksGetWebhook - Get a webhook
  • webhooksGetWebhooks - Get a list of webhooks
  • checksCreateCheck - Creates a new Check ⚠️ Deprecated
  • checksGetAllChecks - Retrieve a list of all checks ⚠️ Deprecated
  • checksGetCheck - Get a single check ⚠️ Deprecated
  • checksRerequestCheck - Rerequest a check ⚠️ Deprecated
  • checksUpdateCheck - Update a check ⚠️ Deprecated
  • marketplaceUpdateResourceSecrets - Deprecated: true. Update Resource Secrets (Deprecated) ⚠️ Deprecated
  • sandboxesDeleteDrive - Deprecated: Use DELETE /v1/drives/:name. Requires the read-write:drive app scope instead of read-write:sandbox, and drive:delete instead of vercelRun:delete. Emits drive-deleted activity events instead of sandbox-drive-deleted. Delete a drive ⚠️ Deprecated
  • sandboxesForkDrive - Deprecated: Use POST /v1/drives/:name/fork. Requires the read-write:drive app scope instead of read-write:sandbox, and drive:read and drive:create instead of vercelRun:read and vercelRun:create. Emits drive-created activity events instead of sandbox-drive-created. Fork a drive ⚠️ Deprecated
  • sandboxesGetDrive - Deprecated: Use GET /v1/drives/:nameOrId. Requires the read:drive app scope instead of read:sandbox, and drive:read instead of vercelRun:read. Get a drive ⚠️ Deprecated
  • sandboxesGetOrCreateDrive - Deprecated: Use POST /v1/drives/:name. Requires the read-write:drive app scope instead of read-write:sandbox, and drive:create instead of vercelRun:create. Emits drive-created activity events instead of sandbox-drive-created. Get or create a drive ⚠️ Deprecated
  • sandboxesListDrives - Deprecated: Use GET /v1/drives. Requires the read:drive app scope instead of read:sandbox, and drive:list instead of vercelRun:read. List drives ⚠️ Deprecated

File uploads

Certain SDK methods accept files as part of a multi-part request. It is possible and typically recommended to upload files as a stream rather than reading the entire contents into memory. This avoids excessive memory consumption and potentially crashing with out-of-memory errors when working with very large files. The following example demonstrates how to attach a file stream to a request.

Tip

Depending on your JavaScript runtime, there are convenient utilities that return a handle to a file without reading the entire contents into memory:

  • Node.js v20+: Since v20, Node.js comes with a native openAsBlob function in node:fs.
  • Bun: The native Bun.file function produces a file handle that can be used for streaming file uploads.
  • Browsers: All supported browsers return an instance to a File when reading the value from an <input type="file"> element.
  • Node.js v18: A file stream can be created using the fileFrom helper from fetch-blob/from.js.
import { Vercel } from "@vercel/sdk";
import { openAsBlob } from "node:fs";

const vercel = new Vercel({
  bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const result = await vercel.artifacts.uploadArtifact({
    contentLength: 3848.22,
    xArtifactDuration: 400,
    xArtifactClientCi: "VERCEL",
    xArtifactClientInteractive: 0,
    xArtifactTag: "Tc0BmHvJYMIYJ62/zx87YqO0Flxk+5Ovip25NY825CQ=",
    hash: "12HKQaOmR5t5Uy6vdcQsNIiZgHGB",
    teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
    slug: "my-team-url-slug",
    requestBody: await openAsBlob("example.file"),
  });

  console.log(result);
}

run();

Retries

Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.

To change the default retry strategy for a single API call, simply provide a retryConfig object to the call:

import { Vercel } from "@vercel/sdk";

const vercel = new Vercel();

async function run() {
  const result = await vercel.replaceDomainsByDomainRecords({
    domain: "example.com",
    teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
    slug: "my-team-url-slug",
  }, {
    retries: {
      strategy: "backoff",
      backoff: {
        initialInterval: 1,
        maxInterval: 50,
        exponent: 1.1,
        maxElapsedTime: 100,
      },
      retryConnectionErrors: false,
    },
  });

  console.log(result);
}

run();

If you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization:

import { Vercel } from "@vercel/sdk";

const vercel = new Vercel({
  retryConfig: {
    strategy: "backoff",
    backoff: {
      initialInterval: 1,
      maxInterval: 50,
      exponent: 1.1,
      maxElapsedTime: 100,
    },
    retryConnectionErrors: false,
  },
});

async function run() {
  const result = await vercel.replaceDomainsByDomainRecords({
    domain: "example.com",
    teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
    slug: "my-team-url-slug",
  });

  console.log(result);
}

run();

Error Handling

VercelError is the base class for all HTTP error responses. It has the following properties:

Property Type Description
error.message string Error message
error.statusCode number HTTP response status code eg 404
error.headers Headers HTTP response headers
error.body string HTTP body. Can be empty string if no body is returned.
error.rawResponse Response Raw HTTP response
error.data$ Optional. Some errors may contain structured data. See Error Classes.

Example

import { Vercel } from "@vercel/sdk";
import { CreateApiKeysResponseResponseBody } from "@vercel/sdk/models/createapikeysop.js";
import { VercelError } from "@vercel/sdk/models/vercelerror.js.js";

const vercel = new Vercel();

async function run() {
  try {
    const result = await vercel.createApiKeys({
      purpose: "<value>",
      projectId: "prj_12HKQaOmR5t5Uy6vdcQsNIiZgHGB",
      name: "API Key for App 123",
    });

    console.log(result);
  } catch (error) {
    // The base class for HTTP error responses
    if (error instanceof VercelError) {
      console.log(error.message);
      console.log(error.statusCode);
      console.log(error.body);
      console.log(error.headers);

      // Depending on the method different errors may be thrown
      if (error instanceof CreateApiKeysResponseResponseBody) {
        console.log(error.data$.error); // models.CreateApiKeysError
      }
    }
  }
}

run();

Error Classes

Primary error:

  • VercelError: The base class for HTTP error responses.
Less common errors (134)

Network errors:

  • ConnectionError: HTTP client was unable to make a request to a server.
  • RequestTimeoutError: HTTP request timed out due to an AbortSignal signal.
  • RequestAbortedError: HTTP request was aborted by the client.
  • InvalidRequestError: Any input used to create a request is invalid.
  • UnexpectedClientError: Unrecognised or unexpected error.

Inherit from VercelError:

  • HttpApiDecodeError: The request did not match the expected schema. Status code 400. Applicable to 19 of 476 methods.*
  • Unauthorized: Unauthorized. Status code 401. Applicable to 19 of 476 methods.*
  • NotAuthorizedForScope: Status code 403. Applicable to 19 of 476 methods.*
  • TooManyRequests: TooManyRequests. Status code 429. Applicable to 19 of 476 methods.*
  • InternalServerError: InternalServerError. Status code 500. Applicable to 19 of 476 methods.*
  • ConnectError: Error response returned by a Connect API operation. Applicable to 10 of 476 methods.*
  • Forbidden: Status code 403. Applicable to 10 of 476 methods.*
  • TldNotSupported: The TLD is not currently supported. Status code 400. Applicable to 8 of 476 methods.*
  • DomainTooShort: The domain name (excluding the TLD) is too short. Status code 400. Applicable to 6 of 476 methods.*
  • BadRequest: There was something wrong with the request. Status code 400. Applicable to 5 of 476 methods.*
  • DomainNotRegistered: The domain is not registered with Vercel. Status code 400. Applicable to 5 of 476 methods.*
  • DomainNotFound: The domain was not found in our system. Status code 404. Applicable to 5 of 476 methods.*
  • ExpectedPriceMismatch: The expected price passed does not match the actual price. Status code 400. Applicable to 4 of 476 methods.*
  • DomainNotAvailable: The domain is not available. Status code 400. Applicable to 4 of 476 methods.*
  • NotFound: NotFound. Status code 404. Applicable to 3 of 476 methods.*
  • OrderTooExpensive: The total price of the order is too high. Status code 400. Applicable to 2 of 476 methods.*
  • InvalidAdditionalContactInfo: Additional contact information provided for the TLD is invalid. Status code 400. Applicable to 2 of 476 methods.*
  • AdditionalContactInfoRequired: Additional contact information is required for the TLD. Status code 400. Applicable to 2 of 476 methods.*
  • EmojiTldNotSupported: The TLD does not support emoji domain names. Status code 400. Applicable to 2 of 476 methods.*
  • LanguageCodeRequired: A language code is required for punycode domains. Status code 400. Applicable to 2 of 476 methods.*
  • TooManyDomains: The number of domains in the order is too high. Status code 400. Applicable to 1 of 476 methods.*
  • DuplicateDomains: Duplicate domains were provided. Status code 400. Applicable to 1 of 476 methods.*
  • DomainAlreadyOwned: The domain is already owned by another team or user. Status code 400. Applicable to 1 of 476 methods.*
  • DNSSECEnabled: The operation cannot be completed because DNSSEC is enabled for the domain. Status code 400. Applicable to 1 of 476 methods.*
  • DomainAlreadyRenewing: The domain is already renewing. Status code 400. Applicable to 1 of 476 methods.*
  • DomainNotRenewable: The domain is not renewable. Status code 400. Applicable to 1 of 476 methods.*
  • BoughtTooRecently: The domain was bought too recently to determine verification status. Status code 400. Applicable to 1 of 476 methods.*
  • CreateApiKeysResponseResponseBody: The request is not authorized. Status code 401. Applicable to 1 of 476 methods.*
  • UpdateApiKeyQuotaAiGatewayResponseBody: The request is not authorized. Status code 401. Applicable to 1 of 476 methods.*
  • GetVercelCiRepositorySettingsVercelCiResponseBody: The request is not authorized. Status code 401. Applicable to 1 of 476 methods.*
  • UpdateVercelCiRepositorySettingsVercelCiResponseBody: The request is not authorized. Status code 401. Applicable to 1 of 476 methods.*
  • ListVercelCiInvocationsVercelCiResponseBody: The request is not authorized. Status code 401. Applicable to 1 of 476 methods.*
  • ListVercelCiBranchesVercelCiResponseBody: The request is not authorized. Status code 401. Applicable to 1 of 476 methods.*
  • CreateVercelCiTaskAnalysisVercelCiResponseBody: The request is not authorized. Status code 401. Applicable to 1 of 476 methods.*
  • GetVercelCiTaskAnalysisVercelCiResponseBody: The request is not authorized. Status code 401. Applicable to 1 of 476 methods.*
  • CreateVercelCiTaskConfigurationPullRequestVercelCiResponseBody: The request is not authorized. Status code 401. Applicable to 1 of 476 methods.*
  • ListVercelCiTaskAnalysisTasksVercelCiResponseBody: The request is not authorized. Status code 401. Applicable to 1 of 476 methods.*
  • ListVercelCiInvocationAttemptsVercelCiResponseBody: The request is not authorized. Status code 401. Applicable to 1 of 476 methods.*
  • GetVercelCiInvocationTreeVercelCiResponseBody: The request is not authorized. Status code 401. Applicable to 1 of 476 methods.*
  • GetVercelCiInvocationVercelCiResponseBody: The request is not authorized. Status code 401. Applicable to 1 of 476 methods.*
  • RetryVercelCiInvocationVercelCiResponseBody: The request is not authorized. Status code 401. Applicable to 1 of 476 methods.*
  • ListVercelCiJobDefinitionsVercelCiResponseBody: The request is not authorized. Status code 401. Applicable to 1 of 476 methods.*
  • GetVercelCiJobDefinitionVercelCiResponseBody: The request is not authorized. Status code 401. Applicable to 1 of 476 methods.*
  • ListVercelCiJobRunsVercelCiResponseBody: The request is not authorized. Status code 401. Applicable to 1 of 476 methods.*
  • GetVercelCiJobRunVercelCiResponseBody: The request is not authorized. Status code 401. Applicable to 1 of 476 methods.*
  • ListVercelCiTaskDefinitionsVercelCiResponseBody: The request is not authorized. Status code 401. Applicable to 1 of 476 methods.*
  • ListVercelCiTaskRunsVercelCiResponseBody: The request is not authorized. Status code 401. Applicable to 1 of 476 methods.*
  • GetVercelCiInvocationLogsVercelCiResponseBody: The request is not authorized. Status code 401. Applicable to 1 of 476 methods.*
  • GetVercelCiTaskLogsVercelCiResponseBody: The request is not authorized. Status code 401. Applicable to 1 of 476 methods.*
  • SearchVercelCiLogsVercelCiResponseBody: The request is not authorized. Status code 401. Applicable to 1 of 476 methods.*
  • GetVercelCiJobRunLogsVercelCiResponseBody: The request is not authorized. Status code 401. Applicable to 1 of 476 methods.*
  • GetVercelCiTaskRunLogsVercelCiResponseBody: The request is not authorized. Status code 401. Applicable to 1 of 476 methods.*
  • CreateApiKeysResponse403ResponseBody: You do not have permission to access this resource. Status code 403. Applicable to 1 of 476 methods.*
  • UpdateApiKeyQuotaAiGatewayResponseResponseBody: You do not have permission to access this resource. Status code 403. Applicable to 1 of 476 methods.*
  • GetVercelCiRepositorySettingsVercelCiResponseResponseBody: You do not have permission to access this resource. Status code 403. Applicable to 1 of 476 methods.*
  • UpdateVercelCiRepositorySettingsVercelCiResponseResponseBody: You do not have permission to access this resource. Status code 403. Applicable to 1 of 476 methods.*
  • ListVercelCiInvocationsVercelCiResponseResponseBody: You do not have permission to access this resource. Status code 403. Applicable to 1 of 476 methods.*
  • ListVercelCiBranchesVercelCiResponseResponseBody: You do not have permission to access this resource. Status code 403. Applicable to 1 of 476 methods.*
  • CreateVercelCiTaskAnalysisVercelCiResponseResponseBody: You do not have permission to access this resource. Status code 403. Applicable to 1 of 476 methods.*
  • GetVercelCiTaskAnalysisVercelCiResponseResponseBody: You do not have permission to access this resource. Status code 403. Applicable to 1 of 476 methods.*
  • CreateVercelCiTaskConfigurationPullRequestVercelCiResponseResponseBody: You do not have permission to access this resource. Status code 403. Applicable to 1 of 476 methods.*
  • ListVercelCiTaskAnalysisTasksVercelCiResponseResponseBody: You do not have permission to access this resource. Status code 403. Applicable to 1 of 476 methods.*
  • ListVercelCiInvocationAttemptsVercelCiResponseResponseBody: You do not have permission to access this resource. Status code 403. Applicable to 1 of 476 methods.*
  • GetVercelCiInvocationTreeVercelCiResponseResponseBody: You do not have permission to access this resource. Status code 403. Applicable to 1 of 476 methods.*
  • GetVercelCiInvocationVercelCiResponseResponseBody: You do not have permission to access this resource. Status code 403. Applicable to 1 of 476 methods.*
  • RetryVercelCiInvocationVercelCiResponseResponseBody: You do not have permission to access this resource. Status code 403. Applicable to 1 of 476 methods.*
  • ListVercelCiJobDefinitionsVercelCiResponseResponseBody: You do not have permission to access this resource. Status code 403. Applicable to 1 of 476 methods.*
  • GetVercelCiJobDefinitionVercelCiResponseResponseBody: You do not have permission to access this resource. Status code 403. Applicable to 1 of 476 methods.*
  • ListVercelCiJobRunsVercelCiResponseResponseBody: You do not have permission to access this resource. Status code 403. Applicable to 1 of 476 methods.*
  • GetVercelCiJobRunVercelCiResponseResponseBody: You do not have permission to access this resource. Status code 403. Applicable to 1 of 476 methods.*
  • ListVercelCiTaskDefinitionsVercelCiResponseResponseBody: You do not have permission to access this resource. Status code 403. Applicable to 1 of 476 methods.*
  • ListVercelCiTaskRunsVercelCiResponseResponseBody: You do not have permission to access this resource. Status code 403. Applicable to 1 of 476 methods.*
  • GetVercelCiInvocationLogsVercelCiResponseResponseBody: You do not have permission to access this resource. Status code 403. Applicable to 1 of 476 methods.*
  • GetVercelCiTaskLogsVercelCiResponseResponseBody: You do not have permission to access this resource. Status code 403. Applicable to 1 of 476 methods.*
  • SearchVercelCiLogsVercelCiResponseResponseBody: You do not have permission to access this resource. Status code 403. Applicable to 1 of 476 methods.*
  • GetVercelCiJobRunLogsVercelCiResponseResponseBody: You do not have permission to access this resource. Status code 403. Applicable to 1 of 476 methods.*
  • GetVercelCiTaskRunLogsVercelCiResponseResponseBody: You do not have permission to access this resource. Status code 403. Applicable to 1 of 476 methods.*
  • DomainCannotBeTransferedOutUntil: The domain cannot be transfered out until the specified date. Status code 409. Applicable to 1 of 476 methods.*
  • CreateApiKeysResponse429ResponseBody: . Status code 429. Applicable to 1 of 476 methods.*
  • UpdateApiKeyQuotaAiGatewayResponse429ResponseBody: . Status code 429. Applicable to 1 of 476 methods.*
  • GetVercelCiRepositorySettingsVercelCiResponse429ResponseBody: . Status code 429. Applicable to 1 of 476 methods.*
  • UpdateVercelCiRepositorySettingsVercelCiResponse429ResponseBody: . Status code 429. Applicable to 1 of 476 methods.*
  • ListVercelCiInvocationsVercelCiResponse429ResponseBody: . Status code 429. Applicable to 1 of 476 methods.*
  • ListVercelCiBranchesVercelCiResponse429ResponseBody: . Status code 429. Applicable to 1 of 476 methods.*
  • CreateVercelCiTaskAnalysisVercelCiResponse429ResponseBody: . Status code 429. Applicable to 1 of 476 methods.*
  • GetVercelCiTaskAnalysisVercelCiResponse429ResponseBody: . Status code 429. Applicable to 1 of 476 methods.*
  • CreateVercelCiTaskConfigurationPullRequestVercelCiResponse429ResponseBody: . Status code 429. Applicable to 1 of 476 methods.*
  • ListVercelCiTaskAnalysisTasksVercelCiResponse429ResponseBody: . Status code 429. Applicable to 1 of 476 methods.*
  • ListVercelCiInvocationAttemptsVercelCiResponse429ResponseBody: . Status code 429. Applicable to 1 of 476 methods.*
  • GetVercelCiInvocationTreeVercelCiResponse429ResponseBody: . Status code 429. Applicable to 1 of 476 methods.*
  • GetVercelCiInvocationVercelCiResponse429ResponseBody: . Status code 429. Applicable to 1 of 476 methods.*
  • RetryVercelCiInvocationVercelCiResponse429ResponseBody: . Status code 429. Applicable to 1 of 476 methods.*
  • ListVercelCiJobDefinitionsVercelCiResponse429ResponseBody: . Status code 429. Applicable to 1 of 476 methods.*
  • GetVercelCiJobDefinitionVercelCiResponse429ResponseBody: . Status code 429. Applicable to 1 of 476 methods.*
  • ListVercelCiJobRunsVercelCiResponse429ResponseBody: . Status code 429. Applicable to 1 of 476 methods.*
  • GetVercelCiJobRunVercelCiResponse429ResponseBody: . Status code 429. Applicable to 1 of 476 methods.*
  • ListVercelCiTaskDefinitionsVercelCiResponse429ResponseBody: . Status code 429. Applicable to 1 of 476 methods.*
  • ListVercelCiTaskRunsVercelCiResponse429ResponseBody: . Status code 429. Applicable to 1 of 476 methods.*
  • GetVercelCiInvocationLogsVercelCiResponse429ResponseBody: . Status code 429. Applicable to 1 of 476 methods.*
  • GetVercelCiTaskLogsVercelCiResponse429ResponseBody: . Status code 429. Applicable to 1 of 476 methods.*
  • SearchVercelCiLogsVercelCiResponse429ResponseBody: . Status code 429. Applicable to 1 of 476 methods.*
  • GetVercelCiJobRunLogsVercelCiResponse429ResponseBody: . Status code 429. Applicable to 1 of 476 methods.*
  • GetVercelCiTaskRunLogsVercelCiResponse429ResponseBody: . Status code 429. Applicable to 1 of 476 methods.*
  • CreateApiKeysResponse500ResponseBody: . Status code 500. Applicable to 1 of 476 methods.*
  • UpdateApiKeyQuotaAiGatewayResponse500ResponseBody: . Status code 500. Applicable to 1 of 476 methods.*
  • GetVercelCiRepositorySettingsVercelCiResponse500ResponseBody: . Status code 500. Applicable to 1 of 476 methods.*
  • UpdateVercelCiRepositorySettingsVercelCiResponse500ResponseBody: . Status code 500. Applicable to 1 of 476 methods.*
  • ListVercelCiInvocationsVercelCiResponse500ResponseBody: . Status code 500. Applicable to 1 of 476 methods.*
  • ListVercelCiBranchesVercelCiResponse500ResponseBody: . Status code 500. Applicable to 1 of 476 methods.*
  • CreateVercelCiTaskAnalysisVercelCiResponse500ResponseBody: . Status code 500. Applicable to 1 of 476 methods.*
  • GetVercelCiTaskAnalysisVercelCiResponse500ResponseBody: . Status code 500. Applicable to 1 of 476 methods.*
  • CreateVercelCiTaskConfigurationPullRequestVercelCiResponse500ResponseBody: . Status code 500. Applicable to 1 of 476 methods.*
  • ListVercelCiTaskAnalysisTasksVercelCiResponse500ResponseBody: . Status code 500. Applicable to 1 of 476 methods.*
  • ListVercelCiInvocationAttemptsVercelCiResponse500ResponseBody: . Status code 500. Applicable to 1 of 476 methods.*
  • GetVercelCiInvocationTreeVercelCiResponse500ResponseBody: . Status code 500. Applicable to 1 of 476 methods.*
  • GetVercelCiInvocationVercelCiResponse500ResponseBody: . Status code 500. Applicable to 1 of 476 methods.*
  • RetryVercelCiInvocationVercelCiResponse500ResponseBody: . Status code 500. Applicable to 1 of 476 methods.*
  • ListVercelCiJobDefinitionsVercelCiResponse500ResponseBody: . Status code 500. Applicable to 1 of 476 methods.*
  • GetVercelCiJobDefinitionVercelCiResponse500ResponseBody: . Status code 500. Applicable to 1 of 476 methods.*
  • ListVercelCiJobRunsVercelCiResponse500ResponseBody: . Status code 500. Applicable to 1 of 476 methods.*
  • GetVercelCiJobRunVercelCiResponse500ResponseBody: . Status code 500. Applicable to 1 of 476 methods.*
  • ListVercelCiTaskDefinitionsVercelCiResponse500ResponseBody: . Status code 500. Applicable to 1 of 476 methods.*
  • ListVercelCiTaskRunsVercelCiResponse500ResponseBody: . Status code 500. Applicable to 1 of 476 methods.*
  • GetVercelCiInvocationLogsVercelCiResponse500ResponseBody: . Status code 500. Applicable to 1 of 476 methods.*
  • GetVercelCiTaskLogsVercelCiResponse500ResponseBody: . Status code 500. Applicable to 1 of 476 methods.*
  • SearchVercelCiLogsVercelCiResponse500ResponseBody: . Status code 500. Applicable to 1 of 476 methods.*
  • GetVercelCiJobRunLogsVercelCiResponse500ResponseBody: . Status code 500. Applicable to 1 of 476 methods.*
  • GetVercelCiTaskRunLogsVercelCiResponse500ResponseBody: . Status code 500. Applicable to 1 of 476 methods.*
  • ResponseValidationError: Type mismatch between the data returned from the server and the structure expected by the SDK. See error.rawValue for the raw value and error.pretty() for a nicely formatted multi-line string.

* Check the method documentation to see if the error is applicable.

Server Selection

Override Server URL Per-Client

The default server can be overridden globally by passing a URL to the serverURL: string optional parameter when initializing the SDK client instance. For example:

import { Vercel } from "@vercel/sdk";

const vercel = new Vercel({
  serverURL: "https://api.vercel.com",
});

async function run() {
  const result = await vercel.replaceDomainsByDomainRecords({
    domain: "example.com",
    teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
    slug: "my-team-url-slug",
  });

  console.log(result);
}

run();

Custom HTTP Client

The TypeScript SDK makes API calls using an HTTPClient that wraps the native Fetch API. This client is a thin wrapper around fetch and provides the ability to attach hooks around the request lifecycle that can be used to modify the request or handle errors and response.

The HTTPClient constructor takes an optional fetcher argument that can be used to integrate a third-party HTTP client or when writing tests to mock out the HTTP client and feed in fixtures.

The following example shows how to:

  • route requests through a proxy server using undici's ProxyAgent
  • use the "beforeRequest" hook to add a custom header and a timeout to requests
  • use the "requestError" hook to log errors
import { Vercel } from "@vercel/sdk";
import { ProxyAgent } from "undici";
import { HTTPClient } from "@vercel/sdk/lib/http";

const dispatcher = new ProxyAgent("http://proxy.example.com:8080");

const httpClient = new HTTPClient({
  // 'fetcher' takes a function that has the same signature as native 'fetch'.
  fetcher: (input, init) =>
    // 'dispatcher' is specific to undici and not part of the standard Fetch API.
    fetch(input, { ...init, dispatcher } as RequestInit),
});

httpClient.addHook("beforeRequest", (request) => {
  const nextRequest = new Request(request, {
    signal: request.signal || AbortSignal.timeout(5000)
  });

  nextRequest.headers.set("x-custom-header", "custom value");

  return nextRequest;
});

httpClient.addHook("requestError", (error, request) => {
  console.group("Request Error");
  console.log("Reason:", `${error}`);
  console.log("Endpoint:", `${request.method} ${request.url}`);
  console.groupEnd();
});

const sdk = new Vercel({ httpClient: httpClient });

Debugging

You can setup your SDK to emit debug logs for SDK requests and responses.

You can pass a logger that matches console's interface as an SDK option.

Warning

Beware that debug logging will reveal secrets, like API tokens in headers, in log messages printed to a console or files. It's recommended to use this feature only during local development and not in production.

import { Vercel } from "@vercel/sdk";

const sdk = new Vercel({ debugLogger: console });

Development

Maturity

This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.

Contributions

While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation. We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.

SDK Created by Speakeasy

About

Vercel SDK is a type-safe Typescript SDK that gives you access to the Vercel REST API.

Resources

Readme
Apache-2.0 license

Code of conduct

Code of conduct

Contributing

Contributing

Security policy

Security policy
Activity
Custom properties

Stars

166 stars

Watchers

5 watching

Forks

46 forks
Report repository

Releases

Packages

Used by

Contributors

Languages

You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.