Skip to content
Ona API Reference
Ona Docs
API Reference
Runners

Configurations

ValidateRunnerConfiguration
client.runners.configurations.validate(ConfigurationValidateParams { environmentClass, runnerId, scmIntegration } body, RequestOptionsoptions?): ConfigurationValidateResponse { environmentClass, scmIntegration }
POST/gitpod.v1.RunnerConfigurationService/ValidateRunnerConfiguration
ModelsExpand Collapse
EnvironmentClassValidationResult { configurationErrors, descriptionError, displayNameError, valid }
configurationErrors?: Array<FieldValidationError { error, key } >
error?: string
key?: string
descriptionError?: string | null
displayNameError?: string | null
valid?: boolean
FieldValidationError { error, key }
error?: string
key?: string
ScmIntegrationValidationResult { hostError, oauthError, patError, 2 more }
hostError?: string | null
oauthError?: string | null
patError?: string | null
scmIdError?: string | null
valid?: boolean
ConfigurationValidateResponse { environmentClass, scmIntegration }
environmentClass?: EnvironmentClassValidationResult { configurationErrors, descriptionError, displayNameError, valid }
configurationErrors?: Array<FieldValidationError { error, key } >
error?: string
key?: string
descriptionError?: string | null
displayNameError?: string | null
valid?: boolean
scmIntegration?: ScmIntegrationValidationResult { hostError, oauthError, patError, 2 more }
hostError?: string | null
oauthError?: string | null
patError?: string | null
scmIdError?: string | null
valid?: boolean

ConfigurationsEnvironment Classes

CreateEnvironmentClass
client.runners.configurations.environmentClasses.create(EnvironmentClassCreateParams { configuration, description, displayName, runnerId } body, RequestOptionsoptions?): EnvironmentClassCreateResponse { id }
POST/gitpod.v1.RunnerConfigurationService/CreateEnvironmentClass
ListEnvironmentClasses
client.runners.configurations.environmentClasses.list(EnvironmentClassListParams { token, pageSize, filter, pagination } params, RequestOptionsoptions?): EnvironmentClassesPage<EnvironmentClass { id, runnerId, configuration, 3 more } >
POST/gitpod.v1.RunnerConfigurationService/ListEnvironmentClasses
GetEnvironmentClass
client.runners.configurations.environmentClasses.retrieve(EnvironmentClassRetrieveParams { environmentClassId } body, RequestOptionsoptions?): EnvironmentClassRetrieveResponse { environmentClass }
POST/gitpod.v1.RunnerConfigurationService/GetEnvironmentClass
UpdateEnvironmentClass
client.runners.configurations.environmentClasses.update(EnvironmentClassUpdateParams { description, displayName, enabled, environmentClassId } body, RequestOptionsoptions?): EnvironmentClassUpdateResponse
POST/gitpod.v1.RunnerConfigurationService/UpdateEnvironmentClass
ModelsExpand Collapse
EnvironmentClassCreateResponse { id }
id?: string
EnvironmentClassRetrieveResponse { environmentClass }
environmentClass?: EnvironmentClass { id, runnerId, configuration, 3 more }
id: string

id is the unique identifier of the environment class

runnerId: string

runner_id is the unique identifier of the runner the environment class belongs to

configuration?: Array<FieldValue { key, value } >

configuration describes the configuration of the environment class

key?: string
value?: string
description?: string

description is a human readable description of the environment class

maxLength200
minLength3
displayName?: string

display_name is the human readable name of the environment class

maxLength127
minLength3
enabled?: boolean

enabled indicates whether the environment class can be used to create new environments.

EnvironmentClassUpdateResponse = unknown

ConfigurationsHost Authentication Tokens

CreateHostAuthenticationToken
client.runners.configurations.hostAuthenticationTokens.create(HostAuthenticationTokenCreateParams { token, expiresAt, host, 7 more } body, RequestOptionsoptions?): HostAuthenticationTokenCreateResponse { token }
POST/gitpod.v1.RunnerConfigurationService/CreateHostAuthenticationToken
DeleteHostAuthenticationToken
client.runners.configurations.hostAuthenticationTokens.delete(HostAuthenticationTokenDeleteParams { id } body, RequestOptionsoptions?): HostAuthenticationTokenDeleteResponse
POST/gitpod.v1.RunnerConfigurationService/DeleteHostAuthenticationToken
ListHostAuthenticationTokens
client.runners.configurations.hostAuthenticationTokens.list(HostAuthenticationTokenListParams { token, pageSize, filter, pagination } params, RequestOptionsoptions?): TokensPage<HostAuthenticationToken { id, expiresAt, host, 6 more } >
POST/gitpod.v1.RunnerConfigurationService/ListHostAuthenticationTokens
GetHostAuthenticationToken
client.runners.configurations.hostAuthenticationTokens.retrieve(HostAuthenticationTokenRetrieveParams { id } body, RequestOptionsoptions?): HostAuthenticationTokenRetrieveResponse { token }
POST/gitpod.v1.RunnerConfigurationService/GetHostAuthenticationToken
UpdateHostAuthenticationToken
client.runners.configurations.hostAuthenticationTokens.update(HostAuthenticationTokenUpdateParams { id, token, expiresAt, 2 more } body, RequestOptionsoptions?): HostAuthenticationTokenUpdateResponse
POST/gitpod.v1.RunnerConfigurationService/UpdateHostAuthenticationToken
ModelsExpand Collapse
HostAuthenticationToken { id, expiresAt, host, 6 more }
id: string
expiresAt?: string

A Timestamp represents a point in time independent of any time zone or local calendar, encoded as a count of seconds and fractions of seconds at nanosecond resolution. The count is relative to an epoch at UTC midnight on January 1, 1970, in the proleptic Gregorian calendar which extends the Gregorian calendar backwards to year one.

All minutes are 60 seconds long. Leap seconds are “smeared” so that no leap second table is needed for interpretation, using a 24-hour linear smear.

The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By restricting to that range, we ensure that we can convert to and from RFC 3339 date strings.

Examples

Example 1: Compute Timestamp from POSIX time().

 Timestamp timestamp;
 timestamp.set_seconds(time(NULL));
 timestamp.set_nanos(0);

Example 2: Compute Timestamp from POSIX gettimeofday().

 struct timeval tv;
 gettimeofday(&tv, NULL);

 Timestamp timestamp;
 timestamp.set_seconds(tv.tv_sec);
 timestamp.set_nanos(tv.tv_usec * 1000);

Example 3: Compute Timestamp from Win32 GetSystemTimeAsFileTime().

 FILETIME ft;
 GetSystemTimeAsFileTime(&ft);
 UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime;

 // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z
 // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z.
 Timestamp timestamp;
 timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL));
 timestamp.set_nanos((INT32) ((ticks % 10000000) * 100));

Example 4: Compute Timestamp from Java System.currentTimeMillis().

 long millis = System.currentTimeMillis();

 Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000)
     .setNanos((int) ((millis % 1000) * 1000000)).build();

Example 5: Compute Timestamp from Java Instant.now().

 Instant now = Instant.now();

 Timestamp timestamp =
     Timestamp.newBuilder().setSeconds(now.getEpochSecond())
         .setNanos(now.getNano()).build();

Example 6: Compute Timestamp from current time in Python.

 timestamp = Timestamp()
 timestamp.GetCurrentTime()

JSON Mapping

In JSON format, the Timestamp type is encoded as a string in the RFC 3339 format. That is, the format is “{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z” where {year} is always expressed using four digits while {month}, {day}, {hour}, {min}, and {sec} are zero-padded to two digits each. The fractional seconds, which can go up to 9 digits (i.e. up to 1 nanosecond resolution), are optional. The “Z” suffix indicates the timezone (“UTC”); the timezone is required. A proto3 JSON serializer should always use UTC (as indicated by “Z”) when printing the Timestamp type and a proto3 JSON parser should be able to accept both UTC and other timezones (as indicated by an offset).

For example, “2017-01-15T01:30:15.01Z” encodes 15.01 seconds past 01:30 UTC on January 15, 2017.

In JavaScript, one can convert a Date object to this format using the standard toISOString() method. In Python, a standard datetime.datetime object can be converted to this format using strftime with the time format spec ‘%Y-%m-%dT%H:%M:%S.%fZ’. Likewise, in Java, one can use the Joda Time’s ISODateTimeFormat.dateTime() to obtain a formatter capable of generating timestamps in this format.

formatdate-time
host?: string
integrationId?: string

links to integration instance

runnerId?: string
scopes?: Array<string>

token permissions

One of the following:
"HOST_AUTHENTICATION_TOKEN_SOURCE_UNSPECIFIED"
"HOST_AUTHENTICATION_TOKEN_SOURCE_OAUTH"
"HOST_AUTHENTICATION_TOKEN_SOURCE_PAT"
subject?: Subject { id, principal }

Subject identifies the principal (user or service account) for the token Note: actual token and refresh_token values are retrieved via GetHostAuthenticationTokenValue API

id?: string

id is the UUID of the subject

formatuuid
principal?: Principal

Principal is the principal of the subject

One of the following:
"PRINCIPAL_UNSPECIFIED"
"PRINCIPAL_ACCOUNT"
"PRINCIPAL_USER"
"PRINCIPAL_RUNNER"
"PRINCIPAL_ENVIRONMENT"
"PRINCIPAL_SERVICE_ACCOUNT"
"PRINCIPAL_RUNNER_MANAGER"
DeprecateduserId?: string

Deprecated: Use principal_id and principal_type instead principal (user)

HostAuthenticationTokenSource = "HOST_AUTHENTICATION_TOKEN_SOURCE_UNSPECIFIED" | "HOST_AUTHENTICATION_TOKEN_SOURCE_OAUTH" | "HOST_AUTHENTICATION_TOKEN_SOURCE_PAT"
One of the following:
"HOST_AUTHENTICATION_TOKEN_SOURCE_UNSPECIFIED"
"HOST_AUTHENTICATION_TOKEN_SOURCE_OAUTH"
"HOST_AUTHENTICATION_TOKEN_SOURCE_PAT"
HostAuthenticationTokenCreateResponse { token }
token: HostAuthenticationToken { id, expiresAt, host, 6 more }
id: string
expiresAt?: string

A Timestamp represents a point in time independent of any time zone or local calendar, encoded as a count of seconds and fractions of seconds at nanosecond resolution. The count is relative to an epoch at UTC midnight on January 1, 1970, in the proleptic Gregorian calendar which extends the Gregorian calendar backwards to year one.

All minutes are 60 seconds long. Leap seconds are “smeared” so that no leap second table is needed for interpretation, using a 24-hour linear smear.

The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By restricting to that range, we ensure that we can convert to and from RFC 3339 date strings.

Examples

Example 1: Compute Timestamp from POSIX time().

 Timestamp timestamp;
 timestamp.set_seconds(time(NULL));
 timestamp.set_nanos(0);

Example 2: Compute Timestamp from POSIX gettimeofday().

 struct timeval tv;
 gettimeofday(&tv, NULL);

 Timestamp timestamp;
 timestamp.set_seconds(tv.tv_sec);
 timestamp.set_nanos(tv.tv_usec * 1000);

Example 3: Compute Timestamp from Win32 GetSystemTimeAsFileTime().

 FILETIME ft;
 GetSystemTimeAsFileTime(&ft);
 UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime;

 // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z
 // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z.
 Timestamp timestamp;
 timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL));
 timestamp.set_nanos((INT32) ((ticks % 10000000) * 100));

Example 4: Compute Timestamp from Java System.currentTimeMillis().

 long millis = System.currentTimeMillis();

 Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000)
     .setNanos((int) ((millis % 1000) * 1000000)).build();

Example 5: Compute Timestamp from Java Instant.now().

 Instant now = Instant.now();

 Timestamp timestamp =
     Timestamp.newBuilder().setSeconds(now.getEpochSecond())
         .setNanos(now.getNano()).build();

Example 6: Compute Timestamp from current time in Python.

 timestamp = Timestamp()
 timestamp.GetCurrentTime()

JSON Mapping

In JSON format, the Timestamp type is encoded as a string in the RFC 3339 format. That is, the format is “{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z” where {year} is always expressed using four digits while {month}, {day}, {hour}, {min}, and {sec} are zero-padded to two digits each. The fractional seconds, which can go up to 9 digits (i.e. up to 1 nanosecond resolution), are optional. The “Z” suffix indicates the timezone (“UTC”); the timezone is required. A proto3 JSON serializer should always use UTC (as indicated by “Z”) when printing the Timestamp type and a proto3 JSON parser should be able to accept both UTC and other timezones (as indicated by an offset).

For example, “2017-01-15T01:30:15.01Z” encodes 15.01 seconds past 01:30 UTC on January 15, 2017.

In JavaScript, one can convert a Date object to this format using the standard toISOString() method. In Python, a standard datetime.datetime object can be converted to this format using strftime with the time format spec ‘%Y-%m-%dT%H:%M:%S.%fZ’. Likewise, in Java, one can use the Joda Time’s ISODateTimeFormat.dateTime() to obtain a formatter capable of generating timestamps in this format.

formatdate-time
host?: string
integrationId?: string

links to integration instance

runnerId?: string
scopes?: Array<string>

token permissions

One of the following:
"HOST_AUTHENTICATION_TOKEN_SOURCE_UNSPECIFIED"
"HOST_AUTHENTICATION_TOKEN_SOURCE_OAUTH"
"HOST_AUTHENTICATION_TOKEN_SOURCE_PAT"
subject?: Subject { id, principal }

Subject identifies the principal (user or service account) for the token Note: actual token and refresh_token values are retrieved via GetHostAuthenticationTokenValue API

id?: string

id is the UUID of the subject

formatuuid
principal?: Principal

Principal is the principal of the subject

One of the following:
"PRINCIPAL_UNSPECIFIED"
"PRINCIPAL_ACCOUNT"
"PRINCIPAL_USER"
"PRINCIPAL_RUNNER"
"PRINCIPAL_ENVIRONMENT"
"PRINCIPAL_SERVICE_ACCOUNT"
"PRINCIPAL_RUNNER_MANAGER"
DeprecateduserId?: string

Deprecated: Use principal_id and principal_type instead principal (user)

HostAuthenticationTokenDeleteResponse = unknown
HostAuthenticationTokenRetrieveResponse { token }
token: HostAuthenticationToken { id, expiresAt, host, 6 more }
id: string
expiresAt?: string

A Timestamp represents a point in time independent of any time zone or local calendar, encoded as a count of seconds and fractions of seconds at nanosecond resolution. The count is relative to an epoch at UTC midnight on January 1, 1970, in the proleptic Gregorian calendar which extends the Gregorian calendar backwards to year one.

All minutes are 60 seconds long. Leap seconds are “smeared” so that no leap second table is needed for interpretation, using a 24-hour linear smear.

The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By restricting to that range, we ensure that we can convert to and from RFC 3339 date strings.

Examples

Example 1: Compute Timestamp from POSIX time().

 Timestamp timestamp;
 timestamp.set_seconds(time(NULL));
 timestamp.set_nanos(0);

Example 2: Compute Timestamp from POSIX gettimeofday().

 struct timeval tv;
 gettimeofday(&tv, NULL);

 Timestamp timestamp;
 timestamp.set_seconds(tv.tv_sec);
 timestamp.set_nanos(tv.tv_usec * 1000);

Example 3: Compute Timestamp from Win32 GetSystemTimeAsFileTime().

 FILETIME ft;
 GetSystemTimeAsFileTime(&ft);
 UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime;

 // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z
 // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z.
 Timestamp timestamp;
 timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL));
 timestamp.set_nanos((INT32) ((ticks % 10000000) * 100));

Example 4: Compute Timestamp from Java System.currentTimeMillis().

 long millis = System.currentTimeMillis();

 Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000)
     .setNanos((int) ((millis % 1000) * 1000000)).build();

Example 5: Compute Timestamp from Java Instant.now().

 Instant now = Instant.now();

 Timestamp timestamp =
     Timestamp.newBuilder().setSeconds(now.getEpochSecond())
         .setNanos(now.getNano()).build();

Example 6: Compute Timestamp from current time in Python.

 timestamp = Timestamp()
 timestamp.GetCurrentTime()

JSON Mapping

In JSON format, the Timestamp type is encoded as a string in the RFC 3339 format. That is, the format is “{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z” where {year} is always expressed using four digits while {month}, {day}, {hour}, {min}, and {sec} are zero-padded to two digits each. The fractional seconds, which can go up to 9 digits (i.e. up to 1 nanosecond resolution), are optional. The “Z” suffix indicates the timezone (“UTC”); the timezone is required. A proto3 JSON serializer should always use UTC (as indicated by “Z”) when printing the Timestamp type and a proto3 JSON parser should be able to accept both UTC and other timezones (as indicated by an offset).

For example, “2017-01-15T01:30:15.01Z” encodes 15.01 seconds past 01:30 UTC on January 15, 2017.

In JavaScript, one can convert a Date object to this format using the standard toISOString() method. In Python, a standard datetime.datetime object can be converted to this format using strftime with the time format spec ‘%Y-%m-%dT%H:%M:%S.%fZ’. Likewise, in Java, one can use the Joda Time’s ISODateTimeFormat.dateTime() to obtain a formatter capable of generating timestamps in this format.

formatdate-time
host?: string
integrationId?: string

links to integration instance

runnerId?: string
scopes?: Array<string>

token permissions

One of the following:
"HOST_AUTHENTICATION_TOKEN_SOURCE_UNSPECIFIED"
"HOST_AUTHENTICATION_TOKEN_SOURCE_OAUTH"
"HOST_AUTHENTICATION_TOKEN_SOURCE_PAT"
subject?: Subject { id, principal }

Subject identifies the principal (user or service account) for the token Note: actual token and refresh_token values are retrieved via GetHostAuthenticationTokenValue API

id?: string

id is the UUID of the subject

formatuuid
principal?: Principal

Principal is the principal of the subject

One of the following:
"PRINCIPAL_UNSPECIFIED"
"PRINCIPAL_ACCOUNT"
"PRINCIPAL_USER"
"PRINCIPAL_RUNNER"
"PRINCIPAL_ENVIRONMENT"
"PRINCIPAL_SERVICE_ACCOUNT"
"PRINCIPAL_RUNNER_MANAGER"
DeprecateduserId?: string

Deprecated: Use principal_id and principal_type instead principal (user)

HostAuthenticationTokenUpdateResponse = unknown

ConfigurationsSchema

GetRunnerConfigurationSchema
client.runners.configurations.schema.retrieve(SchemaRetrieveParams { runnerId } body, RequestOptionsoptions?): SchemaRetrieveResponse { schema }
POST/gitpod.v1.RunnerConfigurationService/GetRunnerConfigurationSchema
ModelsExpand Collapse
RunnerConfigurationSchema { environmentClasses, runnerConfig, scm, version }
environmentClasses?: Array<EnvironmentClass>
id?: string
bool?: Bool { default }
default?: boolean
description?: string
display?: Display { default }
default?: string
enum?: Enum { default, defaultValue, possibleValues, values }
Deprecateddefault?: string

deprecated, will be removed, use default_value instead

defaultValue?: DefaultValue { detail, subtitle, title }
detail?: string
subtitle?: string
title?: string
possibleValues?: Array<PossibleValue>
detail?: string
subtitle?: string
title?: string
Deprecatedvalues?: Array<string>

deprecated, will be removed, use possible_values instead

int?: Int { default, max, min }
default?: number
formatint32
max?: number
formatint32
min?: number
formatint32
name?: string
required?: boolean
secret?: boolean
string?: String { default, pattern }
default?: string
pattern?: string
runnerConfig?: Array<RunnerConfig>
id?: string
bool?: Bool { default }
default?: boolean
description?: string
display?: Display { default }
default?: string
enum?: Enum { default, defaultValue, possibleValues, values }
Deprecateddefault?: string

deprecated, will be removed, use default_value instead

defaultValue?: DefaultValue { detail, subtitle, title }
detail?: string
subtitle?: string
title?: string
possibleValues?: Array<PossibleValue>
detail?: string
subtitle?: string
title?: string
Deprecatedvalues?: Array<string>

deprecated, will be removed, use possible_values instead

int?: Int { default, max, min }
default?: number
formatint32
max?: number
formatint32
min?: number
formatint32
name?: string
required?: boolean
secret?: boolean
string?: String { default, pattern }
default?: string
pattern?: string
scm?: Array<Scm>
defaultHosts?: Array<string>
name?: string
oauth?: OAuth { callbackUrl }
callbackUrl?: string

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

pat?: Pat { description, docsLink }
description?: string

description is a human-readable description of the PAT.

scmId?: string
version?: string

The schema version

SchemaRetrieveResponse { schema }
schema?: RunnerConfigurationSchema { environmentClasses, runnerConfig, scm, version }
environmentClasses?: Array<EnvironmentClass>
id?: string
bool?: Bool { default }
default?: boolean
description?: string
display?: Display { default }
default?: string
enum?: Enum { default, defaultValue, possibleValues, values }
Deprecateddefault?: string

deprecated, will be removed, use default_value instead

defaultValue?: DefaultValue { detail, subtitle, title }
detail?: string
subtitle?: string
title?: string
possibleValues?: Array<PossibleValue>
detail?: string
subtitle?: string
title?: string
Deprecatedvalues?: Array<string>

deprecated, will be removed, use possible_values instead

int?: Int { default, max, min }
default?: number
formatint32
max?: number
formatint32
min?: number
formatint32
name?: string
required?: boolean
secret?: boolean
string?: String { default, pattern }
default?: string
pattern?: string
runnerConfig?: Array<RunnerConfig>
id?: string
bool?: Bool { default }
default?: boolean
description?: string
display?: Display { default }
default?: string
enum?: Enum { default, defaultValue, possibleValues, values }
Deprecateddefault?: string

deprecated, will be removed, use default_value instead

defaultValue?: DefaultValue { detail, subtitle, title }
detail?: string
subtitle?: string
title?: string
possibleValues?: Array<PossibleValue>
detail?: string
subtitle?: string
title?: string
Deprecatedvalues?: Array<string>

deprecated, will be removed, use possible_values instead

int?: Int { default, max, min }
default?: number
formatint32
max?: number
formatint32
min?: number
formatint32
name?: string
required?: boolean
secret?: boolean
string?: String { default, pattern }
default?: string
pattern?: string
scm?: Array<Scm>
defaultHosts?: Array<string>
name?: string
oauth?: OAuth { callbackUrl }
callbackUrl?: string

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

pat?: Pat { description, docsLink }
description?: string

description is a human-readable description of the PAT.

scmId?: string
version?: string

The schema version

ConfigurationsScm Integrations

CreateSCMIntegration
client.runners.configurations.scmIntegrations.create(ScmIntegrationCreateParams { host, issuerUrl, oauthClientId, 5 more } body, RequestOptionsoptions?): ScmIntegrationCreateResponse { id }
POST/gitpod.v1.RunnerConfigurationService/CreateSCMIntegration
DeleteSCMIntegration
client.runners.configurations.scmIntegrations.delete(ScmIntegrationDeleteParams { id } body, RequestOptionsoptions?): ScmIntegrationDeleteResponse
POST/gitpod.v1.RunnerConfigurationService/DeleteSCMIntegration
ListSCMIntegrations
client.runners.configurations.scmIntegrations.list(ScmIntegrationListParams { token, pageSize, filter, pagination } params, RequestOptionsoptions?): IntegrationsPage<ScmIntegration { id, host, oauth, 4 more } >
POST/gitpod.v1.RunnerConfigurationService/ListSCMIntegrations
GetSCMIntegration
client.runners.configurations.scmIntegrations.retrieve(ScmIntegrationRetrieveParams { id } body, RequestOptionsoptions?): ScmIntegrationRetrieveResponse { integration }
POST/gitpod.v1.RunnerConfigurationService/GetSCMIntegration
UpdateSCMIntegration
client.runners.configurations.scmIntegrations.update(ScmIntegrationUpdateParams { id, issuerUrl, oauthClientId, 3 more } body, RequestOptionsoptions?): ScmIntegrationUpdateResponse
POST/gitpod.v1.RunnerConfigurationService/UpdateSCMIntegration
ModelsExpand Collapse
ScmIntegration { id, host, oauth, 4 more }
id?: string

id is the unique identifier of the SCM integration

host?: string
oauth?: ScmIntegrationOAuthConfig { clientId, encryptedClientSecret, issuerUrl } | null
clientId?: string

client_id is the OAuth app’s client ID in clear text.

encryptedClientSecret?: string

encrypted_client_secret is the OAuth app’s secret encrypted with the runner’s public key.

formatbyte
issuerUrl?: string

issuer_url is used to override the authentication provider URL, if it doesn’t match the SCM host.

+optional if not set, this account is owned by the installation.

pat?: boolean
runnerId?: string
scmId?: string

scm_id references the scm_id in the runner’s configuration schema that this integration is for

virtualDirectory?: string | null

virtual_directory is the virtual directory path for Azure DevOps Server (e.g., “/tfs”). This field is only used for Azure DevOps Server SCM integrations and should be empty for other SCM types. Azure DevOps Server APIs work without collection when PAT scope is ‘All accessible organizations’.

ScmIntegrationOAuthConfig { clientId, encryptedClientSecret, issuerUrl }
clientId?: string

client_id is the OAuth app’s client ID in clear text.

encryptedClientSecret?: string

encrypted_client_secret is the OAuth app’s secret encrypted with the runner’s public key.

formatbyte
issuerUrl?: string

issuer_url is used to override the authentication provider URL, if it doesn’t match the SCM host.

+optional if not set, this account is owned by the installation.

ScmIntegrationCreateResponse { id }
id?: string

id is a uniquely generated identifier for the SCM integration

formatuuid
ScmIntegrationDeleteResponse = unknown
ScmIntegrationRetrieveResponse { integration }
integration?: ScmIntegration { id, host, oauth, 4 more }
id?: string

id is the unique identifier of the SCM integration

host?: string
oauth?: ScmIntegrationOAuthConfig { clientId, encryptedClientSecret, issuerUrl } | null
clientId?: string

client_id is the OAuth app’s client ID in clear text.

encryptedClientSecret?: string

encrypted_client_secret is the OAuth app’s secret encrypted with the runner’s public key.

formatbyte
issuerUrl?: string

issuer_url is used to override the authentication provider URL, if it doesn’t match the SCM host.

+optional if not set, this account is owned by the installation.

pat?: boolean
runnerId?: string
scmId?: string

scm_id references the scm_id in the runner’s configuration schema that this integration is for

virtualDirectory?: string | null

virtual_directory is the virtual directory path for Azure DevOps Server (e.g., “/tfs”). This field is only used for Azure DevOps Server SCM integrations and should be empty for other SCM types. Azure DevOps Server APIs work without collection when PAT scope is ‘All accessible organizations’.

ScmIntegrationUpdateResponse = unknown