Update a CI runner
Send only the fields you want to change. The GitHub organization cannot be changed.
mode can only change while no sandboxes are attached. Setting enabled to false detaches every attached sandbox. A reuse runner cannot be enabled until a sandbox is attached.
API key scope: ci_runner.update
Team role permission: ci_runner.update
Authorizations
API key created in the dashboard under Settings → API keys. Each key carries permission scopes; every endpoint lists the scope it needs.
Path Parameters
ID of the CI runner.
^[a-fA-F0-9]{24}$Body
Name of the runner, up to 64 characters.
1 - 64How jobs run. Switching to per_job needs a size and region, in this request or already on the runner.
reuse, per_job Sandbox size for each job in per_job mode, for example sbx.small.
ID of the sandbox region for per_job mode.
^[a-fA-F0-9]{24}$Most sandboxes to run at once in per_job mode.
1 <= x <= 20Whether the runner picks up jobs.