Skip to content
Proud to collaborate with Microsoft for Startups

data.runner.pool-status ​

Read-only snapshot of a warm-pool runner group: composition counts (provisioning/warm_idle/busy/draining/failed/terminated_in_last_5m), effective warm_pool config, and per-instance stats. Org-scoped.

Read-only warm-pool snapshot for a runner group.

Output mirrors the periodic pool-snapshot event from ADR-016 but surfaces it on demand. per_instance is sorted by created_at ascending so frontend renderers can show the oldest VM at the top (which is usually the most interesting one for rotation decisions).

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_uuiduuidYes—UUID of the RunnerGroup this warm-pool snapshot is for, picked from the organization's list of runner groups.

Output Schema ​

FieldTypeRequiredDefaultDescription
runner_group_uuiduuidNo—UUID of the RunnerGroup this snapshot is for, echoed back from input.
warm_pool_enabledbooleanNo——
compositiondictNo——
configdictNo——
per_instancelistNo——
snapshot_atstringNo——
errorstringNo——
error_typestringNo——

States ​

StateInitialTerminalSuccessAuto-advanceDescription
doneYesYesYes——

API Usage ​

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

{
  "workflow_type": "data.runner.pool-status",
  "initial_data": {
    "organization_uuid": "value",
    "runner_group_uuid": "value"
  }
}