Start sandbox background command

startSandboxBackgroundCommand(sandboxId: ID!, input: SandboxCommandInput!): SandboxBackgroundCommand!

Requires project.sandboxes.manage.

Arguments

ArgumentTypeRequired
sandboxIdID!Yes
inputSandboxCommandInput!Yes

Input fields

input

SandboxCommandInput

FieldTypeRequired
commandString!Yes
cwdStringNo
timeoutSecondsIntNo
envStringMapNo

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 StartSandboxBackgroundCommand($sandboxId: ID!, $input: SandboxCommandInput!) {
  startSandboxBackgroundCommand(sandboxId: $sandboxId, input: $input) {
    status
    exitCode
    command
    commandId
    finishedAt
  }
}
json
{
  "sandboxId": "00000000-0000-4000-8000-000000000001",
  "input": {
    "command": "example"
  }
}