Skip to content
Proud to collaborate with Microsoft for Startups

runner.github-runner-group.add-existing-runners ​

Associate already-registered GitHub organization runners with an existing GitHub runner group without creating or deleting runners

Add already-registered GitHub organization runners to an existing runner group.

PUT /orgs/{org}/actions/runner-groups/{id}/runners/{runner_id} for each id. Does not create or delete runners, and does not create a GitHub runner group.

Overview ​

PropertyValue
Workflow typeAtomic
LibraryApp-runners
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
runner_group_uuiduuidYes—UUID of the Orkestia RunnerGroup whose bound GitHub group should receive the existing runners.
organization_uuiduuidYes—UUID of the caller's organization, injected server-side from the authenticated request.
github_runner_idslistYes—Existing GitHub organization runner ids to associate. Must already be registered. Never created or deleted.
github_runner_group_refintegerNo—GitHub organization runner-group id. Defaults to the ref already bound on the Orkestia RunnerGroup.
actor_uuiduuidNo——

Output Schema ​

FieldTypeRequiredDefaultDescription
runner_group_uuiduuidNo—UUID of the RunnerGroup this action operates on, picked from the organization's list of runner groups; echoed on output alongside terminal/error payloads.
organization_uuiduuidNo—UUID of the caller's organization, injected server-side from the authenticated request; scopes the operation to the correct tenant. Echoed on output alongside terminal/error payloads.
runner_execution_uuiduuidNo—UUID of the RunnerExecution this action operates on, picked from the organization's (optionally group-scoped) list of executions; echoed on output alongside terminal/error payloads.
workflow_uuidstringNo—Engine workflow-run identifier (or, for GitHub-Actions-triggered flows, an external GitHub Actions run id) associated with this record; not a platform entity foreign key despite the name. No source is attached since there is no list/query workflow for an internal run id.
statusstringNo——
outcomestringNo——
initiated_atstringNo——
completed_atstringNo——
failed_atstringNo——
failure_reasonstringNo——
errorstringNo——
error_typestringNo——
actor_uuiduuidNo—UUID of the user or service actor who triggered this action, injected server-side from the authenticated request when available; used for audit/attribution only. Optional — omitted for system or service-triggered actions with no human actor.
reasonstringNo——
workflow_run_uuidstringNo—Engine-stamped correlation/run id for this DAG execution (ADR-015/E1 plumbing), written into state_data by action_start; not a foreign key to any business entity. No source is attached since there is no list/query workflow for an internal run id.
retry_countintegerNo——
retried_fromstringNo——
failed_stepjsonNo——
failed_layerjsonNo——
failed_at_statejsonNo——
compensation_triggerjsonNo——
comp_current_layerjsonNo——
comp_queuejsonNo——
comp_retry_countjsonNo——
github_runner_group_refintegerNo——
github_runner_group_namestringNo——
github_runner_idslistNo——
added_github_runner_idslistNo——
already_in_group_idslistNo——
github_runners_countintegerNo——
associated_atstringNo——
failure_typestringNo——
failed_actionstringNo——

States ​

StateInitialTerminalSuccessAuto-advanceDescription
pendingYesNo—execute—
completedNoYesYes——
failedNoYesNo——

State Diagram ​

Transitions ​

FromActionToDescription
pendingexecutecompleted—
* (any state)failfailed—

API Usage ​

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

{
  "workflow_type": "runner.github-runner-group.add-existing-runners",
  "initial_data": {
    "runner_group_uuid": "value",
    "organization_uuid": "value",
    "github_runner_ids": "value"
  }
}