Skip to content
Proud to collaborate with Microsoft for Startups

data.runner.get-group ​

Get a runner group by uuid

Return a single runner group's full UUID-only payload.

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 to fetch, picked from the organization's list of runner groups.

Output Schema ​

FieldTypeRequiredDefaultDescription
uuiduuidNo——
organization_uuiduuidNo—Organization UUID echoed from input.
namestringNo——
descriptionstringNo——
backend_typestringNo——
purposestringNo——
integration_typestringNo——
hostedbooleanNo—True when the group is Orkestia-hosted — compute we run and pay for in our own cluster. False for bring-your-own-cloud groups, where the customer's provider bills them directly. Tenancy, not backend: hosted groups are ordinary kubernetes groups (ADR-007). Server-owned; never customer-writable.
runner_scopestringNo——
regionstringNo——
statusstringNo——
desired_countintegerNo——
min_countintegerNo——
max_countintegerNo——
active_runner_countintegerNo—Current non-terminal RunnerInstance count for warm-pool and DevKit groups; provider-health cached count for other backends.
total_jobs_runintegerNo——
runner_labelslistNo——
configdictNo——
cloud_connection_uuiduuidNo—UUID of the CloudConnection backing this runner group's cloud backend, picked from the organization's connections. Optional — omitted when the group has none configured.
network_profile_uuiduuidNo—UUID of the NetworkProfile bound to this runner group, picked from the organization's network profiles. Optional, omitted when absent.
registry_account_uuiduuidNo—UUID of the container registry account this runner group resolves images against, picked from the organization's registry accounts. Optional — omitted when absent, falling back to default/unauthenticated image resolution.
image_pull_cloud_connection_uuiduuidNo—UUID of the CloudConnection used to authenticate image pulls for this runner group, picked from the organization's connections. Optional — omitted when absent, falling back to cloud_connection_uuid.
github_installation_uuiduuidNo—UUID of the GitHub App installation bound to this runner group's GitHub integration. Optional, omitted when absent — no list/query workflow exists yet for this entity; must be supplied by the caller.
github_repository_uuiduuidNo—UUID of the GitHub repository this runner group is scoped to, picked from the organization's repositories. Optional, omitted when absent — only set for repository-scoped groups.
gitlab_connection_uuiduuidNo—UUID of the GitLab CloudConnection bound to this runner group, picked from the organization's GitLab connections. Optional, omitted when absent — only set for GitLab-integrated groups.
gitlab_project_uuiduuidNo—UUID of the GitLab project this runner group is scoped to. Optional, omitted when absent — no list/query workflow exists yet for this entity; must be supplied by the caller.
gitlab_target_kindstringNo——
gitlab_group_pathstringNo——
active_workflow_uuidstringNo—Engine workflow-instance id of the runner group's in-flight lifecycle workflow, if any; an internal engine run id, not a business entity with a picker. Optional, omitted when absent — server-computed diagnostic output, never user-set.
github_runner_group_refintegerNo——
github_runner_group_namestringNo——
asg_namestringNo——
ecs_cluster_arnstringNo——
ecs_cluster_namestringNo——
task_definition_arnstringNo——
log_group_namestringNo——
launch_typestringNo——
gce_mig_namestringNo——
gke_node_pool_refstringNo——
k8s_namespacestringNo——
k8s_deployment_namestringNo——
azure_subscription_refstringNo——
azure_resource_groupstringNo——
azure_environment_namestringNo——
azure_job_namestringNo——
azure_job_resource_refstringNo——
last_job_atstringNo——
created_atstringNo——
created_bystringNo——
errorstringNo——
error_typestringNo——

States ​

StateInitialTerminalSuccessAuto-advanceDescription
doneYesYesYes——

API Usage ​

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

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