Delete deployment

deleteDeployment(input: DeleteDeploymentInput!): DeleteDeploymentPayload!

Requires project.deployments.write; API keys also need delete scope.

Arguments

ArgumentTypeRequired
inputDeleteDeploymentInput!Yes

Input fields

input

DeleteDeploymentInput

FieldTypeRequired
idID!Yes

Response

Returns DeleteDeploymentPayload!. Open the type for its fields and nested types.

FieldTypeDescription
okBoolean!Always true.

Types marked with ! cannot be null. Lists use [Type] notation. The type index lists all published input and response types.

Example

graphql
mutation DeleteDeployment($input: DeleteDeploymentInput!) {
  deleteDeployment(input: $input) {
    ok
  }
}
json
{
  "input": {
    "id": "00000000-0000-4000-8000-000000000001"
  }
}