Sign in

v18

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

UpdateRunnerStatus

Updates the runner's status and capabilities.

Use this method to:

  • Report runner health
  • Update version information
  • Signal system changes
  • Configure capabilities

Examples

  • Update status:

    Updates runner status and details.

    runnerId: "d2c94c27-3b76-4a42-b88c-95a85e392c68"
version: "1.2.3"
systemDetails: "Linux x86_64"
logUrl: "https://logs.example.com/runner"
region: "us-west"
capabilities: ["RUNNER_CAPABILITY_SECRET_CONTAINER_REGISTRY"]
post/gitpod.v1.RunnerInteractionService/UpdateRunnerStatus

Request body

capabilitiesGitpodV1RunnerCapability[]

capabilities contains the runner's supported capabilities. Optional field, only overwrites previous capabilities if set to a non-empty list. To clear capabilities, set this to a list with a single UNSPECIFIED capability.

degredationMessagestring nullable

Degredation message is an optional message that is shown to users when the runner is in a degraded state. Setting this to "" changes the runner's phase back from "degraded" to "active".

llmUrlstring nullable

llm_url is the URL of the LLM service to which the runner is connected.

logUrlstring uri nullable

log_url is the URL to the runner's logs

regionstring nullable

region is the region the runner is running in, if applicable.

runnerIdstring uuid

The runner's identity

supportBundleUrlstring nullable
systemDetailsstring nullable

system_details is a runner specific system detail string. Think of this like a user agent string. It's intended to be used for debugging and support purposes and might be shown to the user.

versionstring nullable

version is the version of the runner. This is used to detect if the runner is outdated.

Response

Success

GitpodV1UpdateRunnerStatusResponse required