Check sandbox readiness

sandboxReadiness(sandboxId: ID!): SandboxRuntimeCheck!

Requires project.sandboxes.manage.

Arguments

ArgumentTypeRequired
sandboxIdID!Yes

Response

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

FieldTypeDescription
okBoolean!Health: whether the sandbox runtime responds. Readiness: whether it is ready for work.
statusSandboxStatus!
reasonString

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

Example

graphql
query SandboxReadiness($sandboxId: ID!) {
  sandboxReadiness(sandboxId: $sandboxId) {
    status
    ok
    reason
  }
}
json
{
  "sandboxId": "00000000-0000-4000-8000-000000000001"
}