GitHub: Create a Git Hub-hosted runner for an organization

GitHub actions.actionsCreateHostedRunnerForOrg: arguments, response, policy and SDK examples.

Operation github.actions_create_hosted_runner_for_org

Provider route: POST /orgs/{org}/actions/hosted-runners. 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"]["actionsCreateHostedRunnerForOrg"]>[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.actionsCreateHostedRunnerForOrg(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_create_hosted_runner_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
`body`	object	Required within parent
`body.enable_static_ip`	boolean	Optional	Whether this runner should be created with a static public IP. Note limit on account. To list limits on account, use `GET actions/hosted-runners/limits`
`body.image`	object	Required within parent	The image of runner. To list all available images, use `GET /actions/hosted-runners/images/github-owned` or `GET /actions/hosted-runners/images/partner`.
`body.image.id`	string	Optional	The unique identifier of the runner image.
`body.image.source`	string	Optional	The source of the runner image. One of: github, partner, custom
`body.image.version`	JSON	Optional
`body.image.version (anyOf 1)`	string	Alternative	The version of the runner image to deploy. This is relevant only for runners using custom images.
`body.image.version (anyOf 2)`	null	Alternative
`body.image_gen`	boolean	Optional	Whether this runner should be used to generate custom images. Default: false
`body.maximum_runners`	integer	Optional	The maximum amount of runners to scale up to. Runners will not auto-scale above this number. Use this setting to limit your cost.
`body.name`	string	Required within parent	Name of the runner. Must be between 1 and 64 characters and may only contain upper and lowercase letters a-z, numbers 0-9, ’.’, ’-’, and ’_’.
`body.runner_group_id`	integer	Required within parent	The existing runner group to add this runner to.
`body.size`	string	Required within parent	The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes`

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 Git Hub-hosted runner for an organization — response body

Referenced models: Get a Git Hub-hosted runner for an organization — response body

Schemas

Get a Git Hub-hosted runner for an organization — response body

Field	Type	Presence	Description and constraints
`$`	object	Root	A Github-hosted hosted runner.
`id`	JSON	Required within parent
`id (anyOf 1)`	integer	Alternative	The unique identifier of the hosted runner.
`id (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`image_details`	Model	Required within parent	Expand Get a Git Hub-hosted runner for an organization — response body — image details
`image_gen`	boolean	Optional	Whether custom image generation is enabled for the hosted runners.
`last_active_on`	JSON	Optional
`last_active_on (anyOf 1)`	string	Alternative	The time at which the runner was last used, in ISO 8601 format. Format: date-time
`last_active_on (anyOf 2)`	null	Alternative
`machine_size_details`	Model	Required within parent	Expand Get a Git Hub-hosted runner for an organization — response body — machine size details
`maximum_runners`	JSON	Optional
`maximum_runners (anyOf 1)`	integer	Alternative	The maximum amount of hosted runners. Runners will not scale automatically above this number. Use this setting to limit your cost. Default: 10
`maximum_runners (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`name`	string	Required within parent	The name of the hosted runner.
`platform`	string	Required within parent	The operating system of the image.
`public_ip_enabled`	boolean	Required within parent	Whether public IP is enabled for the hosted runners.
`public_ips`	array	Optional	The public IP ranges when public IP is enabled for the hosted runners.
`public_ips[]`	Model	Each item	Expand Get a Git Hub-hosted runner for an organization — response body — public ips item
`runner_group_id`	JSON	Optional
`runner_group_id (anyOf 1)`	integer	Alternative	The unique identifier of the group that the hosted runner belongs to.
`runner_group_id (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`status`	string	Required within parent	The status of the runner. Known values: Ready, Provisioning, Shutdown, Deleting, Stuck

Referenced models: Get a Git Hub-hosted runner for an organization — response body — machine size details, Get a Git Hub-hosted runner for an organization — response body — image details, Get a Git Hub-hosted runner for an organization — response body — public ips item

Get a Git Hub-hosted runner for an organization — response body — machine size details

Field	Type	Presence	Description and constraints
`$`	object	Root	Provides details of a particular machine spec.
`cpu_cores`	JSON	Required within parent
`cpu_cores (anyOf 1)`	integer	Alternative	The number of cores.
`cpu_cores (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`id`	string	Required within parent	The ID used for the `size` parameter when creating a new runner.
`memory_gb`	JSON	Required within parent
`memory_gb (anyOf 1)`	integer	Alternative	The available RAM for the machine spec.
`memory_gb (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`storage_gb`	JSON	Required within parent
`storage_gb (anyOf 1)`	integer	Alternative	The available SSD storage for the machine spec.
`storage_gb (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Get a Git Hub-hosted runner for an organization — response body — image details

Field	Type	Presence	Description and constraints
`$`	JSON	Root
`$ (anyOf 1)`	object	Alternative	Provides details of a hosted runner image
`$ (anyOf 1).display_name`	string	Required within parent	Display name for this image.
`$ (anyOf 1).id`	string	Required within parent	The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.
`$ (anyOf 1).size_gb`	JSON	Required within parent
`$ (anyOf 1).size_gb (anyOf 1)`	integer	Alternative	Image size in GB.
`$ (anyOf 1).size_gb (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`$ (anyOf 1).source`	string	Required within parent	The image provider. Known values: github, partner, custom
`$ (anyOf 1).version`	string	Optional	The image version of the hosted runner pool.
`$ (anyOf 2)`	null	Alternative

Get a Git Hub-hosted runner for an organization — response body — public ips item

Field	Type	Presence	Description and constraints
`$`	object	Root	Provides details of Public IP for a GitHub-hosted larger runners
`enabled`	boolean	Optional	Whether public IP is enabled.
`length`	JSON	Optional
`length (anyOf 1)`	integer	Alternative	The length of the IP prefix.
`length (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`prefix`	string	Optional	The prefix for the public IP.

Policy, approvals and errors

SDK function policy ID: github.actions_create_hosted_runner_for_org. Catalog operation: actions/create-hosted-runner-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

Report an issue with this page