apicheats.dev Cheat sheet Raw .md
PATCH

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

GitHub playground

Update a GitHub-hosted runner for an organization

Credentials

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

Path

Body application/json

9 body fields
  • name · optional · 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 '_'.
  • runner_group_id · optional · 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 updated with a static public IP. Note limit on account. To list limits on account, use `GET actions/hosted-runners/limits`
  • size · optional · string — The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes`
  • image_source · optional · string — The source type of the runner image to use. Must match the source of the image specified by `image_id`. Can be one of `github`, `partner`, or `custom`.
  • image_id · optional · string — The unique identifier of the runner image. To list available images, use `GET /actions/hosted-runners/images/github-owned`, `GET /actions/hosted-runners/images/partner`, or `GET /actions/hosted-runners/images/custom`.
  • image_version · optional · string — The version of the runner image to deploy. This is relevant only for runners using custom images.
  • image_gen · optional · boolean — Whether to enable image generation for this runner pool. When enabled, the runner pool is used to build and publish custom runner images.