Sign in
Human-in-the-Loop

Retrieve Run Sandbox Details

Returns provider-neutral details about the sandbox owned by this run, including identity, normalized state, image/snapshot, resources, labels, and timestamps.

get/api/v1/runs/{id}/sandbox

Path parameters

idstring required

Unique run identifier (ULID).

Response

Sandbox details

state'unknown' | 'provisioning' | 'starting' | 'running' | 'stopping' | 'stopped' | 'paused' | 'deleting' | 'deleted' | 'archived' | 'restoring' | 'resizing' | 'error' required

Normalized sandbox lifecycle state used by the control plane and UI. The original provider-specific state string is preserved in native_state.

native_statestring nullable

Original provider state string before normalization. Display/debugging only; UI behavior keys off state.

regionstring nullable

Provider region or target. Null for local-style providers.

web_urlstring nullable

Provider dashboard URL for this sandbox when available.

labelsobject required

Provider-reported labels.

Changes

Changed in 1 of the 135 revisions of this API.310

  • 1fa851815cf2310See the full diff
    • ▲

      the response property sandbox/image became optional for the status 200

      response-property-became-optional

    • ▲

      the response property sandbox/snapshot became optional for the status 200

      response-property-became-optional

    • ▲

      the sandbox/runtime response's property type/format changed from / to object/ for status 200

      response-property-type-changed

    • ○

      added the optional property sandbox/runtime/primary_repo_link to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property sandbox/runtime/primary_repo_path to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property sandbox/runtime/repos_root to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property sandbox/runtime/workspace_root to the response with the 200 status

      response-optional-property-added

    • ○

      removed RunSandboxRuntime subschema #2 from the sandbox/runtime response property oneOf list for the response status 200

      response-property-one-of-removed

    • ○

      added the required property sandbox/runtime/clone_branch to the response with the 200 status

      response-required-property-added

    • ○

      added the required property sandbox/runtime/clone_origin_url to the response with the 200 status

      response-required-property-added

    • ○

      added the required property sandbox/runtime/id to the response with the 200 status

      response-required-property-added

    • ○

      added the required property sandbox/runtime/repo_cloned to the response with the 200 status

      response-required-property-added

    • ○

      added the required property sandbox/runtime/working_directory to the response with the 200 status

      response-required-property-added