API Reference

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Runners

CheckAuthenticationForHost

client.Runners.CheckAuthenticationForHost(ctx, body) (*RunnerCheckAuthenticationForHostResponse, error)

POST/gitpod.v1.RunnerService/CheckAuthenticationForHost

CheckRepositoryAccess

client.Runners.CheckRepositoryAccess(ctx, body) (*RunnerCheckRepositoryAccessResponse, error)

POST/gitpod.v1.RunnerService/CheckRepositoryAccess

CreateRunner

client.Runners.New(ctx, body) (*RunnerNewResponse, error)

POST/gitpod.v1.RunnerService/CreateRunner

CreateRunnerLogsToken

client.Runners.NewLogsToken(ctx, body) (*RunnerNewLogsTokenResponse, error)

POST/gitpod.v1.RunnerService/CreateRunnerLogsToken

CreateRunnerToken

client.Runners.NewRunnerToken(ctx, body) (*RunnerNewRunnerTokenResponse, error)

POST/gitpod.v1.RunnerService/CreateRunnerToken

DeleteRunner

client.Runners.Delete(ctx, body) (*RunnerDeleteResponse, error)

POST/gitpod.v1.RunnerService/DeleteRunner

ListRunners

client.Runners.List(ctx, params) (*RunnersPage[Runner], error)

POST/gitpod.v1.RunnerService/ListRunners

ListSCMOrganizations

client.Runners.ListScmOrganizations(ctx, params) (*RunnerListScmOrganizationsResponse, error)

POST/gitpod.v1.RunnerService/ListSCMOrganizations

ParseContextURL

client.Runners.ParseContextURL(ctx, body) (*RunnerParseContextURLResponse, error)

POST/gitpod.v1.RunnerService/ParseContextURL

GetRunner

client.Runners.Get(ctx, body) (*RunnerGetResponse, error)

POST/gitpod.v1.RunnerService/GetRunner

SearchRepositories

client.Runners.SearchRepositories(ctx, body) (*RunnerSearchRepositoriesResponse, error)

POST/gitpod.v1.RunnerService/SearchRepositories

UpdateRunner

client.Runners.Update(ctx, body) (*RunnerUpdateResponse, error)

POST/gitpod.v1.RunnerService/UpdateRunner

ModelsExpand Collapse

type GatewayInfo struct{…}

Gateway GatewayOptional

Gateway represents a system gateway that provides access to services

Name string

name is the human-readable name of the gateway. name is unique across all gateways.

URL string

url of the gateway

Region stringOptional

region is the geographical region where the gateway is located

Latency stringOptional

latency is the round-trip time of the runner to the gateway in milliseconds.

formatregex

type LogLevel string

One of the following:

const LogLevelUnspecified LogLevel = "LOG_LEVEL_UNSPECIFIED"

const LogLevelDebug LogLevel = "LOG_LEVEL_DEBUG"

const LogLevelInfo LogLevel = "LOG_LEVEL_INFO"

const LogLevelWarn LogLevel = "LOG_LEVEL_WARN"

const LogLevelError LogLevel = "LOG_LEVEL_ERROR"

type MetricsConfiguration struct{…}

Enabled boolOptional

enabled indicates whether the runner should collect metrics

ManagedMetricsEnabled boolOptional

When true, the runner pushes metrics to the management plane via ReportRunnerMetrics instead of directly to the remote_write endpoint.

Password stringOptional

password is the password to use for the metrics collector

URL stringOptional

url is the URL of the metrics collector

Username stringOptional

username is the username to use for the metrics collector

type Runner struct{…}

CreatedAt TimeOptional

Time when the Runner was created.

formatdate-time

Creator SubjectOptional

creator is the identity of the creator of the environment

ID stringOptional

id is the UUID of the subject

formatuuid

Principal PrincipalOptional

Principal is the principal of the subject

One of the following:

const PrincipalUnspecified Principal = "PRINCIPAL_UNSPECIFIED"

const PrincipalAccount Principal = "PRINCIPAL_ACCOUNT"

const PrincipalUser Principal = "PRINCIPAL_USER"

const PrincipalRunner Principal = "PRINCIPAL_RUNNER"

const PrincipalEnvironment Principal = "PRINCIPAL_ENVIRONMENT"

const PrincipalServiceAccount Principal = "PRINCIPAL_SERVICE_ACCOUNT"

const PrincipalRunnerManager Principal = "PRINCIPAL_RUNNER_MANAGER"

Kind RunnerKindOptional

The runner’s kind

One of the following:

const RunnerKindUnspecified RunnerKind = "RUNNER_KIND_UNSPECIFIED"

const RunnerKindLocal RunnerKind = "RUNNER_KIND_LOCAL"

const RunnerKindRemote RunnerKind = "RUNNER_KIND_REMOTE"

const RunnerKindLocalConfiguration RunnerKind = "RUNNER_KIND_LOCAL_CONFIGURATION"

Name stringOptional

The runner’s name which is shown to users

Provider RunnerProviderOptional

The runner’s provider

One of the following:

const RunnerProviderUnspecified RunnerProvider = "RUNNER_PROVIDER_UNSPECIFIED"

const RunnerProviderAwsEc2 RunnerProvider = "RUNNER_PROVIDER_AWS_EC2"

const RunnerProviderLinuxHost RunnerProvider = "RUNNER_PROVIDER_LINUX_HOST"

const RunnerProviderDesktopMac RunnerProvider = "RUNNER_PROVIDER_DESKTOP_MAC"

const RunnerProviderManaged RunnerProvider = "RUNNER_PROVIDER_MANAGED"

const RunnerProviderGcp RunnerProvider = "RUNNER_PROVIDER_GCP"

const RunnerProviderDevAgent RunnerProvider = "RUNNER_PROVIDER_DEV_AGENT"

RunnerID stringOptional

RunnerManagerID stringOptional

The runner manager id specifies the runner manager for the managed runner. This field is only set for managed runners.

formatuuid

Spec RunnerSpecOptional

The runner’s specification

Configuration RunnerConfigurationOptional

The runner’s configuration

AutoUpdate boolOptional

auto_update indicates whether the runner should automatically update itself.

DevcontainerImageCacheEnabled boolOptional

devcontainer_image_cache_enabled controls whether the devcontainer build cache is enabled for this runner. Only takes effect on supported runners, currently only AWS EC2 and Gitpod-managed runners.

LogLevel LogLevelOptional

log_level is the log level for the runner

One of the following:

const LogLevelUnspecified LogLevel = "LOG_LEVEL_UNSPECIFIED"

const LogLevelDebug LogLevel = "LOG_LEVEL_DEBUG"

const LogLevelInfo LogLevel = "LOG_LEVEL_INFO"

const LogLevelWarn LogLevel = "LOG_LEVEL_WARN"

const LogLevelError LogLevel = "LOG_LEVEL_ERROR"

Metrics MetricsConfigurationOptional

metrics contains configuration for the runner’s metrics collection

Enabled boolOptional

enabled indicates whether the runner should collect metrics

ManagedMetricsEnabled boolOptional

When true, the runner pushes metrics to the management plane via ReportRunnerMetrics instead of directly to the remote_write endpoint.

Password stringOptional

password is the password to use for the metrics collector

URL stringOptional

url is the URL of the metrics collector

Username stringOptional

username is the username to use for the metrics collector

Region stringOptional

Region to deploy the runner in, if applicable. This is mainly used for remote runners, and is only a hint. The runner may be deployed in a different region. See the runner’s status for the actual region.

ReleaseChannel RunnerReleaseChannelOptional

The release channel the runner is on

One of the following:

const RunnerReleaseChannelUnspecified RunnerReleaseChannel = "RUNNER_RELEASE_CHANNEL_UNSPECIFIED"

const RunnerReleaseChannelStable RunnerReleaseChannel = "RUNNER_RELEASE_CHANNEL_STABLE"

const RunnerReleaseChannelLatest RunnerReleaseChannel = "RUNNER_RELEASE_CHANNEL_LATEST"

UpdateWindow UpdateWindowOptional

update_window defines the daily time window (UTC) during which auto-updates are allowed. If not set, updates are allowed at any time.

EndHour int64Optional

end_hour is the end of the update window as a UTC hour (0-23). If not set, defaults to start_hour + 2.

StartHour int64Optional

start_hour is the beginning of the update window as a UTC hour (0-23). +required

DesiredPhase RunnerPhaseOptional

RunnerPhase represents the phase a runner is in

One of the following:

const RunnerPhaseUnspecified RunnerPhase = "RUNNER_PHASE_UNSPECIFIED"

const RunnerPhaseCreated RunnerPhase = "RUNNER_PHASE_CREATED"

const RunnerPhaseInactive RunnerPhase = "RUNNER_PHASE_INACTIVE"

const RunnerPhaseActive RunnerPhase = "RUNNER_PHASE_ACTIVE"

const RunnerPhaseDeleting RunnerPhase = "RUNNER_PHASE_DELETING"

const RunnerPhaseDeleted RunnerPhase = "RUNNER_PHASE_DELETED"

const RunnerPhaseDegraded RunnerPhase = "RUNNER_PHASE_DEGRADED"

Variant RunnerVariantOptional

The runner’s variant

One of the following:

const RunnerVariantUnspecified RunnerVariant = "RUNNER_VARIANT_UNSPECIFIED"

const RunnerVariantStandard RunnerVariant = "RUNNER_VARIANT_STANDARD"

const RunnerVariantEnterprise RunnerVariant = "RUNNER_VARIANT_ENTERPRISE"

Status RunnerStatusOptional

The runner’s status

AdditionalInfo []FieldValueOptional

additional_info contains additional information about the runner, e.g. a CloudFormation stack URL.

Key stringOptional

Value stringOptional

Capabilities []RunnerCapabilityOptional

capabilities is a list of capabilities the runner supports.

One of the following:

const RunnerCapabilityUnspecified RunnerCapability = "RUNNER_CAPABILITY_UNSPECIFIED"

const RunnerCapabilityFetchLocalScmIntegrations RunnerCapability = "RUNNER_CAPABILITY_FETCH_LOCAL_SCM_INTEGRATIONS"

const RunnerCapabilitySecretContainerRegistry RunnerCapability = "RUNNER_CAPABILITY_SECRET_CONTAINER_REGISTRY"

const RunnerCapabilityAgentExecution RunnerCapability = "RUNNER_CAPABILITY_AGENT_EXECUTION"

const RunnerCapabilityAllowEnvTokenPopulation RunnerCapability = "RUNNER_CAPABILITY_ALLOW_ENV_TOKEN_POPULATION"

const RunnerCapabilityDefaultDevContainerImage RunnerCapability = "RUNNER_CAPABILITY_DEFAULT_DEV_CONTAINER_IMAGE"

const RunnerCapabilityEnvironmentSnapshot RunnerCapability = "RUNNER_CAPABILITY_ENVIRONMENT_SNAPSHOT"

const RunnerCapabilityPrebuildsBeforeSnapshotTrigger RunnerCapability = "RUNNER_CAPABILITY_PREBUILDS_BEFORE_SNAPSHOT_TRIGGER"

const RunnerCapabilityListScmOrganizations RunnerCapability = "RUNNER_CAPABILITY_LIST_SCM_ORGANIZATIONS"

const RunnerCapabilityCheckRepositoryAccess RunnerCapability = "RUNNER_CAPABILITY_CHECK_REPOSITORY_ACCESS"

const RunnerCapabilityRunnerSideAgent RunnerCapability = "RUNNER_CAPABILITY_RUNNER_SIDE_AGENT"

const RunnerCapabilityWarmPool RunnerCapability = "RUNNER_CAPABILITY_WARM_POOL"

const RunnerCapabilityAsgWarmPool RunnerCapability = "RUNNER_CAPABILITY_ASG_WARM_POOL"

const RunnerCapabilityPortAuthentication RunnerCapability = "RUNNER_CAPABILITY_PORT_AUTHENTICATION"

GatewayInfo GatewayInfoOptional

gateway_info is information about the gateway to which the runner is connected.

Gateway GatewayOptional

Gateway represents a system gateway that provides access to services

Name string

name is the human-readable name of the gateway. name is unique across all gateways.

URL string

url of the gateway

Region stringOptional

region is the geographical region where the gateway is located

Latency stringOptional

latency is the round-trip time of the runner to the gateway in milliseconds.

formatregex

LlmURL stringOptional

llm_url is the URL of the LLM service to which the runner is connected.

LogURL stringOptional

Message stringOptional

The runner’s reported message which is shown to users. This message adds more context to the runner’s phase.

Phase RunnerPhaseOptional

The runner’s reported phase

One of the following:

const RunnerPhaseUnspecified RunnerPhase = "RUNNER_PHASE_UNSPECIFIED"

const RunnerPhaseCreated RunnerPhase = "RUNNER_PHASE_CREATED"

const RunnerPhaseInactive RunnerPhase = "RUNNER_PHASE_INACTIVE"

const RunnerPhaseActive RunnerPhase = "RUNNER_PHASE_ACTIVE"

const RunnerPhaseDeleting RunnerPhase = "RUNNER_PHASE_DELETING"

const RunnerPhaseDeleted RunnerPhase = "RUNNER_PHASE_DELETED"

const RunnerPhaseDegraded RunnerPhase = "RUNNER_PHASE_DEGRADED"

PublicKey stringOptional

public_key is the runner’s public key used for encryption (32 bytes)

formatbyte

maxLength32

minLength32

Region stringOptional

region is the region the runner is running in, if applicable.

SupportBundleURL stringOptional

support_bundle_url is the URL at which the runner support bundle can be accessed. This URL provides access to pprof profiles and other debug information. Only available for standalone runners.

SystemDetails stringOptional

UpdatedAt TimeOptional

Time when the status was last updated.

formatdate-time

Version stringOptional

UpdatedAt TimeOptional

Time when the Runner was last udpated.

formatdate-time

type RunnerCapability string

One of the following:

const RunnerCapabilityUnspecified RunnerCapability = "RUNNER_CAPABILITY_UNSPECIFIED"

const RunnerCapabilityFetchLocalScmIntegrations RunnerCapability = "RUNNER_CAPABILITY_FETCH_LOCAL_SCM_INTEGRATIONS"

const RunnerCapabilitySecretContainerRegistry RunnerCapability = "RUNNER_CAPABILITY_SECRET_CONTAINER_REGISTRY"

const RunnerCapabilityAgentExecution RunnerCapability = "RUNNER_CAPABILITY_AGENT_EXECUTION"

const RunnerCapabilityAllowEnvTokenPopulation RunnerCapability = "RUNNER_CAPABILITY_ALLOW_ENV_TOKEN_POPULATION"

const RunnerCapabilityDefaultDevContainerImage RunnerCapability = "RUNNER_CAPABILITY_DEFAULT_DEV_CONTAINER_IMAGE"

const RunnerCapabilityEnvironmentSnapshot RunnerCapability = "RUNNER_CAPABILITY_ENVIRONMENT_SNAPSHOT"

const RunnerCapabilityPrebuildsBeforeSnapshotTrigger RunnerCapability = "RUNNER_CAPABILITY_PREBUILDS_BEFORE_SNAPSHOT_TRIGGER"

const RunnerCapabilityListScmOrganizations RunnerCapability = "RUNNER_CAPABILITY_LIST_SCM_ORGANIZATIONS"

const RunnerCapabilityCheckRepositoryAccess RunnerCapability = "RUNNER_CAPABILITY_CHECK_REPOSITORY_ACCESS"

const RunnerCapabilityRunnerSideAgent RunnerCapability = "RUNNER_CAPABILITY_RUNNER_SIDE_AGENT"

const RunnerCapabilityWarmPool RunnerCapability = "RUNNER_CAPABILITY_WARM_POOL"

const RunnerCapabilityAsgWarmPool RunnerCapability = "RUNNER_CAPABILITY_ASG_WARM_POOL"

const RunnerCapabilityPortAuthentication RunnerCapability = "RUNNER_CAPABILITY_PORT_AUTHENTICATION"

type RunnerConfiguration struct{…}

AutoUpdate boolOptional

auto_update indicates whether the runner should automatically update itself.

DevcontainerImageCacheEnabled boolOptional

devcontainer_image_cache_enabled controls whether the devcontainer build cache is enabled for this runner. Only takes effect on supported runners, currently only AWS EC2 and Gitpod-managed runners.

LogLevel LogLevelOptional

log_level is the log level for the runner

One of the following:

const LogLevelUnspecified LogLevel = "LOG_LEVEL_UNSPECIFIED"

const LogLevelDebug LogLevel = "LOG_LEVEL_DEBUG"

const LogLevelInfo LogLevel = "LOG_LEVEL_INFO"

const LogLevelWarn LogLevel = "LOG_LEVEL_WARN"

const LogLevelError LogLevel = "LOG_LEVEL_ERROR"

Metrics MetricsConfigurationOptional

metrics contains configuration for the runner’s metrics collection

Enabled boolOptional

enabled indicates whether the runner should collect metrics

ManagedMetricsEnabled boolOptional

When true, the runner pushes metrics to the management plane via ReportRunnerMetrics instead of directly to the remote_write endpoint.

Password stringOptional

password is the password to use for the metrics collector

URL stringOptional

url is the URL of the metrics collector

Username stringOptional

username is the username to use for the metrics collector

Region stringOptional

Region to deploy the runner in, if applicable. This is mainly used for remote runners, and is only a hint. The runner may be deployed in a different region. See the runner’s status for the actual region.

ReleaseChannel RunnerReleaseChannelOptional

The release channel the runner is on

One of the following:

const RunnerReleaseChannelUnspecified RunnerReleaseChannel = "RUNNER_RELEASE_CHANNEL_UNSPECIFIED"

const RunnerReleaseChannelStable RunnerReleaseChannel = "RUNNER_RELEASE_CHANNEL_STABLE"

const RunnerReleaseChannelLatest RunnerReleaseChannel = "RUNNER_RELEASE_CHANNEL_LATEST"

UpdateWindow UpdateWindowOptional

update_window defines the daily time window (UTC) during which auto-updates are allowed. If not set, updates are allowed at any time.

EndHour int64Optional

end_hour is the end of the update window as a UTC hour (0-23). If not set, defaults to start_hour + 2.

StartHour int64Optional

start_hour is the beginning of the update window as a UTC hour (0-23). +required

type RunnerKind string

RunnerKind represents the kind of a runner

One of the following:

const RunnerKindUnspecified RunnerKind = "RUNNER_KIND_UNSPECIFIED"

const RunnerKindLocal RunnerKind = "RUNNER_KIND_LOCAL"

const RunnerKindRemote RunnerKind = "RUNNER_KIND_REMOTE"

const RunnerKindLocalConfiguration RunnerKind = "RUNNER_KIND_LOCAL_CONFIGURATION"

type RunnerPhase string

RunnerPhase represents the phase a runner is in

One of the following:

const RunnerPhaseUnspecified RunnerPhase = "RUNNER_PHASE_UNSPECIFIED"

const RunnerPhaseCreated RunnerPhase = "RUNNER_PHASE_CREATED"

const RunnerPhaseInactive RunnerPhase = "RUNNER_PHASE_INACTIVE"

const RunnerPhaseActive RunnerPhase = "RUNNER_PHASE_ACTIVE"

const RunnerPhaseDeleting RunnerPhase = "RUNNER_PHASE_DELETING"

const RunnerPhaseDeleted RunnerPhase = "RUNNER_PHASE_DELETED"

const RunnerPhaseDegraded RunnerPhase = "RUNNER_PHASE_DEGRADED"

type RunnerProvider string

RunnerProvider identifies the specific implementation type of a runner. Each provider maps to a specific kind of runner (local or remote), as specified below for each provider.

One of the following:

const RunnerProviderUnspecified RunnerProvider = "RUNNER_PROVIDER_UNSPECIFIED"

const RunnerProviderAwsEc2 RunnerProvider = "RUNNER_PROVIDER_AWS_EC2"

const RunnerProviderLinuxHost RunnerProvider = "RUNNER_PROVIDER_LINUX_HOST"

const RunnerProviderDesktopMac RunnerProvider = "RUNNER_PROVIDER_DESKTOP_MAC"

const RunnerProviderManaged RunnerProvider = "RUNNER_PROVIDER_MANAGED"

const RunnerProviderGcp RunnerProvider = "RUNNER_PROVIDER_GCP"

const RunnerProviderDevAgent RunnerProvider = "RUNNER_PROVIDER_DEV_AGENT"

type RunnerReleaseChannel string

One of the following:

const RunnerReleaseChannelUnspecified RunnerReleaseChannel = "RUNNER_RELEASE_CHANNEL_UNSPECIFIED"

const RunnerReleaseChannelStable RunnerReleaseChannel = "RUNNER_RELEASE_CHANNEL_STABLE"

const RunnerReleaseChannelLatest RunnerReleaseChannel = "RUNNER_RELEASE_CHANNEL_LATEST"

type RunnerSpec struct{…}

Configuration RunnerConfigurationOptional

The runner’s configuration

AutoUpdate boolOptional

auto_update indicates whether the runner should automatically update itself.

DevcontainerImageCacheEnabled boolOptional

devcontainer_image_cache_enabled controls whether the devcontainer build cache is enabled for this runner. Only takes effect on supported runners, currently only AWS EC2 and Gitpod-managed runners.

LogLevel LogLevelOptional

log_level is the log level for the runner

One of the following:

const LogLevelUnspecified LogLevel = "LOG_LEVEL_UNSPECIFIED"

const LogLevelDebug LogLevel = "LOG_LEVEL_DEBUG"

const LogLevelInfo LogLevel = "LOG_LEVEL_INFO"

const LogLevelWarn LogLevel = "LOG_LEVEL_WARN"

const LogLevelError LogLevel = "LOG_LEVEL_ERROR"

Metrics MetricsConfigurationOptional

metrics contains configuration for the runner’s metrics collection

Enabled boolOptional

enabled indicates whether the runner should collect metrics

ManagedMetricsEnabled boolOptional

When true, the runner pushes metrics to the management plane via ReportRunnerMetrics instead of directly to the remote_write endpoint.

Password stringOptional

password is the password to use for the metrics collector

URL stringOptional

url is the URL of the metrics collector

Username stringOptional

username is the username to use for the metrics collector

Region stringOptional

Region to deploy the runner in, if applicable. This is mainly used for remote runners, and is only a hint. The runner may be deployed in a different region. See the runner’s status for the actual region.

ReleaseChannel RunnerReleaseChannelOptional

The release channel the runner is on

One of the following:

const RunnerReleaseChannelUnspecified RunnerReleaseChannel = "RUNNER_RELEASE_CHANNEL_UNSPECIFIED"

const RunnerReleaseChannelStable RunnerReleaseChannel = "RUNNER_RELEASE_CHANNEL_STABLE"

const RunnerReleaseChannelLatest RunnerReleaseChannel = "RUNNER_RELEASE_CHANNEL_LATEST"

UpdateWindow UpdateWindowOptional

update_window defines the daily time window (UTC) during which auto-updates are allowed. If not set, updates are allowed at any time.

EndHour int64Optional

end_hour is the end of the update window as a UTC hour (0-23). If not set, defaults to start_hour + 2.

StartHour int64Optional

start_hour is the beginning of the update window as a UTC hour (0-23). +required

DesiredPhase RunnerPhaseOptional

RunnerPhase represents the phase a runner is in

One of the following:

const RunnerPhaseUnspecified RunnerPhase = "RUNNER_PHASE_UNSPECIFIED"

const RunnerPhaseCreated RunnerPhase = "RUNNER_PHASE_CREATED"

const RunnerPhaseInactive RunnerPhase = "RUNNER_PHASE_INACTIVE"

const RunnerPhaseActive RunnerPhase = "RUNNER_PHASE_ACTIVE"

const RunnerPhaseDeleting RunnerPhase = "RUNNER_PHASE_DELETING"

const RunnerPhaseDeleted RunnerPhase = "RUNNER_PHASE_DELETED"

const RunnerPhaseDegraded RunnerPhase = "RUNNER_PHASE_DEGRADED"

Variant RunnerVariantOptional

The runner’s variant

One of the following:

const RunnerVariantUnspecified RunnerVariant = "RUNNER_VARIANT_UNSPECIFIED"

const RunnerVariantStandard RunnerVariant = "RUNNER_VARIANT_STANDARD"

const RunnerVariantEnterprise RunnerVariant = "RUNNER_VARIANT_ENTERPRISE"

type RunnerStatus struct{…}

RunnerStatus represents the status of a runner

AdditionalInfo []FieldValueOptional

additional_info contains additional information about the runner, e.g. a CloudFormation stack URL.

Key stringOptional

Value stringOptional

Capabilities []RunnerCapabilityOptional

capabilities is a list of capabilities the runner supports.

One of the following:

const RunnerCapabilityUnspecified RunnerCapability = "RUNNER_CAPABILITY_UNSPECIFIED"

const RunnerCapabilityFetchLocalScmIntegrations RunnerCapability = "RUNNER_CAPABILITY_FETCH_LOCAL_SCM_INTEGRATIONS"

const RunnerCapabilitySecretContainerRegistry RunnerCapability = "RUNNER_CAPABILITY_SECRET_CONTAINER_REGISTRY"

const RunnerCapabilityAgentExecution RunnerCapability = "RUNNER_CAPABILITY_AGENT_EXECUTION"

const RunnerCapabilityAllowEnvTokenPopulation RunnerCapability = "RUNNER_CAPABILITY_ALLOW_ENV_TOKEN_POPULATION"

const RunnerCapabilityDefaultDevContainerImage RunnerCapability = "RUNNER_CAPABILITY_DEFAULT_DEV_CONTAINER_IMAGE"

const RunnerCapabilityEnvironmentSnapshot RunnerCapability = "RUNNER_CAPABILITY_ENVIRONMENT_SNAPSHOT"

const RunnerCapabilityPrebuildsBeforeSnapshotTrigger RunnerCapability = "RUNNER_CAPABILITY_PREBUILDS_BEFORE_SNAPSHOT_TRIGGER"

const RunnerCapabilityListScmOrganizations RunnerCapability = "RUNNER_CAPABILITY_LIST_SCM_ORGANIZATIONS"

const RunnerCapabilityCheckRepositoryAccess RunnerCapability = "RUNNER_CAPABILITY_CHECK_REPOSITORY_ACCESS"

const RunnerCapabilityRunnerSideAgent RunnerCapability = "RUNNER_CAPABILITY_RUNNER_SIDE_AGENT"

const RunnerCapabilityWarmPool RunnerCapability = "RUNNER_CAPABILITY_WARM_POOL"

const RunnerCapabilityAsgWarmPool RunnerCapability = "RUNNER_CAPABILITY_ASG_WARM_POOL"

const RunnerCapabilityPortAuthentication RunnerCapability = "RUNNER_CAPABILITY_PORT_AUTHENTICATION"

GatewayInfo GatewayInfoOptional

gateway_info is information about the gateway to which the runner is connected.

Gateway GatewayOptional

Gateway represents a system gateway that provides access to services

Name string

name is the human-readable name of the gateway. name is unique across all gateways.

URL string

url of the gateway

Region stringOptional

region is the geographical region where the gateway is located

Latency stringOptional

latency is the round-trip time of the runner to the gateway in milliseconds.

formatregex

LlmURL stringOptional

llm_url is the URL of the LLM service to which the runner is connected.

LogURL stringOptional

Message stringOptional

The runner’s reported message which is shown to users. This message adds more context to the runner’s phase.

Phase RunnerPhaseOptional

The runner’s reported phase

One of the following:

const RunnerPhaseUnspecified RunnerPhase = "RUNNER_PHASE_UNSPECIFIED"

const RunnerPhaseCreated RunnerPhase = "RUNNER_PHASE_CREATED"

const RunnerPhaseInactive RunnerPhase = "RUNNER_PHASE_INACTIVE"

const RunnerPhaseActive RunnerPhase = "RUNNER_PHASE_ACTIVE"

const RunnerPhaseDeleting RunnerPhase = "RUNNER_PHASE_DELETING"

const RunnerPhaseDeleted RunnerPhase = "RUNNER_PHASE_DELETED"

const RunnerPhaseDegraded RunnerPhase = "RUNNER_PHASE_DEGRADED"

PublicKey stringOptional

public_key is the runner’s public key used for encryption (32 bytes)

formatbyte

maxLength32

minLength32

Region stringOptional

region is the region the runner is running in, if applicable.

SupportBundleURL stringOptional

support_bundle_url is the URL at which the runner support bundle can be accessed. This URL provides access to pprof profiles and other debug information. Only available for standalone runners.

SystemDetails stringOptional

UpdatedAt TimeOptional

Time when the status was last updated.

formatdate-time

Version stringOptional

type RunnerVariant string

One of the following:

const RunnerVariantUnspecified RunnerVariant = "RUNNER_VARIANT_UNSPECIFIED"

const RunnerVariantStandard RunnerVariant = "RUNNER_VARIANT_STANDARD"

const RunnerVariantEnterprise RunnerVariant = "RUNNER_VARIANT_ENTERPRISE"

type SearchMode string

One of the following:

const SearchModeUnspecified SearchMode = "SEARCH_MODE_UNSPECIFIED"

const SearchModeKeyword SearchMode = "SEARCH_MODE_KEYWORD"

const SearchModeNative SearchMode = "SEARCH_MODE_NATIVE"

type UpdateWindow struct{…}

UpdateWindow defines a daily time window (UTC) during which auto-updates are allowed. The window must be at least 2 hours long. Overnight windows are supported (e.g., start_hour=22, end_hour=4).

EndHour int64Optional

end_hour is the end of the update window as a UTC hour (0-23). If not set, defaults to start_hour + 2.

StartHour int64Optional

start_hour is the beginning of the update window as a UTC hour (0-23). +required

RunnersConfigurations

ValidateRunnerConfiguration

client.Runners.Configurations.Validate(ctx, body) (*RunnerConfigurationValidateResponse, error)

POST/gitpod.v1.RunnerConfigurationService/ValidateRunnerConfiguration

ModelsExpand Collapse

type EnvironmentClassValidationResult struct{…}

ConfigurationErrors []FieldValidationErrorOptional

Error stringOptional

Key stringOptional

DescriptionError stringOptional

DisplayNameError stringOptional

Valid boolOptional

type FieldValidationError struct{…}

Error stringOptional

Key stringOptional

type ScmIntegrationValidationResult struct{…}

HostError stringOptional

OAuthError stringOptional

PatError stringOptional

ScmIDError stringOptional

Valid boolOptional

RunnersConfigurationsEnvironment Classes

CreateEnvironmentClass

client.Runners.Configurations.EnvironmentClasses.New(ctx, body) (*RunnerConfigurationEnvironmentClassNewResponse, error)

POST/gitpod.v1.RunnerConfigurationService/CreateEnvironmentClass

ListEnvironmentClasses

client.Runners.Configurations.EnvironmentClasses.List(ctx, params) (*EnvironmentClassesPage[EnvironmentClass], error)

POST/gitpod.v1.RunnerConfigurationService/ListEnvironmentClasses

GetEnvironmentClass

client.Runners.Configurations.EnvironmentClasses.Get(ctx, body) (*RunnerConfigurationEnvironmentClassGetResponse, error)

POST/gitpod.v1.RunnerConfigurationService/GetEnvironmentClass

UpdateEnvironmentClass

client.Runners.Configurations.EnvironmentClasses.Update(ctx, body) (*RunnerConfigurationEnvironmentClassUpdateResponse, error)

POST/gitpod.v1.RunnerConfigurationService/UpdateEnvironmentClass

RunnersConfigurationsHost Authentication Tokens

CreateHostAuthenticationToken

client.Runners.Configurations.HostAuthenticationTokens.New(ctx, body) (*RunnerConfigurationHostAuthenticationTokenNewResponse, error)

POST/gitpod.v1.RunnerConfigurationService/CreateHostAuthenticationToken

DeleteHostAuthenticationToken

client.Runners.Configurations.HostAuthenticationTokens.Delete(ctx, body) (*RunnerConfigurationHostAuthenticationTokenDeleteResponse, error)

POST/gitpod.v1.RunnerConfigurationService/DeleteHostAuthenticationToken

ListHostAuthenticationTokens

client.Runners.Configurations.HostAuthenticationTokens.List(ctx, params) (*TokensPage[HostAuthenticationToken], error)

POST/gitpod.v1.RunnerConfigurationService/ListHostAuthenticationTokens

GetHostAuthenticationToken

client.Runners.Configurations.HostAuthenticationTokens.Get(ctx, body) (*RunnerConfigurationHostAuthenticationTokenGetResponse, error)

POST/gitpod.v1.RunnerConfigurationService/GetHostAuthenticationToken

UpdateHostAuthenticationToken

client.Runners.Configurations.HostAuthenticationTokens.Update(ctx, body) (*RunnerConfigurationHostAuthenticationTokenUpdateResponse, error)

POST/gitpod.v1.RunnerConfigurationService/UpdateHostAuthenticationToken

ModelsExpand Collapse

type HostAuthenticationToken struct{…}

ID string

ExpiresAt TimeOptional

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 stringOptional

IntegrationID stringOptional

links to integration instance

RunnerID stringOptional

Scopes []stringOptional

token permissions

Source HostAuthenticationTokenSourceOptional

auth_type

One of the following:

const HostAuthenticationTokenSourceUnspecified HostAuthenticationTokenSource = "HOST_AUTHENTICATION_TOKEN_SOURCE_UNSPECIFIED"

const HostAuthenticationTokenSourceOAuth HostAuthenticationTokenSource = "HOST_AUTHENTICATION_TOKEN_SOURCE_OAUTH"

const HostAuthenticationTokenSourcePat HostAuthenticationTokenSource = "HOST_AUTHENTICATION_TOKEN_SOURCE_PAT"

Subject SubjectOptional

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

ID stringOptional

id is the UUID of the subject

formatuuid

Principal PrincipalOptional

Principal is the principal of the subject

One of the following:

const PrincipalUnspecified Principal = "PRINCIPAL_UNSPECIFIED"

const PrincipalAccount Principal = "PRINCIPAL_ACCOUNT"

const PrincipalUser Principal = "PRINCIPAL_USER"

const PrincipalRunner Principal = "PRINCIPAL_RUNNER"

const PrincipalEnvironment Principal = "PRINCIPAL_ENVIRONMENT"

const PrincipalServiceAccount Principal = "PRINCIPAL_SERVICE_ACCOUNT"

const PrincipalRunnerManager Principal = "PRINCIPAL_RUNNER_MANAGER"

DeprecatedUserID stringOptional

Deprecated: Use principal_id and principal_type instead principal (user)

type HostAuthenticationTokenSource string

One of the following:

const HostAuthenticationTokenSourceUnspecified HostAuthenticationTokenSource = "HOST_AUTHENTICATION_TOKEN_SOURCE_UNSPECIFIED"

const HostAuthenticationTokenSourceOAuth HostAuthenticationTokenSource = "HOST_AUTHENTICATION_TOKEN_SOURCE_OAUTH"

const HostAuthenticationTokenSourcePat HostAuthenticationTokenSource = "HOST_AUTHENTICATION_TOKEN_SOURCE_PAT"

RunnersConfigurationsSchema

GetRunnerConfigurationSchema

client.Runners.Configurations.Schema.Get(ctx, body) (*RunnerConfigurationSchemaGetResponse, error)

POST/gitpod.v1.RunnerConfigurationService/GetRunnerConfigurationSchema

ModelsExpand Collapse

type RunnerConfigurationSchema 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.

DocsLink stringOptional

docs_link is a link to the documentation on how to create a PAT for this SCM system.

ScmID stringOptional

Version stringOptional

The schema version

RunnersConfigurationsScm Integrations

CreateSCMIntegration

client.Runners.Configurations.ScmIntegrations.New(ctx, body) (*RunnerConfigurationScmIntegrationNewResponse, error)

POST/gitpod.v1.RunnerConfigurationService/CreateSCMIntegration

DeleteSCMIntegration

client.Runners.Configurations.ScmIntegrations.Delete(ctx, body) (*RunnerConfigurationScmIntegrationDeleteResponse, error)

POST/gitpod.v1.RunnerConfigurationService/DeleteSCMIntegration

ListSCMIntegrations

client.Runners.Configurations.ScmIntegrations.List(ctx, params) (*IntegrationsPage[ScmIntegration], error)

POST/gitpod.v1.RunnerConfigurationService/ListSCMIntegrations

GetSCMIntegration

client.Runners.Configurations.ScmIntegrations.Get(ctx, body) (*RunnerConfigurationScmIntegrationGetResponse, error)

POST/gitpod.v1.RunnerConfigurationService/GetSCMIntegration

UpdateSCMIntegration

client.Runners.Configurations.ScmIntegrations.Update(ctx, body) (*RunnerConfigurationScmIntegrationUpdateResponse, error)

POST/gitpod.v1.RunnerConfigurationService/UpdateSCMIntegration

ModelsExpand Collapse

type ScmIntegration struct{…}

ID stringOptional

id is the unique identifier of the SCM integration

Host stringOptional

OAuth ScmIntegrationOAuthConfigOptional

ClientID stringOptional

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

EncryptedClientSecret stringOptional

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

formatbyte

IssuerURL stringOptional

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 boolOptional

RunnerID stringOptional

ScmID stringOptional

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

VirtualDirectory stringOptional

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’.

type ScmIntegrationOAuthConfig struct{…}

ClientID stringOptional

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

EncryptedClientSecret stringOptional

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

formatbyte

IssuerURL stringOptional

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.

RunnersPolicies

CreateRunnerPolicy

client.Runners.Policies.New(ctx, body) (*RunnerPolicyNewResponse, error)

POST/gitpod.v1.RunnerService/CreateRunnerPolicy

DeleteRunnerPolicy

client.Runners.Policies.Delete(ctx, body) (*RunnerPolicyDeleteResponse, error)

POST/gitpod.v1.RunnerService/DeleteRunnerPolicy

ListRunnerPolicies

client.Runners.Policies.List(ctx, params) (*PoliciesPage[RunnerPolicy], error)

POST/gitpod.v1.RunnerService/ListRunnerPolicies

UpdateRunnerPolicy

client.Runners.Policies.Update(ctx, body) (*RunnerPolicyUpdateResponse, error)

POST/gitpod.v1.RunnerService/UpdateRunnerPolicy

ModelsExpand Collapse

type RunnerPolicy struct{…}

GroupID stringOptional

formatuuid

Role RunnerRoleOptional

role is the role assigned to the group

One of the following:

const RunnerRoleUnspecified RunnerRole = "RUNNER_ROLE_UNSPECIFIED"

const RunnerRoleAdmin RunnerRole = "RUNNER_ROLE_ADMIN"

const RunnerRoleUser RunnerRole = "RUNNER_ROLE_USER"

type RunnerRole string

One of the following:

const RunnerRoleUnspecified RunnerRole = "RUNNER_ROLE_UNSPECIFIED"

const RunnerRoleAdmin RunnerRole = "RUNNER_ROLE_ADMIN"

const RunnerRoleUser RunnerRole = "RUNNER_ROLE_USER"