Vercel

Develop. Preview. Ship.

@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.

* @vercel/sdk
* SDK Installation
* Requirements
* Access Tokens
* Authentication
* SDK Example Usage
* Available Resources and Operations
* Standalone functions
* Json Streaming
* 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.

$3

``bash npm add @vercel/sdk`

`$3`

`bash pnpm add @vercel/sdk`

`$3`

`bash bun add @vercel/sdk`

`$3`

`bash yarn add @vercel/sdk`

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

`$3`

This SDK is also an installable MCP server where the various SDK methods are exposed as tools that can be invoked by AI applications.

> Node.js v20 or greater is required to run the MCP server from npm.


Claude installation steps

Add the following server definition to your claude_desktop_config.json file:

`json { "mcpServers": { "Vercel": { "command": "npx", "args": [ "-y", "--package", "@vercel/sdk", "--", "mcp", "start", "--bearer-token", "..." ] } } }`


Cursor installation steps

Create a .cursor/mcp.json file in your project root with the following content:

`json { "mcpServers": { "Vercel": { "command": "npx", "args": [ "-y", "--package", "@vercel/sdk", "--", "mcp", "start", "--bearer-token", "..." ] } } }`

You can also run MCP servers as a standalone binary with no additional dependencies. You must pull these binaries from available Github releases:

`bash curl -L -o mcp-server \ https://github.com/{org}/{repo}/releases/download/{tag}/mcp-server-bun-darwin-arm64 && \ chmod +x mcp-server`

If the repo is a private repo you must add your Github PAT to download a release -H "Authorization: Bearer {GITHUB_PAT}".

`json { "mcpServers": { "Todos": { "command": "./DOWNLOAD/PATH/mcp-server", "args": [ "start" ] } } }`

For a full list of server arguments, run:

`sh npx -y --package @vercel/sdk -- mcp start --help`

`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`

`$3`

This SDK supports the following security scheme globally:

| Name | Type | Scheme | | ------------- | ---- | ----------- | |bearerToken | http | HTTP Bearer |

To authenticate with the API the bearerTokenparameter must be set when initializing the SDK client instance. For example:`typescript import { Vercel } from "@vercel/sdk";

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

async function run() { await vercel.patchV1ProjectsProjectIdRollbackDeploymentIdUpdateDescription({ projectId: "", deploymentId: "", }); }

run();

`SDK Example Usage`

`$3`

List deployments under the authenticated user or team.

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

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

async function run() { const result = await vercel.deployments.getDeployments({ app: "docs", from: 1612948664566, limit: 10, projectId: "QmXGTs7mvAMMC7WW5ebrM33qKG32QK3h4vmQMjmY", projectIds: [ "prj_123", "prj_456", ], target: "production", to: 1612948664566, users: "kr1PsOIzqEL5Xg6M4VZcZosf,K4amb7K9dAt5R2vBJWF32bmY", since: 1540095775941, until: 1540095775951, state: "BUILDING,READY", teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l", slug: "my-team-url-slug", });

console.log(result); }

run();

`$3`

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

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

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

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", }, });

console.log(result); }

run();

`Available Resources and Operations`


Available methods
$3
* patchV1ProjectsProjectIdRollbackDeploymentIdUpdateDescription - Updates the description for a rollback
$3
* 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
$3
* 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
$3
* 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
$3
* exchangeSsoToken - SSO Token Exchange
* listAuthTokens - List Auth Tokens
* createAuthToken - Create an Auth Token
* getAuthToken - Get Auth Token Metadata
* deleteAuthToken - Delete an authentication token
$3
* listBillingCharges - List FOCUS billing charges
* listContractCommitments - List FOCUS contract commitments
$3
* 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.
$3
* getCertById - Get cert by id
* removeCert - Remove cert
* issueCert - Issue a new cert
* uploadCert - Upload a cert
$3
* createCheck - Creates a new Check
* getAllChecks - Retrieve a list of all checks
* getCheck - Get a single check
* updateCheck - Update a check
* rerequestCheck - Rerequest a check
$3
* 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
* updateStaticIps - Configures Static IPs for a project
$3
* 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
$3
* getRecords - List existing DNS records
* createRecord - Create a DNS record
* updateRecord - Update an existing DNS record
* removeRecord - Delete a DNS record
$3
* getDomainConfig - Get a Domain's configuration
* 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
$3
* getSupportedTlds - Get supported TLDs
* getTldPrice - Get TLD price data
* getDomainAvailability - Get availability for a domain
* getDomainPrice - Get price data for a domain
* getBulkAvailability - Get availability for multiple domains
* 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
* getContactInfoSchema - Get contact info schema
* getOrder - Get a domain order
$3
* 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
$3
* invalidateByTags - Invalidate by tag
* dangerouslyDeleteByTags - Dangerously delete by tag
* invalidateBySrcImages - Invalidate by source image
* dangerouslyDeleteBySrcImages - Dangerously delete by source image
$3
* getEdgeConfigs - Get Edge Configs
* createEdgeConfig - Create an Edge Config
* getEdgeConfig - Get an Edge Config
* updateEdgeConfig - Update an Edge Config
* deleteEdgeConfig - Delete an Edge Config
* getEdgeConfigItems - Get Edge Config items
* patchEdgeConfigItems - Update Edge Config items in batch
* getEdgeConfigSchema - Get Edge Config schema
* patchEdgeConfigSchema - Update Edge Config schema
* deleteEdgeConfigSchema - Delete an Edge Config's schema
* getEdgeConfigItem - Get an Edge Config item
* getEdgeConfigTokens - Get all tokens of an Edge Config
* deleteEdgeConfigTokens - Delete one or more Edge Config tokens
* getEdgeConfigToken - Get Edge Config token meta data
* createEdgeConfigToken - Create an Edge Config token
* getEdgeConfigBackup - Get Edge Config backup
* getEdgeConfigBackups - Get Edge Config backups
$3
* 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.
* getV9ProjectsIdOrNameCustomEnvironments - Retrieve custom environments
* getCustomEnvironment - Retrieve a custom environment
* updateCustomEnvironment - Update a custom environment
* removeCustomEnvironment - Remove a custom environment
$3
* 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)
$3

* 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 providedid (deprecated)

`$3`

* getRuntimeLogs - Get logs for a deployment

`$3`

* updateInstallation - Update Installation * getAccountInfo - Get Account Information * getMember - Get Member Information * 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 * getInvoice - Get Invoice * updateInvoice - Invoice Actions * submitPrepaymentBalances - Submit Prepayment Balances * updateResourceSecrets - Update Resource Secrets (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 * createInstallationIntegrationEdgeConfig - Get the data of a user-provided Edge Config * getV1InstallationsIntegrationConfigurationIdResourcesResourceIdExperimentationEdgeConfig - Get the data of a user-provided Edge Config * updateInstallationIntegrationEdgeConfig - Push data into a user-provided Edge Config

`$3`

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

`$3`

* getProjects - Retrieve a list of projects * createProject - Create a new project * updateProject - Update an existing project * deleteProject - Delete a Project * 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 - Points all production domains for a project to the given deploy * requestPromote - Points all production domains for a project to the given deploy * listPromoteAliases - Gets a list of aliases with status for the current promote * pauseProject - Pause a project * unpauseProject - Unpause a project

`$3`

* 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 * completeRollingRelease - Complete the rolling release for the project

`$3`

* updateAttackChallengeMode - Update Attack Challenge mode * putFirewallConfig - Put Firewall Configuration * updateFirewallConfig - Update Firewall Configuration * getFirewallConfig - Read Firewall Configuration * getActiveAttackStatus - Read active attack data * getBypassIp - Read System Bypass * addBypassIp - Create System Bypass Rule * removeBypassIp - Remove System Bypass Rule * getV1SecurityFirewallEvents - Read Firewall Actions by Project

`$3`

* updateStaticIps - Configures Static IPs for a project

`$3`

* 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

`$3`

* listUserEvents - List User Events * getAuthUser - Get the User * requestDelete - Delete User Account

`$3`

* 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 -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 -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 -billingListBillingCharges- List FOCUS billing charges -billingListContractCommitments- List FOCUS contract commitments -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 -certsIssueCert- Issue a new cert -certsRemoveCert- Remove cert -certsUploadCert- Upload a cert -checksCreateCheck- Creates a new Check -checksGetAllChecks- Retrieve a list of all checks -checksGetCheck- Get a single check -checksRerequestCheck- Rerequest a check -checksUpdateCheck- Update a check -connectCreateNetwork- Create a Secure Compute network -connectDeleteNetwork- Delete a Secure Compute network -connectListNetworks- List Secure Compute networks -connectReadNetwork- Read a Secure Compute network -connectUpdateNetwork- Update a Secure Compute network -connectUpdateStaticIps- Configures Static IPs for a project -connectUpdateStaticIps- Configures Static IPs for a project -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 -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 -domainsGetDomains- List all the domains -domainsPatchDomain- Update or move apex domain -domainsRegistrarBuyDomains- Buy multiple domains -domainsRegistrarBuySingleDomain- Buy a domain -domainsRegistrarGetBulkAvailability- Get availability for multiple domains -domainsRegistrarGetContactInfoSchema- Get contact info schema -domainsRegistrarGetDomainAuthCode- Get the auth code for a domain -domainsRegistrarGetDomainAvailability- Get availability 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 -domainsRegistrarGetTldPrice- Get TLD price data -domainsRegistrarRenewDomain- Renew a domain -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 -edgeCacheDangerouslyDeleteBySrcImages- Dangerously delete by source image -edgeCacheDangerouslyDeleteByTags- Dangerously delete by tag -edgeCacheInvalidateBySrcImages- Invalidate by source image -edgeCacheInvalidateByTags- Invalidate by tag -edgeConfigCreateEdgeConfig- Create an Edge Config -edgeConfigCreateEdgeConfigToken- Create an Edge Config token -edgeConfigDeleteEdgeConfig- Delete an Edge Config -edgeConfigDeleteEdgeConfigSchema- Delete an Edge Config's schema -edgeConfigDeleteEdgeConfigTokens- Delete one or more Edge Config tokens -edgeConfigGetEdgeConfig- Get an Edge Config -edgeConfigGetEdgeConfigBackup- Get Edge Config backup -edgeConfigGetEdgeConfigBackups- Get Edge Config backups -edgeConfigGetEdgeConfigItem- Get an Edge Config item -edgeConfigGetEdgeConfigItems- Get Edge Config items -edgeConfigGetEdgeConfigs- Get Edge Configs -edgeConfigGetEdgeConfigSchema- Get Edge Config schema -edgeConfigGetEdgeConfigToken- Get Edge Config token meta data -edgeConfigGetEdgeConfigTokens- Get all tokens of an Edge Config -edgeConfigPatchEdgeConfigItems- Update Edge Config items in batch -edgeConfigPatchEdgeConfigSchema- Update Edge Config schema -edgeConfigUpdateEdgeConfig- Update an Edge Config -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 -environmentGetSharedEnvVar- Retrieve the decrypted value of a Shared Environment Variable by id. -environmentGetV9ProjectsIdOrNameCustomEnvironments- Retrieve custom environments -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 -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 -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 -marketplaceCreateInstallationIntegrationEdgeConfig- Get the data of a user-provided Edge Config -marketplaceDeleteInstallationIntegrationConfiguration- Delete an existing experimentation item -marketplaceDeleteIntegrationResource- Delete Integration Resource -marketplaceExchangeSsoToken- SSO Token Exchange -marketplaceExchangeSsoToken- SSO Token Exchange -marketplaceGetAccountInfo- Get Account Information -marketplaceGetIntegrationResource- Get Integration Resource -marketplaceGetIntegrationResources- Get Integration Resources -marketplaceGetInvoice- Get Invoice -marketplaceGetMember- Get Member Information -marketplaceGetV1InstallationsIntegrationConfigurationIdResourcesResourceIdExperimentationEdgeConfig- Get the data of a user-provided Edge Config -marketplaceImportResource- Import Resource -marketplaceSubmitBillingData- Submit Billing Data -marketplaceSubmitInvoice- Submit Invoice -marketplaceSubmitPrepaymentBalances- Submit Prepayment Balances -marketplaceUpdateInstallation- Update Installation -marketplaceUpdateInstallationIntegrationConfiguration- Patch an existing experimentation item -marketplaceUpdateInstallationIntegrationEdgeConfig- Push data into a user-provided Edge Config -marketplaceUpdateInvoice- Invoice Actions -marketplaceUpdateResource- Update Resource -marketplaceUpdateResourceSecrets- Update Resource Secrets (Deprecated) -marketplaceUpdateResourceSecretsById- Update Resource Secrets -patchV1ProjectsProjectIdRollbackDeploymentIdUpdateDescription- Updates the description for a rollback -projectMembersAddProjectMember- Adds a new member to a project. -projectMembersGetProjectMembers- List project members -projectMembersRemoveProjectMember- Remove a Project Member -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 -projectsDeleteProject- Delete a Project -projectsEditProjectEnv- Edit an environment variable -projectsFilterProjectEnvs- Retrieve the environment variables of 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 -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- Points all production domains for a project to the given deploy -projectsRequestRollback- Points all production domains for a project to the given deploy -projectsUnpauseProject- Unpause a project -projectsUpdateProject- Update an existing project -projectsUpdateProjectDomain- Update a project domain -projectsUpdateProjectProtectionBypass- Update Protection Bypass for Automation -projectsVerifyProjectDomain- Verify project domain -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 -rollingReleaseUpdateRollingReleaseConfig- Update the rolling release settings for the project -securityAddBypassIp- Create System Bypass Rule -securityGetActiveAttackStatus- Read active attack data -securityGetBypassIp- Read System Bypass -securityGetFirewallConfig- Read Firewall Configuration -securityGetV1SecurityFirewallEvents- Read Firewall Actions by Project -securityPutFirewallConfig- Put Firewall Configuration -securityRemoveBypassIp- Remove System Bypass Rule -securityUpdateAttackChallengeMode- Update Attack Challenge mode -securityUpdateFirewallConfig- Update Firewall Configuration -teamsCreateTeam- Create a Team -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 -teamsUpdateTeamMember- Update a Team Member -userGetAuthUser- Get the User -userListUserEvents- List User Events -userRequestDelete- Delete User Account -webhooksCreateWebhook- Creates a webhook -webhooksDeleteWebhook- Deletes a webhook -webhooksGetWebhook- Get a webhook -webhooksGetWebhooks - Get a list of webhooks



Json Streaming

Json Streaming ([jsonl][jsonl-format] / [x-ndjson][x-ndjson]) content type can be used to stream content from certain operations. These operations expose the stream as an [AsyncGenerator][async-generator] that can be consumed using a for await...of loop in TypeScript/JavaScript. The loop will terminate when the server no longer has any events to send and closes the underlying connection.

Here's an example of consuming a JSONL stream:

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

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

async function run() { const result = await vercel.billing.listBillingCharges({ from: "2025-01-01T00:00:00.000Z", to: "2025-01-31T00:00:00.000Z", teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l", slug: "my-team-url-slug", });

for await (const event of result) { // Handle the event console.log(event); } }

run();

[jsonl-format]: https://jsonlines.org/ [x-ndjson]: https://github.com/ndjson/ndjson-spec [async-generator]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/AsyncGenerator

`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 nativeopenAsBlob function in node:fs. > - Bun: The nativeBun.filefunction produces a file handle that can be used for streaming file uploads. > - Browsers: All supported browsers return an instance to aFile when reading the value from an element. > - Node.js v18: A file stream can be created using thefileFrom helper from fetch-blob/from.js.

`typescript import { Vercel } from "@vercel/sdk"; import { openAsBlob } from "node:fs";

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

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:`typescript import { Vercel } from "@vercel/sdk";

const vercel = new Vercel();

async function run() { await vercel.patchV1ProjectsProjectIdRollbackDeploymentIdUpdateDescription({ projectId: "", deploymentId: "", }, { retries: { strategy: "backoff", backoff: { initialInterval: 1, maxInterval: 50, exponent: 1.1, maxElapsedTime: 100, }, retryConnectionErrors: false, }, }); }

run();

If you'd like to override the default retry stra

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.

SDK Installation

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

$3

``bash npm add @vercel/sdk`

`$3`

`bash pnpm add @vercel/sdk`

`$3`

`bash bun add @vercel/sdk`

`$3`

`bash yarn add @vercel/sdk`

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

`$3`

This SDK is also an installable MCP server where the various SDK methods are exposed as tools that can be invoked by AI applications.

> Node.js v20 or greater is required to run the MCP server from npm.


Claude installation steps

Add the following server definition to your claude_desktop_config.json file:

`json { "mcpServers": { "Vercel": { "command": "npx", "args": [ "-y", "--package", "@vercel/sdk", "--", "mcp", "start", "--bearer-token", "..." ] } } }`


Cursor installation steps

Create a .cursor/mcp.json file in your project root with the following content:

`json { "mcpServers": { "Vercel": { "command": "npx", "args": [ "-y", "--package", "@vercel/sdk", "--", "mcp", "start", "--bearer-token", "..." ] } } }`

You can also run MCP servers as a standalone binary with no additional dependencies. You must pull these binaries from available Github releases:

`bash curl -L -o mcp-server \ https://github.com/{org}/{repo}/releases/download/{tag}/mcp-server-bun-darwin-arm64 && \ chmod +x mcp-server`

If the repo is a private repo you must add your Github PAT to download a release -H "Authorization: Bearer {GITHUB_PAT}".

`json { "mcpServers": { "Todos": { "command": "./DOWNLOAD/PATH/mcp-server", "args": [ "start" ] } } }`

For a full list of server arguments, run:

`sh npx -y --package @vercel/sdk -- mcp start --help`

`Requirements`

For supported JavaScript runtimes, please consult RUNTIMES.md.

`Access Tokens`

`Authentication`

`$3`

This SDK supports the following security scheme globally:

| Name | Type | Scheme | | ------------- | ---- | ----------- | |bearerToken | http | HTTP Bearer |

To authenticate with the API the bearerTokenparameter must be set when initializing the SDK client instance. For example:`typescript import { Vercel } from "@vercel/sdk";

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

async function run() { await vercel.patchV1ProjectsProjectIdRollbackDeploymentIdUpdateDescription({ projectId: "", deploymentId: "", }); }

run();

`SDK Example Usage`

`$3`

List deployments under the authenticated user or team.

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

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

console.log(result); }

run();

`$3`

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

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

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

console.log(result); }

run();

`Available Resources and Operations`


Available methods
$3
* patchV1ProjectsProjectIdRollbackDeploymentIdUpdateDescription - Updates the description for a rollback
$3
* 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
$3
* 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
$3
* 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
$3
* exchangeSsoToken - SSO Token Exchange
* listAuthTokens - List Auth Tokens
* createAuthToken - Create an Auth Token
* getAuthToken - Get Auth Token Metadata
* deleteAuthToken - Delete an authentication token
$3
* listBillingCharges - List FOCUS billing charges
* listContractCommitments - List FOCUS contract commitments
$3
* 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.
$3
* getCertById - Get cert by id
* removeCert - Remove cert
* issueCert - Issue a new cert
* uploadCert - Upload a cert
$3
* createCheck - Creates a new Check
* getAllChecks - Retrieve a list of all checks
* getCheck - Get a single check
* updateCheck - Update a check
* rerequestCheck - Rerequest a check
$3
* 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
* updateStaticIps - Configures Static IPs for a project
$3
* 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
$3
* getRecords - List existing DNS records
* createRecord - Create a DNS record
* updateRecord - Update an existing DNS record
* removeRecord - Delete a DNS record
$3
* getDomainConfig - Get a Domain's configuration
* 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
$3
* getSupportedTlds - Get supported TLDs
* getTldPrice - Get TLD price data
* getDomainAvailability - Get availability for a domain
* getDomainPrice - Get price data for a domain
* getBulkAvailability - Get availability for multiple domains
* 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
* getContactInfoSchema - Get contact info schema
* getOrder - Get a domain order
$3
* 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
$3
* invalidateByTags - Invalidate by tag
* dangerouslyDeleteByTags - Dangerously delete by tag
* invalidateBySrcImages - Invalidate by source image
* dangerouslyDeleteBySrcImages - Dangerously delete by source image
$3
* getEdgeConfigs - Get Edge Configs
* createEdgeConfig - Create an Edge Config
* getEdgeConfig - Get an Edge Config
* updateEdgeConfig - Update an Edge Config
* deleteEdgeConfig - Delete an Edge Config
* getEdgeConfigItems - Get Edge Config items
* patchEdgeConfigItems - Update Edge Config items in batch
* getEdgeConfigSchema - Get Edge Config schema
* patchEdgeConfigSchema - Update Edge Config schema
* deleteEdgeConfigSchema - Delete an Edge Config's schema
* getEdgeConfigItem - Get an Edge Config item
* getEdgeConfigTokens - Get all tokens of an Edge Config
* deleteEdgeConfigTokens - Delete one or more Edge Config tokens
* getEdgeConfigToken - Get Edge Config token meta data
* createEdgeConfigToken - Create an Edge Config token
* getEdgeConfigBackup - Get Edge Config backup
* getEdgeConfigBackups - Get Edge Config backups
$3
* 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.
* getV9ProjectsIdOrNameCustomEnvironments - Retrieve custom environments
* getCustomEnvironment - Retrieve a custom environment
* updateCustomEnvironment - Update a custom environment
* removeCustomEnvironment - Remove a custom environment
$3
* 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)
$3

`$3`

* getRuntimeLogs - Get logs for a deployment

`$3`

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

`$3`

* updateStaticIps - Configures Static IPs for a project

`$3`

* listUserEvents - List User Events * getAuthUser - Get the User * requestDelete - Delete User Account

`$3`

* 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



Json Streaming

Here's an example of consuming a JSONL stream:

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

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

for await (const event of result) { // Handle the event console.log(event); } }

run();

`File uploads`

`typescript import { Vercel } from "@vercel/sdk"; import { openAsBlob } from "node:fs";

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

console.log(result); }

run();

`Retries`

To change the default retry strategy for a single API call, simply provide a retryConfig object to the call:`typescript import { Vercel } from "@vercel/sdk";

const vercel = new Vercel();

run();

If you'd like to override the default retry stra

@vercel/sdk

Vercel

@vercel/sdk

Table of Contents

SDK Installation

$3

$3

$3

$3

$3

Requirements

Access Tokens

Authentication

$3

SDK Example Usage

$3

$3

Available Resources and Operations

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

Standalone functions

Json Streaming

File uploads

Retries

@vercel/sdk

Vercel

@vercel/sdk

Table of Contents

SDK Installation

$3

$3

$3

$3

$3

Requirements

Access Tokens

Authentication

$3

SDK Example Usage

$3

$3

Available Resources and Operations

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

`$3`

`$3`

`$3`

`$3`

`Requirements`

`Access Tokens`

`Authentication`

`$3`

`SDK Example Usage`

`$3`

`$3`

`Available Resources and Operations`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`File uploads`

`Retries`

`$3`

`$3`

`$3`

`$3`

`Requirements`

`Access Tokens`

`Authentication`

`$3`

`SDK Example Usage`

`$3`

`$3`

`Available Resources and Operations`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`File uploads`

`Retries`