Delete a Deployment

v1.0.0

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.

Input

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "The ID of the deployment to be deleted"
    },
    "teamId": {
      "type": "string"
    },
    "url": {
      "type": "string",
      "description": "A Deployment or Alias URL. In case it is passed, the ID will be ignored"
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": false
}

Output

{
  "type": "object",
  "required": [
    "state",
    "uid"
  ],
  "properties": {
    "state": {
      "type": "string",
      "description": "A constant with the final state of the deployment.",
      "enum": [
        "DELETED"
      ]
    },
    "uid": {
      "type": "string",
      "description": "The removed deployment ID."
    }
  }
}