data.runner.list-instances ​
List runner instances for a runner group, or all org instances when no group is given
List runner instances for a runner group, or all org instances when no group is supplied (so an instance picker can resolve without a group).
Overview ​
| Property | Value |
|---|---|
| Workflow type | Atomic |
| Library | App-runners |
| Version | 1.0 |
Input Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
organization_uuid | uuid | Yes | — | UUID of the caller's organization, injected server-side from the authenticated request; scopes the operation to the correct tenant. |
runner_group_uuid | uuid | No | — | UUID of the RunnerGroup to filter instances by, picked from the organization's list of runner groups. Optional — when omitted, instances from every group in the organization are returned. |
limit | integer | No | 100 | — |
offset | integer | No | 0 | — |
Output Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
items | list | No | [] | — |
total | integer | No | 0 | — |
count | integer | No | 0 | — |
limit | integer | No | 0 | — |
offset | integer | No | 0 | — |
error | string | No | — | — |
error_type | string | No | — | — |
States ​
| State | Initial | Terminal | Success | Auto-advance | Description |
|---|---|---|---|---|---|
done | Yes | Yes | Yes | — | — |
API Usage ​
bash
POST /api/workflows/start
Content-Type: application/json
{
"workflow_type": "data.runner.list-instances",
"initial_data": {
"organization_uuid": "value"
}
}