POST

Try POST /orgs/{org}/actions/hosted-runners — GitHub API

GitHub playground

Create a GitHub-hosted runner for an organization

Credentials

GitHub token · sent as Authorization

Kept in this tab only. Requests go through apicheats.dev's same-origin proxy straight to api.github.com; the proxy stores and logs nothing about them.

Headers

Accept · fixedX-GitHub-Api-Version · fixed

Path

org · required · string The organization name. The name is not case sensitive.

Body application/json

7 body fields

name · required · string — 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 '_'.
image · required · object — The image of runner. To list all available images, use `GET /actions/hosted-runners/images/github-owned` or `GET /actions/hosted-runners/images/partner`.
size · required · string — The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes`
runner_group_id · required · integer — The existing runner group to add this runner to.
maximum_runners · optional · integer — The maximum amount of runners to scale up to. Runners will not auto-scale above this number. Use this setting to limit your cost.
enable_static_ip · optional · boolean — 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`
image_gen · optional · boolean — Whether this runner should be used to generate custom images.