Delete environment domain

deleteDomain(input: DeleteDomainInput!): DeleteDomainPayload

Requires project.domains.write.

Arguments

ArgumentTypeRequired
inputDeleteDomainInput!Yes

Input fields

input

DeleteDomainInput

FieldTypeRequired
environmentIdID!Yes
domainIdID!Yes

Response

Returns DeleteDomainPayload. 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 DeleteDomain($input: DeleteDomainInput!) {
  deleteDomain(input: $input) {
    ok
  }
}
json
{
  "input": {
    "environmentId": "00000000-0000-4000-8000-000000000001",
    "domainId": "00000000-0000-4000-8000-000000000001"
  }
}