v18

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-014211,6201.8 MB
gitpod.v1.RunnerService

UpdateRunner

Updates a runner's configuration.

Use this method to:

  • Modify runner settings
  • Update release channels
  • Change runner status
  • Configure auto-update settings

Examples

  • Update configuration:

    Changes runner settings.

    runnerId: "d2c94c27-3b76-4a42-b88c-95a85e392c68"
    name: "Updated Runner Name"
    spec:
      configuration:
        releaseChannel: RUNNER_RELEASE_CHANNEL_LATEST
        autoUpdate: true
    
post/gitpod.v1.RunnerService/UpdateRunner

Request body

namestring nullable

The runner's name which is shown to users

runnerIdstring uuid

runner_id specifies which runner to be updated.

+required

Response

Success

GitpodV1UpdateRunnerResponse required