Vercel API
Vercel combines the best developer experience with an obsessive focus on end-user performance. Our platform enables frontend teams to do their best work.
Developer tools#openapi#hosting
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Vercel combines the best developer experience with an obsessive focus on end-user performance. Our platform enables frontend teams to do their best work.
Endpoints 113
edge-config
- GETGet Edge Configs
/edge-config?teamId=stringReturns all Edge Configs. - POSTCreate an Edge Config
/edge-config?teamId=stringCreates an Edge Config. - GETGet an Edge Config
/edge-config/:edgeConfigId?teamId=stringReturns an Edge Config. - PUTUpdate an Edge Config
/edge-config/:edgeConfigId?teamId=stringUpdates an Edge Config. - DELETEDelete an Edge Config
/edge-config/:edgeConfigId?teamId=stringDelete an Edge Config by id. - GETGet an Edge Config item
/edge-config/:edgeConfigId/item/:edgeConfigItemKey?teamId=stringReturns a specific Edge Config Item. - GETGet Edge Config items
/edge-config/:edgeConfigId/items?teamId=stringReturns all items of an Edge Config. - PATCHUpdate Edge Config items in batch
/edge-config/:edgeConfigId/items?teamId=stringUpdate multiple Edge Config Items in batch. - POSTCreate an Edge Config token
/edge-config/:edgeConfigId/token?teamId=stringAdds a token to an existing Edge Config. - GETGet Edge Config token meta data
/edge-config/:edgeConfigId/token/:token?teamId=stringReturn meta data about an Edge Config token. - GETGet all tokens of an Edge Config
/edge-config/:edgeConfigId/tokens?teamId=stringReturns all tokens of an Edge Config. - DELETEDelete one or more Edge Config tokens
/edge-config/:edgeConfigId/tokens?teamId=stringDeletes one or more tokens of an existing Edge Config.
authentication
- POSTLogin with email
/registrationRequest a new login for a user to get a token. This will respond with a verification token and send an email to confirm the request. Once confirmed you can… - GETVerify a login request to get an authentication token
/registration/verify?email=string&token=string&tokenName=Your Client App Name&ssoUserId=stringVerify the user accepted the login request and get a authentication token. The user email address and the token received after requesting the login must be… - POSTCreate an Auth Token
/v3/user/tokens?teamId=stringCreates and returns a new authentication token for the currently authenticated User. The bearerToken property is only provided once, in the response body, so… - DELETEDelete an authentication token
/v3/user/tokens/:tokenIdInvalidate an authentication token, such that it will no longer be valid for future HTTP requests. - GETList Auth Tokens
/v5/user/tokensRetrieve a list of the current User's authentication tokens. - GETGet Auth Token Metadata
/v5/user/tokens/:tokenIdRetrieve metadata about an authentication token belonging to the currently authenticated User.
checks
- GETRetrieve a list of all checks
/v1/deployments/:deploymentId/checks?teamId=stringList all of the checks created for a deployment. - POSTCreates a new Check
/v1/deployments/:deploymentId/checks?teamId=stringCreates a new check. This endpoint must be called with an OAuth2 or it will produce a 400 error. - GETGet a single check
/v1/deployments/:deploymentId/checks/:checkId?teamId=stringReturn a detailed response for a single check. - PATCHUpdate a check
/v1/deployments/:deploymentId/checks/:checkId?teamId=stringUpdate an existing check. This endpoint must be called with an OAuth2 or it will produce a 400 error. - POSTRerequest a check
/v1/deployments/:deploymentId/checks/:checkId/rerequest?teamId=stringRerequest a selected check that has failed.
dns
- PATCHUpdate an existing DNS record
/v1/domains/records/:recordId?teamId=stringUpdates an existing DNS record for a domain name. - POSTCreate a DNS record
/v2/domains/:domain/records?teamId=stringCreates a DNS record for a domain. - DELETEDelete a DNS record
/v2/domains/:domain/records/:recordId?teamId=stringRemoves an existing DNS record from a domain name. - GETList existing DNS records
/v4/domains/:domain/records?limit=20&since=1609499532000&until=1612264332000&teamId=stringRetrieves a list of DNS records created for a domain name. By default it returns 20 records if no limit is provided. The rest can be retrieved using the…
integrations
- GETRetrieve an integration configuration
/v1/integrations/configuration/:id?teamId=stringAllows to retrieve a the configuration with the provided id in case it exists. The authenticated user or team must be the owner of the config in order to… - DELETEDelete an integration configuration
/v1/integrations/configuration/:id?teamId=stringAllows to remove the configuration with the id provided in the parameters. The configuration and all of its resources will be removed. This includes Webhooks,… - GETGet configurations for the authenticated user or team
/v1/integrations/configurations?view=account&teamId=stringAllows to retrieve all configurations for an authenticated integration. When the project view is used, configurations generated for the authorization flow… - GETList git namespaces by provider
/v1/integrations/git-namespaces?provider=github&teamId=stringLists git namespaces for a supported provider. Supported providers are github, gitlab and bitbucket. If the provider is not provided, it will try to obtain it… - GETList git repositories linked to namespace by provider
/v1/integrations/search-repo?query=string&namespaceId=string&provider=github&installationId=string&teamId=stringLists git repositories linked to a namespace id for a supported provider. A specific namespace id can be obtained via the git-namespaces endpoint. Supported…
logDrains
- DELETEDeletes the Integration log drain with the provided `id`
/v1/integrations/log-drains/:id?teamId=stringDeletes the Integration log drain with the provided id. When using an OAuth2 Token, the log drain can be deleted only if the integration owns it. - GETRetrieves a list of Configurable Log Drains
/v1/log-drains?projectId=string&teamId=stringRetrieves a list of Configurable Log Drains. This endpoint must be called with a team AccessToken (integration OAuth2 clients are not allowed). Only log… - POSTCreates a Configurable Log Drain
/v1/log-drains?teamId=stringCreates a configurable log drain. This endpoint must be called with a team AccessToken (integration OAuth2 clients are not allowed) - GETRetrieves a Configurable Log Drain
/v1/log-drains/:id?teamId=stringRetrieves a Configurable Log Drain. This endpoint must be called with a team AccessToken (integration OAuth2 clients are not allowed). Only log drains owned… - DELETEDeletes a Configurable Log Drain
/v1/log-drains/:id?teamId=stringDeletes a Configurable Log Drain. This endpoint must be called with a team AccessToken (integration OAuth2 clients are not allowed). Only log drains owned by… - GETRetrieves a list of Integration log drains
/v2/integrations/log-drains?teamId=stringRetrieves a list of all Integration log drains that are defined for the authorized account. When using an OAuth2 token, the list is limited to log drains… - POSTCreates a new Integration Log Drain
/v2/integrations/log-drains?teamId=stringCreates an Integration log drain. This endpoint must be called with an OAuth2 client (integration), since log drains are tied to integrations. If it is called…
projects
- GETRetrieve the decrypted value of an environment variable of a project by id
/v1/projects/:idOrName/env/:id?teamId=stringRetrieve the environment variable for a given project. - POSTCreate one or more environment variables
/v10/projects/:idOrName/env?teamId=stringCreate one ore more environment variables for a project by passing its key, value, type and target and by specifying the project by either passing the project… - GETRetrieve a list of projects
/v9/projects?from=string&gitForkProtection=1&limit=string&search=string&repo=string&repoId=string&repoUrl=https://github.com/vercel/next.js&excludeRepos=string&edgeConfigId=string&edgeConfigTokenId=string&connectConfigurationId=string&teamId=stringAllows to retrieve the list of projects of the authenticated user. The list will be paginated and the provided query parameters allow filtering the returned… - POSTCreate a new project
/v9/projects?teamId=stringAllows to create a new project with the provided configuration. It only requires the project name but more configuration can be provided to override the… - GETFind a project by id or name
/v9/projects/:idOrName?teamId=stringGet the information for a specific project by passing either the project id or name in the URL. - DELETEDelete a Project
/v9/projects/:idOrName?teamId=stringDelete a specific project by passing either the project id or name in the URL. - PATCHUpdate an existing project
/v9/projects/:idOrName?teamId=stringUpdate the fields of a project using either its name or id. - GETRetrieve project domains by project by id or name
/v9/projects/:idOrName/domains?production=false&gitBranch=string&redirects=true&redirect=example.com&verified=true&limit=20&since=1609499532000&until=1612264332000&order=DESC&teamId=stringRetrieve the domains associated with a given project by passing either the project id or name in the URL. - POSTAdd a domain to a project
/v9/projects/:idOrName/domains?teamId=stringAdd a domain to the project by passing its domain name and by specifying the project by either passing the project id or name in the URL. If the domain is not… - GETGet a project domain
/v9/projects/:idOrName/domains/:domain?teamId=stringGet project domain by project id/name and domain name. - DELETERemove a domain from a project
/v9/projects/:idOrName/domains/:domain?teamId=stringRemove a domain from a project by passing the domain name and by specifying the project by either passing the project id or name in the URL. - PATCHUpdate a project domain
/v9/projects/:idOrName/domains/:domain?teamId=stringUpdate a project domain's configuration, including the name, git branch and redirect of the domain. - POSTVerify project domain
/v9/projects/:idOrName/domains/:domain/verify?teamId=stringAttempts to verify a project domain with verified = false by checking the correctness of the project domain's verification challenge. - GETRetrieve the environment variables of a project by id or name
/v9/projects/:idOrName/env?gitBranch=feature-1&decrypt=true&source=vercel-cli:pull&teamId=stringRetrieve the environment variables for a given project by passing either the project id or name in the URL. - DELETERemove an environment variable
/v9/projects/:idOrName/env/:id?teamId=stringDelete a specific environment variable for a given project by passing the environment variable identifier and either passing the project id or name in the URL. - PATCHEdit an environment variable
/v9/projects/:idOrName/env/:id?teamId=stringEdit a specific environment variable for a given project by passing the environment variable identifier and either passing the project id or name in the URL.
teams
- POSTCreate a Team
/v1/teamsCreate a new Team under your account. You need to send a POST request with the desired Team slug, and optionally the Team name. - DELETEDelete a Team
/v1/teams/:teamIdDelete a team under your account. You need to send a DELETE request with the desired team id. An optional array of reasons for deletion may also be sent. - DELETEDelete a Team invite code
/v1/teams/:teamId/invites/:inviteIdDelete an active Team invite code. - POSTInvite a user
/v1/teams/:teamId/membersInvite a user to join the team specified in the URL. The authenticated user needs to be an OWNER in order to successfully invoke this endpoint. The user can… - POSTJoin a team
/v1/teams/:teamId/members/teams/joinJoin a team with a provided invite code or team ID. - DELETERemove a Team Member
/v1/teams/:teamId/members/:uidRemove a Team Member from the Team, or dismiss a user that requested access, or leave a team. - PATCHUpdate a Team Member
/v1/teams/:teamId/members/:uidUpdate the membership of a Team Member on the Team specified by teamId, such as changing the _role_ of the member, or confirming a request to join the Team… - POSTRequest access to a team
/v1/teams/:teamId/requestRequest access to a team as a member. An owner has to approve the request. Only 10 users can request access to a team at the same time. - GETGet access request status
/v1/teams/:teamId/request/:userIdCheck the status of a join request. It'll respond with a 404 if the request has been declined. If no userId path segment was provided, this endpoint will… - GETList all teams
/v2/teams?limit=20&since=1540095775951&until=1540095775951Get a paginated list of all the Teams the authenticated User is a member of. - GETGet a Team
/v2/teams/:teamId?slug=stringGet information for the Team specified by the teamId parameter. - PATCHUpdate a Team
/v2/teams/:teamIdUpdate the information of a Team specified by the teamId parameter. The request body should contain the information that will be updated on the Team. - GETList team members
/v2/teams/:teamId/members?limit=20&since=1540095775951&until=1540095775951&search=string&role=OWNER&excludeProject=stringGet a paginated list of team members for the provided team.
user
- DELETEDelete User Account
/v1/userInitiates the deletion process for the currently authenticated User, by sending a deletion confirmation email. The email contains a link that the user needs… - GETGet the User
/v2/userRetrieves information related to the currently authenticated User. - GETList User Events
/v3/events?limit=20&since=2019-12-08T10:00:38.976Z&until=2019-12-09T23:00:38.976Z&types=login,team-member-join,domain-buy&userId=aeIInYVk59zbFF2SxfyxxmuO&teamId=stringRetrieves a list of "events" generated by the User on Vercel. Events are generated when the User performs a particular action, such as logging in, creating a…
webhooks
- GETGet a list of webhooks
/v1/webhooks?projectId=string&teamId=stringGet a list of webhooks - POSTCreates a webhook
/v1/webhooks?teamId=stringCreates a webhook - GETGet a webhook
/v1/webhooks/:id?teamId=stringGet a webhook - DELETEDeletes a webhook
/v1/webhooks/:id?teamId=stringDeletes a webhook
deployments
- GETList Deployment Builds
/v11/deployments/:deploymentId/builds?teamId=stringRetrieves the list of builds given their deployment's unique identifier. - PATCHCancel a deployment
/v12/deployments/:id/cancel?teamId=stringThis endpoint allows you to cancel a deployment which is currently building, by supplying its id in the URL. - POSTCreate a new deployment
/v13/deployments?forceNew=0&skipAutoDetectionConfirmation=0&teamId=stringCreate a new deployment with all the required and intended data. If the deployment is not a git deployment, all files must be provided with the request,… - GETGet a deployment by ID or URL
/v13/deployments/:idOrUrl?withGitRepoInfo=true&teamId=stringRetrieves information for a deployment either by supplying its ID (id property) or Hostname (url property). Additional details will be included when the… - DELETEDelete a Deployment
/v13/deployments/:id?url=https://files-orcin-xi.vercel.app/&teamId=stringThis API allows you to delete a deployment, either by supplying its id in the URL or the url of the deployment as a query parameter. You can obtain the ID,… - GETGet deployment events
/v2/deployments/:idOrUrl/events?direction=backward&follow=1&limit=100&name=bld_cotnkcr76&since=1540095775941&until=1540106318643&statusCode=5xx&delimiter=1&builds=1&teamId=stringGet the build logs of a deployment by deployment ID and build ID. It can work as an infinite stream of logs or as a JSON endpoint depending on the input… - POSTUpload Deployment Files
/v2/files?teamId=stringBefore you create a deployment you need to upload the required files for that deployment. To do it, you need to first upload each file to this endpoint. Once… - GETList deployments
/v6/deployments?app=docs&from=1612948664566&limit=10&projectId=QmXGTs7mvAMMC7WW5ebrM33qKG32QK3h4vmQMjmY&target=production&to=1612948664566&users=kr1PsOIzqEL5Xg6M4VZcZosf,K4amb7K9dAt5R2vBJWF32bmY&since=1540095775941&until=1540095775951&state=BUILDING,READY&rollbackCandidate=true&teamId=stringList deployments under the account corresponding to the API token. If a deployment hasn't finished uploading (is incomplete), the url property will have a… - GETList Deployment Files
/v6/deployments/:id/files?teamId=stringAllows to retrieve the file structure of a deployment by supplying the deployment unique identifier. - GETGet Deployment File Contents
/v6/deployments/:id/files/:fileId?teamId=stringAllows to retrieve the content of a file by supplying the file identifier and the deployment unique identifier. The response body will contain the raw content…
aliases
- DELETEDelete an Alias
/v2/aliases/:aliasId?teamId=stringDelete an Alias with the specified ID. - GETList Deployment Aliases
/v2/deployments/:id/aliases?teamId=stringRetrieves all Aliases for the Deployment with the given ID. The authenticated User must own the deployment. - POSTAssign an Alias
/v2/deployments/:id/aliases?teamId=stringCreates a new alias for the deployment with the given deployment ID. The authenticated user must own this deployment. If the desired alias is already assigned… - GETList aliases
/v4/aliases?domain=my-test-domain.com&from=1540095775951&limit=10&projectId=prj_12HKQaOmR5t5Uy6vdcQsNIiZgHGB&since=1540095775941&until=1540095775951&rollbackDeploymentId=dpl_XXX&teamId=stringRetrieves a list of aliases for the authenticated User or Team. When domain is provided, only aliases for that domain will be returned. When projectId is… - GETGet an Alias
/v4/aliases/:idOrAlias?from=1540095775951&projectId=prj_12HKQaOmR5t5Uy6vdcQsNIiZgHGB&since=1540095775941&until=1540095775951&teamId=stringRetrieves an Alias for the given host name or alias ID.
secrets
- DELETEDelete a secret
/v2/secrets/:idOrName?teamId=stringThis deletes the user's secret defined in the URL. - POSTCreate a new secret
/v2/secrets/:name?teamId=stringAllows to create a new secret. - PATCHChange secret name
/v2/secrets/:name?teamId=stringEnables to edit the name of a user's secret. The name has to be unique to that user's secrets. - GETList secrets
/v3/secrets?id=sec_RKc5iV0rV3ZSrFrHiruRno7k,sec_fGc5iV0rV3ZSrFrHiruRnouQ&projectId=prj_2WjyKQmM8ZnGcJsPWMrHRHrE&teamId=stringRetrieves the active Vercel secrets for the authenticated user. By default it returns 20 secrets. The rest can be retrieved using the pagination options. The… - GETGet a single secret
/v3/secrets/:idOrName?decrypt=true&teamId=stringRetrieves the information for a specific secret by passing either the secret id or name in the URL.
domains
- POSTRegister or transfer-in a new Domain
/v4/domains?teamId=stringThis endpoint is used for registering a new domain name with Vercel for the authenticating user, and also for initiating a domain transfer request from an… - POSTPurchase a domain
/v4/domains/buy?teamId=stringAllows to purchase the specified domain. - GETCheck the price for a domain
/v4/domains/price?name=example.com&type=new&teamId=stringCheck the price to purchase a domain and how long a single purchase period is. - GETCheck a Domain Availability
/v4/domains/status?name=example.com&teamId=stringCheck if a domain name is available for purchase. - GETList all the domains
/v5/domains?limit=20&since=1609499532000&until=1612264332000&teamId=stringRetrieves a list of domains registered for the authenticating user. By default it returns the last 20 domains if no limit is provided. - GETGet Information for a Single Domain
/v5/domains/:domain?teamId=stringGet information for a single domain in an account or team. - DELETERemove a domain by name
/v6/domains/:domain?teamId=stringDelete a previously registered domain name from Vercel. Deleting a domain will automatically remove any associated aliases. - GETGet a Domain's configuration
/v6/domains/:domain/config?teamId=stringGet a Domain's configuration.
certs
- PUTUpload a cert
/v7/certs?teamId=stringUpload a cert - POSTIssue a new cert
/v7/certs?teamId=stringIssue a new cert - GETGet cert by id
/v7/certs/:id?teamId=stringGet cert by id - DELETERemove cert
/v7/certs/:id?teamId=stringRemove cert
artifacts
- POSTQuery information about an artifact
/v8/artifacts?teamId=stringQuery information about an array of artifacts. - POSTRecord an artifacts cache usage event
/v8/artifacts/events?teamId=stringRecords an artifacts cache usage event. The body of this request is an array of cache usage events. The supported event types are HIT and MISS. The source is… - GETGet status of Remote Caching for this principal
/v8/artifacts/status?teamId=stringCheck the status of Remote Caching for this principal. Returns a JSON-encoded status indicating if Remote Caching is enabled, disabled, or disabled due to… - GETDownload a cache artifact
/v8/artifacts/:hash?teamId=stringDownloads a cache artifact indentified by its hash specified on the request path. The artifact is downloaded as an octet-stream. The client should verify the… - PUTUpload a cache artifact
/v8/artifacts/:hash?teamId=stringUploads a cache artifact identified by the hash specified on the path. The cache artifact can then be downloaded with the provided hash. - HEADCheck if a cache artifact exists
/v8/artifacts/:hash?teamId=stringCheck that a cache artifact with the given hash exists. This request returns response headers only and is equivalent to a GET request to this endpoint where…
API details
- Base URL
https://api.vercel.com- Authentication
- A bearer token in the Authorization header
OAuth 2.0 (authorization code flow) - Operations
- 113 operations on 85 pathsGET 52POST 27DELETE 20PATCH 10PUT 3HEAD 1
- Main resources
- projects 16teams 13edge-config 12deployments 10domains 8logDrains 7artifacts 6authentication 6aliases 5checks 5
- Response formats
application/jsonapplication/stream+json- Description format
- OpenAPI 3.1.0, API version
0.0.1 - Links
- OpenAPI document · Support
- Listed from
- APIs.guru OpenAPI Directory (CC0-1.0)
Source updated
How to test the Vercel API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Vercel API collection, without the publisher's secrets.
- Add your credentialsThis API uses A bearer token in the Authorization header. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Get Edge Configs” (GET /edge-config?teamId=string), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Vercel API?
Vercel combines the best developer experience with an obsessive focus on end-user performance. Our platform enables frontend teams to do their best work. It is listed under Developer tools and has 113 endpoints.
Who publishes the Vercel API?
It is listed from Vercel's public API description (an OpenAPI document), not published by Vercel on Swastik Codes. Anyone who controls vercel.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Vercel API?
Requests go to https://api.vercel.com. Endpoint paths are added to this base URL.
How do I authenticate with the Vercel API?
It accepts 2 methods: A bearer token in the Authorization header; OAuth 2.0 (authorization code flow).
How many endpoints does the Vercel API have?
113 operations on 85 paths (52 GET, 27 POST, 20 DELETE, 10 PATCH, 3 PUT, 1 HEAD). The largest groups are projects, teams, edge-config, deployments.
Is forking the Vercel API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.