Cancel sandbox background command

cancelSandboxBackgroundCommand(sandboxId: ID!, commandId: ID!): SandboxBackgroundCommand!

Requires project.sandboxes.manage.

Arguments

ArgumentTypeRequired
sandboxIdID!Yes
commandIdID!Yes

Response

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

FieldType
commandIdID!
commandString!
statusSandboxBackgroundCommandStatus!
signalString
heartbeatStatusSandboxCommandHeartbeatStatus!
lastHeartbeatAtDateTime
lastHeartbeatErrorString
heartbeatFailureCountInt!

All fields of SandboxBackgroundCommand.

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

Example

graphql
mutation CancelSandboxBackgroundCommand($sandboxId: ID!, $commandId: ID!) {
  cancelSandboxBackgroundCommand(sandboxId: $sandboxId, commandId: $commandId) {
    status
    exitCode
    command
    commandId
    finishedAt
  }
}
json
{
  "sandboxId": "00000000-0000-4000-8000-000000000001",
  "commandId": "00000000-0000-4000-8000-000000000001"
}