---
title: "GetRunnerConfigurationSchema"
method: POST
path: "/gitpod.v1.RunnerConfigurationService/GetRunnerConfigurationSchema"
tags: ["gitpod.v1.RunnerConfigurationService"]
---

# GetRunnerConfigurationSchema

`POST /gitpod.v1.RunnerConfigurationService/GetRunnerConfigurationSchema`

Gets the latest runner configuration schema.

 Use this method to:
 - View available settings
 - Check configuration options
 - Validate configurations

 ### Examples

 - Get schema:

   Retrieves configuration schema for a runner.

   ```yaml
   runnerId: "d2c94c27-3b76-4a42-b88c-95a85e392c68"
   ```

## Request body

- GitpodV1GetRunnerConfigurationSchemaRequest
  - `runnerId` string, uuid

## Response `200`

Success

- GitpodV1GetRunnerConfigurationSchemaResponse
  - `schema` GitpodV1RunnerConfigurationSchema — unresolved $ref

## Other responses

- `default` — Error

## Changes

- **2025-06-10** `ca9a49ac7fbb` — 10 info
  - added the optional property `schema/environmentClasses/items/enum/defaultValue` to the response with the `200` status
  - added the optional property `schema/environmentClasses/items/enum/possibleValues` to the response with the `200` status
  - added the optional property `schema/runnerConfig/items/enum/defaultValue` to the response with the `200` status
  - added the optional property `schema/runnerConfig/items/enum/possibleValues` to the response with the `200` status
  - …6 more
- **2025-02-21** `3655d5ad0ac3` — 1 breaking, 5 info
  - the `schema` response's property type/format changed from ``/`` to `object`/`` for status `200`
  - added the optional property `schema/environmentClasses` to the response with the `200` status
  - added the optional property `schema/runnerConfig` to the response with the `200` status
  - added the optional property `schema/scm` to the response with the `200` status
  - …2 more
- **2025-02-18** `cd6a05ae99d2` — 1 warning
  - removed the optional property `detail` from the response with the `default` status

[Change history](https://skmtc.dev/gitpod-io/apis/gitpod-v1/changes/gitpod.v1.RunnerConfigurationService/GetRunnerConfigurationSchema/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/b97dcde84128/schema)