---
title: "UpdateRunnerStatus"
method: POST
path: "/gitpod.v1.RunnerInteractionService/UpdateRunnerStatus"
tags: ["gitpod.v1.RunnerInteractionService"]
---

# UpdateRunnerStatus

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

   ```yaml
   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"]
   ```

## Request body

- GitpodV1UpdateRunnerStatusRequest
  - `additionalInfo` GitpodV1FieldValueUpdate[] — additional_info updates fields in the runner's additional_info.
    - `key` string — key is the field key to update. If the field does not exist, it will be created.
    - `value` string, nullable — value is the new value for the field. If value is empty, the field will be removed.
  - `capabilities` GitpodV1RunnerCapability[] — 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.
  - `degredationMessage` string, 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".
  - `logUrl` string, uri, nullable — log_url is the URL to the runner's logs
  - `region` string, nullable — region is the region the runner is running in, if applicable.
  - `runnerId` string, uuid — The runner's identity
  - `systemDetails` string, 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.
  - `version` string, nullable — version is the version of the runner. This is used to detect if the runner is outdated.

## Response `200`

Success

- GitpodV1UpdateRunnerStatusResponse

## Other responses

- `default` — Error

## Changes

- **2025-02-18** `cd6a05ae99d2` — 1 warning
  - removed the optional property `detail` from the response with the `default` status
- **2025-02-18** `f6598ab5d682` — 1 info
  - added the new `RUNNER_CAPABILITY_SECRET_CONTAINER_REGISTRY` enum value to the request property `capabilities/items/`

[Change history](https://skmtc.dev/gitpod-io/apis/gitpod-v1/changes/gitpod.v1.RunnerInteractionService/UpdateRunnerStatus/post.md)

---

[API](https://skmtc.dev/gitpod-io/apis/gitpod-v1.md) · [All operations](https://skmtc.dev/gitpod-io/apis/gitpod-v1/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/gitpod-io/gitpod-v1/revisions/3655d5ad0ac3/schema)
