Delete environment

deleteEnvironment(input: DeleteEnvironmentInput!): DeleteEnvironmentPayload

Requires project.environments.manage.

Arguments

ArgumentTypeRequired
inputDeleteEnvironmentInput!Yes

Input fields

input

DeleteEnvironmentInput

FieldTypeRequired
idID!Yes

Response

Returns DeleteEnvironmentPayload. Open the type for its fields and nested types.

FieldTypeDescription
okBoolean!Always true: the deletion completed. A failed deletion is a GraphQL error.

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

Example

graphql
mutation DeleteEnvironment($input: DeleteEnvironmentInput!) {
  deleteEnvironment(input: $input) {
    ok
  }
}
json
{
  "input": {
    "id": "00000000-0000-4000-8000-000000000001"
  }
}