provider actions POST /orgs/{org}/actions/hosted-runners
@utdk/github /orgs/{org}/actions/hosted-runners
Create a GitHub-hosted runner for an organization
Creates a GitHub-hosted runner for an organization. OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint.
org path required
The organization name. The name is not case sensitive.
string

Try it

Authentication
Configure credentials for GitHub v3 REST API
Gateway
The gateway proxies requests and injects credentials server-side. Configure credentials above, then enter your gateway URL.

Saved automatically to browser storage.

actions.createHostedRunnerForOrg
POST/orgs/{org}/actions/hosted-runners
Creates a GitHub-hosted runner for an organization. OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint.

Parameters

required

The organization name. The name is not case sensitive.

Input

required

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 '_'.

required

The image of runner. To list all available images, use `GET /actions/hosted-runners/images/github-owned` or `GET /actions/hosted-runners/images/partner`.

required

The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes`

required

The existing runner group to add this runner to.

The maximum amount of runners to scale up to. Runners will not auto-scale above this number. Use this setting to limit your cost.

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`

Whether this runner should be used to generate custom images.

Enter a gateway URL above to enable sending.

Code snippet
Updates live as you fill in the form above.

TypeScript

import github from '@utdk/github';

await github.actions.createHostedRunnerForOrg({
  "image_gen": false
})