Skip to main content
GET
List a run's active sandboxes
Lists the sandboxes the run’s running steps hold: stepId, sandboxId, the lineageId and runtime of the lineage the step created snapshots in (null when none), agent and startedAt. phase is always running: this read joins running steps with the run’s lineages and knows nothing finer.

Visibility

You need factories:read at the run’s home (its own org unit, else its workflow’s owning org unit) and at every company it carries. Any other run, and a run with neither home, answers 404 like a missing one. A Personal key reads as its owner, cut down to the key’s scopes; an External App reads by its own role grants.

Authorizations

Authorization
string
header
required

An External App: the JWT it obtains from POST /oauth/token with OAuth2 client_credentials. Pass as Authorization: Bearer <jwt>. An app's static companion key also authenticates as the app, but is deprecated and is not protected by Idempotency-Key.

Path Parameters

runId
string
required

The workflow run.

Minimum string length: 1

Query Parameters

limit
integer

Items per page, 1 to 1000; a larger value is a 400 too_big. Omitted, the page is the whole list. The list is read whole.

Required range: 1 <= x <= 1000
cursor
string

The previous page's meta.nextCursor; any other value is 400.

Minimum string length: 1

Response

The run's active sandboxes

data
object
required
meta
object
required

A list page's continuation. While hasMore is true, nextCursor is a string: pass it as cursor for the next page. hasMore: false ends the list; with truncated: true, more exist past what this list reads, and no cursor reaches them.