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

GetRunnerConfigurationSchema

client.Runners.Configurations.Schema.Get(ctx, body) (*RunnerConfigurationSchemaGetResponse, error)
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
body RunnerConfigurationSchemaGetParams
RunnerID param.Field[string]Optional
formatuuid
ReturnsExpand Collapse
type RunnerConfigurationSchemaGetResponse struct{…}
EnvironmentClasses []RunnerConfigurationSchemaEnvironmentClassOptional
ID stringOptional
Bool RunnerConfigurationSchemaEnvironmentClassesBoolOptional
Default boolOptional
Description stringOptional
Display RunnerConfigurationSchemaEnvironmentClassesDisplayOptional
Default stringOptional
Enum RunnerConfigurationSchemaEnvironmentClassesEnumOptional
DeprecatedDefault stringOptional

deprecated, will be removed, use default_value instead

DefaultValue RunnerConfigurationSchemaEnvironmentClassesEnumDefaultValueOptional
Detail stringOptional
Subtitle stringOptional
Title stringOptional
PossibleValues []RunnerConfigurationSchemaEnvironmentClassesEnumPossibleValueOptional
Detail stringOptional
Subtitle stringOptional
Title stringOptional
DeprecatedValues []stringOptional

deprecated, will be removed, use possible_values instead

Int RunnerConfigurationSchemaEnvironmentClassesIntOptional
Default int64Optional
formatint32
Max int64Optional
formatint32
Min int64Optional
formatint32
Name stringOptional
Required boolOptional
Secret boolOptional
String RunnerConfigurationSchemaEnvironmentClassesStringOptional
Default stringOptional
Pattern stringOptional
RunnerConfig []RunnerConfigurationSchemaRunnerConfigOptional
ID stringOptional
Bool RunnerConfigurationSchemaRunnerConfigBoolOptional
Default boolOptional
Description stringOptional
Display RunnerConfigurationSchemaRunnerConfigDisplayOptional
Default stringOptional
Enum RunnerConfigurationSchemaRunnerConfigEnumOptional
DeprecatedDefault stringOptional

deprecated, will be removed, use default_value instead

DefaultValue RunnerConfigurationSchemaRunnerConfigEnumDefaultValueOptional
Detail stringOptional
Subtitle stringOptional
Title stringOptional
PossibleValues []RunnerConfigurationSchemaRunnerConfigEnumPossibleValueOptional
Detail stringOptional
Subtitle stringOptional
Title stringOptional
DeprecatedValues []stringOptional

deprecated, will be removed, use possible_values instead

Int RunnerConfigurationSchemaRunnerConfigIntOptional
Default int64Optional
formatint32
Max int64Optional
formatint32
Min int64Optional
formatint32
Name stringOptional
Required boolOptional
Secret boolOptional
String RunnerConfigurationSchemaRunnerConfigStringOptional
Default stringOptional
Pattern stringOptional
Scm []RunnerConfigurationSchemaScmOptional
DefaultHosts []stringOptional
Name stringOptional
OAuth RunnerConfigurationSchemaScmOAuthOptional
CallbackURL stringOptional

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

Pat RunnerConfigurationSchemaScmPatOptional
Description stringOptional

description is a human-readable description of the PAT.

ScmID stringOptional
Version stringOptional

The schema version

GetRunnerConfigurationSchema

package main

import (
  "context"
  "fmt"

  "github.com/gitpod-io/gitpod-sdk-go"
  "github.com/gitpod-io/gitpod-sdk-go/option"
)

func main() {
  client := gitpod.NewClient(
    option.WithBearerToken("My Bearer Token"),
  )
  schema, err := client.Runners.Configurations.Schema.Get(context.TODO(), gitpod.RunnerConfigurationSchemaGetParams{
    RunnerID: gitpod.F("d2c94c27-3b76-4a42-b88c-95a85e392c68"),
  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", 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"
  }
}