Vercel tools
The 13 Vercel operations your product runs on your customer's account through Connect. All of them use the same endpoint, POST /api/tools/{tool}/execute.
- List teamsGETLists the teams the account belongs to. Each item has id, the teamId that the other tools take, and slug. Only a Full Account token needs teamId: a token created for a team already acts on that team. Paginate passing pagination.next of the response as until.
- List projectsGETLists the projects of the account or of a team, with their settings, Git link and latest deployments. Each item has id and name, which the other tools take as the project. Paginate passing pagination.next of the response as from.
- Create projectPOSTCreates a project and returns it, with its id. With gitRepository, every push to the repository deploys automatically; the Vercel app of the Git provider must have access to the repository. Build settings left out are detected by Vercel.
- Update projectPATCHChanges the name or the build settings of a project and returns it. Only the fields sent change. The new settings apply from the next deployment.
- List deploymentsGETLists deployments, newest first, with state, target, url and Git metadata. Each item has uid, the id of the deployment. Paginate passing pagination.next of the response as until.
- Get deploymentGETReturns a deployment by its id or its url, with readyState, target, alias, projectId and, for a failed build, errorCode and errorMessage.
- Create deploymentPOSTStarts a deployment and returns it, with id, url and readyState. Send deploymentId to redeploy an existing deployment, or gitSource to deploy a branch or commit of the connected repository. Without target it is a preview; production makes it the production deployment. The build takes minutes: follow it with Get deployment.
- Cancel deploymentPATCHStops a deployment that is still queued or building, and returns it with readyState CANCELED.
- Promote deploymentPOSTPoints the production domains of a project to an existing deployment, without building it again, such as to roll production back to an older production deployment. To put a preview in production with a new build, use Create deployment with its deploymentId and target production. Answers 201 or 202 when accepted.
- List deployment eventsGETReturns the build log of a deployment as a list of events, each with type (such as stdout, stderr or command), created and the text of the line. Use it to see why a build failed.
- List project domainsGETLists the domains of a project, with verified, the redirect and the Git branch of each. Paginate passing pagination.next of the response as until.
- Create project domainPOSTAdds a domain to a project and returns it with verified. Then point the DNS of the domain to Vercel, as Get domain config shows. With verified false, the domain is in use elsewhere: create the TXT record listed in verification and verify it in the Vercel dashboard. A domain already in the project answers 400.
- Get domain configGETTells whether the DNS of a domain points to Vercel: misconfigured, configuredBy, and the recommendedIPv4 and recommendedCNAME values to set at the DNS provider.
Toolkits in the same category
See all 100 toolkitsSee Connect applied to your product.
Try it for 15 days with no card, or walk our team through your use case.
