Get deployment with the Vercel API
Returns a deployment by its id or its url, with readyState, target, alias, projectId and, for a failed build, errorCode and errorMessage.
- Identifier
- vercel_get_deployment
The request
POST https://connect.reportei.com/api/tools/vercel_get_deployment/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"idOrUrl": "<idOrUrl>"
}
}Your system sends your customer's connection id and the tool arguments. The headers are the same as the rest of the Connect API: your product's token and your customer's token.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| idOrUrl | string | Yes | The uid of the deployment from List deployments, or its hostname, such as my-site-abc123.vercel.app. |
| teamId | string | No | With a Full Account token, the id of the team from List teams that owns the deployment. Omit it for the personal account or with a team token. |
| withGitRepoInfo | string | No | Send true to add gitSource, with the commit, branch and repository.Values: true, false |
Supported connections
Your customer connects their Vercel account once, with one of the modes below. The same connection serves every tool of the toolkit.
API key
Your customer pastes the app's key on a Connect screen, or your system sends the key with POST /api/customer-toolkits, with no screen.
The response
On success, Connect preserves the app's response status and body. HTTP errors returned by the app use the {error, api_error} envelope; authentication or validation can fail before execution. The X-Toolkit-Execution-Id header identifies the recorded execution, available at GET /api/tools/executions/{uuid}.
Ready for AI agents
This tool's input is a JSON Schema, available at GET /api/tools/vercel_get_deployment. It becomes your agent's tool definition with no conversion.
Other Vercel tools
- 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.
- 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.
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.
