provider actions PATCH /orgs/{org}/actions/hosted-runners/{hosted_runner_id}
@utdk/github /orgs/{org}/actions/hosted-runners/{hosted_runner_id}
Update a GitHub-hosted runner for an organization
Updates a GitHub-hosted runner for an organization. OAuth app 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
hosted_runner_id path required
Unique identifier of the GitHub-hosted runner.
integer

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.updateHostedRunnerForOrg
PATCH/orgs/{org}/actions/hosted-runners/{hosted_runner_id}
Updates a GitHub-hosted runner for an organization. OAuth app 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.

required

Unique identifier of the GitHub-hosted runner.

Input

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

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 updated with a static public IP. Note limit on account. To list limits on account, use `GET actions/hosted-runners/limits`

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

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`.

The version of the runner image to deploy. This is relevant only for runners using 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.updateHostedRunnerForOrg()