Delete server

deleteServer(input: DeleteServerInput!): DeleteServerPayload!

Requires project.runtime.manage; API keys also need delete scope.

Arguments

ArgumentTypeRequired
inputDeleteServerInput!Yes

Input fields

input

DeleteServerInput

FieldTypeRequired
idID!Yes
projectReferenceStringNo

Response

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

FieldTypeDescription
okBoolean!Always true: the server was marked deleting. A server missing from the project answers a not-found error.

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

Example

graphql
mutation DeleteServer($input: DeleteServerInput!) {
  deleteServer(input: $input) {
    ok
  }
}
json
{
  "input": {
    "id": "00000000-0000-4000-8000-000000000001",
    "projectReference": "00000000-0000-4000-8000-000000000001"
  }
}