Skip to content
Proud to collaborate with Microsoft for Startups

data.runner.group-update ​

Patch a runner group's editable fields (max_count, min_count, desired_count, runner_labels, config, description). Org-scoped from the Bearer token. Does NOT trigger re-provisioning. config.warm_pool is validated against the warm-pool schema (see ADRs 002/009/010/011/012); structurally invalid configs or isolation/enabled conflicts are rejected.

Patch an existing RunnerGroup row from UUID-keyed input.

Overview ​

PropertyValue
Workflow typeAtomic
LibraryApp-runners
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
runner_group_uuiduuidYes—UUID of the RunnerGroup to patch, picked from the organization's list of runner groups.
organization_uuiduuidNo—Ignored when present — org is resolved from auth context
max_countintegerNo——
min_countintegerNo——
desired_countintegerNo——
runner_labelslistNo——
descriptionstringNo——
configdictNo——
config_strategystringNo—'merge' (default) or 'replace'
actor_uuiduuidNo—UUID of the user or service actor who triggered this action, injected server-side from the authenticated request; used for audit/attribution only. Optional — omit for system or service-triggered actions with no human actor.
workflow_run_idstringNo—DAG parent run ID (stamped by engine)

Output Schema ​

FieldTypeRequiredDefaultDescription
runner_group_uuiduuidNo—UUID of the patched RunnerGroup, echoed back. Also resolvable via the organization's list of runner groups.
updated_fieldslistNo——
updated_atstringNo——
errorstringNo——
error_typestringNo——

States ​

StateInitialTerminalSuccessAuto-advanceDescription
doneYesYesYes—Group patched

API Usage ​

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

{
  "workflow_type": "data.runner.group-update",
  "initial_data": {
    "runner_group_uuid": "value"
  }
}