Sign in

v13

latestOpenAPI 3.0.32026-07-31359869.4 MB
deployments

Delete a Deployment

This 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, for example, by listing all deployments.

delete/v13/deployments/{id}

Path parameters

idstring required

The ID of the deployment to be deleted

Example:dpl_5WJWYSyB7BpgTj3EuwF37WMRBXBtPQ2iTMJHJBJyRfd

The ID of the deployment to be deleted

Query parameters

urlstring

A Deployment or Alias URL. In case it is passed, the ID will be ignored

Example:https://files-orcin-xi.vercel.app/

A Deployment or Alias URL. In case it is passed, the ID will be ignored

teamIdstring
Example:team_1a2b3c4d5e6f7g8h9i0j1k2l

The Team identifier to perform the request on behalf of.

slugstring
Example:my-team-url-slug

The Team slug to perform the request on behalf of.

Response

The deployment was successfully deleted

uidstring required

The removed deployment ID.

state'DELETED' required

A constant with the final state of the deployment.

Example response

{
  "uid": "dpl_5WJWYSyB7BpgTj3EuwF37WMRBXBtPQ2iTMJHJBJyRfd"
}