Update sandbox lifetime

updateSandboxLifetime(sandboxId: ID!, input: SandboxLifetimeInput!): Sandbox!

Requires project.sandboxes.manage.

Arguments

ArgumentTypeRequired
sandboxIdID!Yes
inputSandboxLifetimeInput!Yes

Input fields

input

SandboxLifetimeInput

FieldTypeRequired
ttlModeSandboxLifetimeMode!Yes
ttlHoursIntNo

Response

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

FieldType
idID!
accessScopeSandboxAccessScope!
workspaceStorageSandboxWorkspaceStorage!
shortIdString!
endpointString!
statusSandboxStatus!
ttlModeSandboxLifetimeMode!
ttlHoursInt

All fields of Sandbox.

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

Example

graphql
mutation UpdateSandboxLifetime($sandboxId: ID!, $input: SandboxLifetimeInput!) {
  updateSandboxLifetime(sandboxId: $sandboxId, input: $input) {
    id
    projectId
    runId
    status
    createdAt
  }
}
json
{
  "sandboxId": "00000000-0000-4000-8000-000000000001",
  "input": {
    "ttlMode": "default"
  }
}