The @vercel/sdk is a type-safe TypeScript SDK that allows you to access the resources and methods of the Vercel REST API.
To download and install Vercel SDK, run the following command:
Terminal
pnpm i @vercel/sdkVercel Access Tokens are required to authenticate and use the Vercel SDK. Once you have created a token, you can use it to initialize the SDK as follows:
run.ts
import { Vercel } from '@vercel/sdk';
const vercel = new Vercel({ bearerToken: '<YOUR_BEARER_TOKEN_HERE>',});Make sure that you create a token with the correct Vercel team. 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.
Browse all available SDK methods grouped by category.
Access-groups11 endpointsAliases6 endpointsArtifacts6 endpointsAuthentication5 endpointsBilling2 endpointsBulk-redirects7 endpointsCerts4 endpointsChecks5 endpointsChecks-v210 endpointsConnect6 endpointsDeployments10 endpointsDns4 endpointsDomains6 endpointsDomains-registrar16 endpointsDrains6 endpointsEdge-cache4 endpointsEdge-config17 endpointsEnvironment11 endpointsFeature-flags19 endpointsIntegrations10 endpointsLogs1 endpointMarketplace23 endpointsProjectmembers3 endpointsProjects27 endpointsRolling-release7 endpointsSandboxes18 endpointsSecurity9 endpointsStatic-ips1 endpointTeams14 endpointsUser4 endpointsWebhooks4 endpoints