GitHub: Get a self-hosted runner group for an organization

← Actions operations · Get started

Operation github.actions_get_self_hosted_runner_group_for_org

Provider route: GET /orgs/{org}/actions/runner-groups/{runner_group_id}. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/github with npm, or alter-sdk-github with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { GitHubIntegration } from "@alter-ai/github";

async function execute(input: Parameters<GitHubIntegration["actions"]["actionsGetSelfHostedRunnerGroupForOrg"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new GitHubIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.actions.actionsGetSelfHostedRunnerGroupForOrg(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_github import GitHubIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = GitHubIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.actions.actions_get_self_hosted_runner_group_for_org(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.org	string	Required within parent
path.runner_group_id	integer	Required within parent

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	Model	Root	Expand Get a self-hosted runner group for an organization — response body

Referenced models: Get a self-hosted runner group for an organization — response body

Schemas

Get a self-hosted runner group for an organization — response body

Field	Type	Presence	Description and constraints
$	object	Root
allows_public_repositories	boolean	Required within parent
default	boolean	Required within parent
hosted_runners_url	string	Optional
id	JSON	Required within parent
id (anyOf 1)	number	Alternative
id (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
inherited	boolean	Required within parent
inherited_allows_public_repositories	boolean	Optional
name	string	Required within parent
network_configuration_id	string	Optional	The identifier of a hosted compute network configuration.
restricted_to_workflows	boolean	Optional	If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array. Default: false
runners_url	string	Required within parent
selected_repositories_url	string	Optional	Link to the selected repositories resource for this runner group. Not present unless visibility was set to `selected`
selected_workflows	array	Optional	List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`.
selected_workflows[]	string	Each item	Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required.
visibility	string	Required within parent
workflow_restrictions_read_only	boolean	Optional	If `true`, the `restricted_to_workflows` and `selected_workflows` fields cannot be modified. Default: false

Policy, approvals and errors

SDK function policy ID: github.actions_get_self_hosted_runner_group_for_org. Catalog operation: actions/get-self-hosted-runner-group-for-org. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Pinned headers: {"X-GitHub-Api-Version": "2026-03-10", "User-Agent": "Alter", "Accept": "application/vnd.github+json"}

Official provider source