Skip to content
Proud to collaborate with Microsoft for Startups

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 ​

PropertyValue
Workflow typeAtomic
LibraryApp-runners
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
organization_uuiduuidYes—UUID of the caller's organization, injected server-side from the authenticated request; scopes the operation to the correct tenant.
runner_group_uuiduuidNo—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.
limitintegerNo100—
offsetintegerNo0—

Output Schema ​

FieldTypeRequiredDefaultDescription
itemslistNo[]—
totalintegerNo0—
countintegerNo0—
limitintegerNo0—
offsetintegerNo0—
errorstringNo——
error_typestringNo——

States ​

StateInitialTerminalSuccessAuto-advanceDescription
doneYesYesYes——

API Usage ​

bash
POST /api/workflows/start
Content-Type: application/json

{
  "workflow_type": "data.runner.list-instances",
  "initial_data": {
    "organization_uuid": "value"
  }
}