Start sandbox background command - Veryfront

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

Requires project.sandboxes.manage.

Arguments

Argument	Type	Required
`sandboxId`	`ID!`	Yes
`input`	`SandboxCommandInput!`	Yes

Input fields

input

SandboxCommandInput

Field	Type	Required
`command`	`String!`	Yes
`cwd`	`String`	No
`timeoutSeconds`	`Int`	No
`env`	`StringMap`	No

Response

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

Field	Type
`commandId`	`ID!`
`command`	`String!`
`status`	`SandboxBackgroundCommandStatus!`
`signal`	`String`
`heartbeatStatus`	`SandboxCommandHeartbeatStatus!`
`lastHeartbeatAt`	`DateTime`
`lastHeartbeatError`	`String`
`heartbeatFailureCount`	`Int!`

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

mutation StartSandboxBackgroundCommand($sandboxId: ID!, $input: SandboxCommandInput!) {
  startSandboxBackgroundCommand(sandboxId: $sandboxId, input: $input) {
    status
    exitCode
    command
    commandId
    finishedAt
  }
}

{
  "sandboxId": "00000000-0000-4000-8000-000000000001",
  "input": {
    "command": "example"
  }
}