Skip to content
Ona API Reference
Ona Docs
API Reference
Runners
Configurations
Schema

GetRunnerConfigurationSchema

runners.configurations.schema.retrieve(SchemaRetrieveParams**kwargs) -> SchemaRetrieveResponse
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.

    runnerId: "d2c94c27-3b76-4a42-b88c-95a85e392c68"
ParametersExpand Collapse
runner_id: Optional[str]
formatuuid
ReturnsExpand Collapse
class SchemaRetrieveResponse: …
schema: Optional[RunnerConfigurationSchema]
environment_classes: Optional[List[EnvironmentClass]]
id: Optional[str]
bool: Optional[EnvironmentClassBool]
default: Optional[bool]
description: Optional[str]
display: Optional[EnvironmentClassDisplay]
default: Optional[str]
enum: Optional[EnvironmentClassEnum]
Deprecateddefault: Optional[str]

deprecated, will be removed, use default_value instead

default_value: Optional[EnvironmentClassEnumDefaultValue]
detail: Optional[str]
subtitle: Optional[str]
title: Optional[str]
possible_values: Optional[List[EnvironmentClassEnumPossibleValue]]
detail: Optional[str]
subtitle: Optional[str]
title: Optional[str]
Deprecatedvalues: Optional[List[str]]

deprecated, will be removed, use possible_values instead

int: Optional[EnvironmentClassInt]
default: Optional[int]
formatint32
max: Optional[int]
formatint32
min: Optional[int]
formatint32
name: Optional[str]
required: Optional[bool]
secret: Optional[bool]
string: Optional[EnvironmentClassString]
default: Optional[str]
pattern: Optional[str]
runner_config: Optional[List[RunnerConfig]]
id: Optional[str]
bool: Optional[RunnerConfigBool]
default: Optional[bool]
description: Optional[str]
display: Optional[RunnerConfigDisplay]
default: Optional[str]
enum: Optional[RunnerConfigEnum]
Deprecateddefault: Optional[str]

deprecated, will be removed, use default_value instead

default_value: Optional[RunnerConfigEnumDefaultValue]
detail: Optional[str]
subtitle: Optional[str]
title: Optional[str]
possible_values: Optional[List[RunnerConfigEnumPossibleValue]]
detail: Optional[str]
subtitle: Optional[str]
title: Optional[str]
Deprecatedvalues: Optional[List[str]]

deprecated, will be removed, use possible_values instead

int: Optional[RunnerConfigInt]
default: Optional[int]
formatint32
max: Optional[int]
formatint32
min: Optional[int]
formatint32
name: Optional[str]
required: Optional[bool]
secret: Optional[bool]
string: Optional[RunnerConfigString]
default: Optional[str]
pattern: Optional[str]
scm: Optional[List[Scm]]
default_hosts: Optional[List[str]]
name: Optional[str]
oauth: Optional[ScmOAuth]
callback_url: Optional[str]

callback_url is the URL the OAuth app will redirect to after the user has authenticated.

pat: Optional[ScmPat]
description: Optional[str]

description is a human-readable description of the PAT.

scm_id: Optional[str]
version: Optional[str]

The schema version

GetRunnerConfigurationSchema

import os
from gitpod import Gitpod

client = Gitpod(
    bearer_token=os.environ.get("GITPOD_API_KEY"),  # This is the default and can be omitted
)
schema = client.runners.configurations.schema.retrieve(
    runner_id="d2c94c27-3b76-4a42-b88c-95a85e392c68",
)
print(schema.schema)
{
  "schema": {
    "environmentClasses": [
      {
        "id": "id",
        "bool": {
          "default": true
        },
        "description": "description",
        "display": {
          "default": "default"
        },
        "enum": {
          "default": "default",
          "defaultValue": {
            "detail": "detail",
            "subtitle": "subtitle",
            "title": "title"
          },
          "possibleValues": [
            {
              "detail": "detail",
              "subtitle": "subtitle",
              "title": "title"
            }
          ],
          "values": [
            "string"
          ]
        },
        "int": {
          "default": 0,
          "max": 0,
          "min": 0
        },
        "name": "name",
        "required": true,
        "secret": true,
        "string": {
          "default": "default",
          "pattern": "pattern"
        }
      }
    ],
    "runnerConfig": [
      {
        "id": "id",
        "bool": {
          "default": true
        },
        "description": "description",
        "display": {
          "default": "default"
        },
        "enum": {
          "default": "default",
          "defaultValue": {
            "detail": "detail",
            "subtitle": "subtitle",
            "title": "title"
          },
          "possibleValues": [
            {
              "detail": "detail",
              "subtitle": "subtitle",
              "title": "title"
            }
          ],
          "values": [
            "string"
          ]
        },
        "int": {
          "default": 0,
          "max": 0,
          "min": 0
        },
        "name": "name",
        "required": true,
        "secret": true,
        "string": {
          "default": "default",
          "pattern": "pattern"
        }
      }
    ],
    "scm": [
      {
        "defaultHosts": [
          "string"
        ],
        "name": "name",
        "oauth": {
          "callbackUrl": "callbackUrl"
        },
        "pat": {
          "description": "description",
          "docsLink": "docsLink"
        },
        "scmId": "scmId"
      }
    ],
    "version": "version"
  }
}
Returns Examples
{
  "schema": {
    "environmentClasses": [
      {
        "id": "id",
        "bool": {
          "default": true
        },
        "description": "description",
        "display": {
          "default": "default"
        },
        "enum": {
          "default": "default",
          "defaultValue": {
            "detail": "detail",
            "subtitle": "subtitle",
            "title": "title"
          },
          "possibleValues": [
            {
              "detail": "detail",
              "subtitle": "subtitle",
              "title": "title"
            }
          ],
          "values": [
            "string"
          ]
        },
        "int": {
          "default": 0,
          "max": 0,
          "min": 0
        },
        "name": "name",
        "required": true,
        "secret": true,
        "string": {
          "default": "default",
          "pattern": "pattern"
        }
      }
    ],
    "runnerConfig": [
      {
        "id": "id",
        "bool": {
          "default": true
        },
        "description": "description",
        "display": {
          "default": "default"
        },
        "enum": {
          "default": "default",
          "defaultValue": {
            "detail": "detail",
            "subtitle": "subtitle",
            "title": "title"
          },
          "possibleValues": [
            {
              "detail": "detail",
              "subtitle": "subtitle",
              "title": "title"
            }
          ],
          "values": [
            "string"
          ]
        },
        "int": {
          "default": 0,
          "max": 0,
          "min": 0
        },
        "name": "name",
        "required": true,
        "secret": true,
        "string": {
          "default": "default",
          "pattern": "pattern"
        }
      }
    ],
    "scm": [
      {
        "defaultHosts": [
          "string"
        ],
        "name": "name",
        "oauth": {
          "callbackUrl": "callbackUrl"
        },
        "pat": {
          "description": "description",
          "docsLink": "docsLink"
        },
        "scmId": "scmId"
      }
    ],
    "version": "version"
  }
}