data.runner.get-group ​
Get a runner group by uuid
Return a single runner group's full UUID-only payload.
Overview ​
| Property | Value |
|---|---|
| Workflow type | Atomic |
| Library | App-runners |
| Version | 1.0 |
Input Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
organization_uuid | uuid | Yes | — | UUID of the caller's organization, injected server-side from the authenticated request; scopes the operation to the correct tenant. |
runner_group_uuid | uuid | Yes | — | UUID of the RunnerGroup to fetch, picked from the organization's list of runner groups. |
Output Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
uuid | uuid | No | — | — |
organization_uuid | uuid | No | — | Organization UUID echoed from input. |
name | string | No | — | — |
description | string | No | — | — |
backend_type | string | No | — | — |
purpose | string | No | — | — |
integration_type | string | No | — | — |
hosted | boolean | No | — | 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_scope | string | No | — | — |
region | string | No | — | — |
status | string | No | — | — |
desired_count | integer | No | — | — |
min_count | integer | No | — | — |
max_count | integer | No | — | — |
active_runner_count | integer | No | — | Current non-terminal RunnerInstance count for warm-pool and DevKit groups; provider-health cached count for other backends. |
total_jobs_run | integer | No | — | — |
runner_labels | list | No | — | — |
config | dict | No | — | — |
cloud_connection_uuid | uuid | No | — | 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_uuid | uuid | No | — | UUID of the NetworkProfile bound to this runner group, picked from the organization's network profiles. Optional, omitted when absent. |
registry_account_uuid | uuid | No | — | 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_uuid | uuid | No | — | 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_uuid | uuid | No | — | 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_uuid | uuid | No | — | 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_uuid | uuid | No | — | 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_uuid | uuid | No | — | 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_kind | string | No | — | — |
gitlab_group_path | string | No | — | — |
active_workflow_uuid | string | No | — | 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_ref | integer | No | — | — |
github_runner_group_name | string | No | — | — |
asg_name | string | No | — | — |
ecs_cluster_arn | string | No | — | — |
ecs_cluster_name | string | No | — | — |
task_definition_arn | string | No | — | — |
log_group_name | string | No | — | — |
launch_type | string | No | — | — |
gce_mig_name | string | No | — | — |
gke_node_pool_ref | string | No | — | — |
k8s_namespace | string | No | — | — |
k8s_deployment_name | string | No | — | — |
azure_subscription_ref | string | No | — | — |
azure_resource_group | string | No | — | — |
azure_environment_name | string | No | — | — |
azure_job_name | string | No | — | — |
azure_job_resource_ref | string | No | — | — |
last_job_at | string | No | — | — |
created_at | string | No | — | — |
created_by | string | No | — | — |
error | string | No | — | — |
error_type | string | No | — | — |
States ​
| State | Initial | Terminal | Success | Auto-advance | Description |
|---|---|---|---|---|---|
done | Yes | Yes | Yes | — | — |
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"
}
}