# Runners ## CheckAuthenticationForHost `client.Runners.CheckAuthenticationForHost(ctx, body) (*RunnerCheckAuthenticationForHostResponse, error)` **post** `/gitpod.v1.RunnerService/CheckAuthenticationForHost` Checks if a user is authenticated for a specific host. Use this method to: - Verify authentication status - Get authentication URLs - Check PAT support ### Examples - Check authentication: Verifies authentication for a host. ```yaml host: "github.com" ``` ### Parameters - `body RunnerCheckAuthenticationForHostParams` - `Host param.Field[string]` - `RunnerID param.Field[string]` ### Returns - `type RunnerCheckAuthenticationForHostResponse struct{…}` - `Authenticated bool` - `AuthenticationURL string` - `PatSupported bool` - `ScmID string` scm_id is the unique identifier of the SCM provider - `ScmName string` scm_name is the human-readable name of the SCM provider (e.g., "GitHub", "GitLab") - `SupportsOauth2 RunnerCheckAuthenticationForHostResponseSupportsOauth2` supports_oauth2 indicates that the host supports OAuth2 authentication - `AuthURL string` auth_url is the URL where users can authenticate - `DocsURL string` docs_url is the URL to the documentation explaining this authentication method - `SupportsPat RunnerCheckAuthenticationForHostResponseSupportsPat` supports_pat indicates that the host supports Personal Access Token authentication - `CreateURL string` create_url is the URL where users can create a new Personal Access Token - `DocsURL string` docs_url is the URL to the documentation explaining PAT usage for this host - `Example string` example is an example of a Personal Access Token - `RequiredScopes []string` required_scopes is the list of permissions required for the Personal Access Token ### Example ```go 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"), ) response, err := client.Runners.CheckAuthenticationForHost(context.TODO(), gitpod.RunnerCheckAuthenticationForHostParams{ Host: gitpod.F("github.com"), }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", response.Authenticated) } ``` #### Response ```json { "authenticated": true, "authenticationUrl": "authenticationUrl", "patSupported": true, "scmId": "scmId", "scmName": "scmName", "supportsOauth2": { "authUrl": "authUrl", "docsUrl": "docsUrl" }, "supportsPat": { "createUrl": "createUrl", "docsUrl": "docsUrl", "example": "example", "requiredScopes": [ "string" ] } } ``` ## CheckRepositoryAccess `client.Runners.CheckRepositoryAccess(ctx, body) (*RunnerCheckRepositoryAccessResponse, error)` **post** `/gitpod.v1.RunnerService/CheckRepositoryAccess` Checks if a principal has read access to a repository. Use this method to: - Validate repository access before workflow execution - Verify executor credentials for automation bindings Returns: - has_access: true if the principal can read the repository - FAILED_PRECONDITION if authentication is required - INVALID_ARGUMENT if the repository URL is invalid ### Examples - Check access: Verifies read access to a repository. ```yaml runnerId: "d2c94c27-3b76-4a42-b88c-95a85e392c68" repositoryUrl: "https://github.com/org/repo" ``` ### Parameters - `body RunnerCheckRepositoryAccessParams` - `RepositoryURL param.Field[string]` repository_url is the URL of the repository to check access for. Can be a clone URL (https://github.com/org/repo.git) or web URL (https://github.com/org/repo). - `RunnerID param.Field[string]` ### Returns - `type RunnerCheckRepositoryAccessResponse struct{…}` - `ErrorMessage string` error_message provides details when access check fails. Empty when has_access is true. - `HasAccess bool` has_access indicates whether the principal has read access to the repository. ### Example ```go 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"), ) response, err := client.Runners.CheckRepositoryAccess(context.TODO(), gitpod.RunnerCheckRepositoryAccessParams{ RepositoryURL: gitpod.F("https://github.com/org/repo"), RunnerID: gitpod.F("d2c94c27-3b76-4a42-b88c-95a85e392c68"), }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", response.ErrorMessage) } ``` #### Response ```json { "errorMessage": "errorMessage", "hasAccess": true } ``` ## CreateRunner `client.Runners.New(ctx, body) (*RunnerNewResponse, error)` **post** `/gitpod.v1.RunnerService/CreateRunner` Creates a new runner registration with the server. Registrations are very short-lived and must be renewed every 30 seconds. Use this method to: - Register organization runners - Set up runner configurations - Initialize runner credentials - Configure auto-updates ### Examples - Create cloud runner: Creates a new runner in AWS EC2. ```yaml name: "Production Runner" provider: RUNNER_PROVIDER_AWS_EC2 spec: desiredPhase: RUNNER_PHASE_ACTIVE configuration: region: "us-west" releaseChannel: RUNNER_RELEASE_CHANNEL_STABLE autoUpdate: true ``` - Create local runner: Creates a new local runner on Linux. ```yaml name: "Local Development Runner" provider: RUNNER_PROVIDER_LINUX_HOST spec: desiredPhase: RUNNER_PHASE_ACTIVE configuration: releaseChannel: RUNNER_RELEASE_CHANNEL_LATEST autoUpdate: true ``` ### Parameters - `body RunnerNewParams` - `Kind param.Field[RunnerKind]` The runner's kind This field is optional and here for backwards-compatibility. Use the provider field instead. If provider is set, the runner's kind will be deduced from the provider. Only one of kind and provider must be set. - `Name param.Field[string]` The runner name for humans - `Provider param.Field[RunnerProvider]` The specific implementation type of the runner This field is optional for backwards compatibility but will be required in the future. When specified, kind must not be specified (will be deduced from provider) - `RunnerManagerID param.Field[string]` The runner manager id specifies the runner manager for the managed runner. This field is mandatory for managed runners, otheriwse should not be set. - `Spec param.Field[RunnerSpec]` ### Returns - `type RunnerNewResponse struct{…}` - `Runner Runner` - `CreatedAt Time` Time when the Runner was created. - `Creator Subject` creator is the identity of the creator of the environment - `ID string` id is the UUID of the subject - `Principal Principal` Principal is the principal of the subject - `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 RunnerKind` The runner's kind - `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 string` The runner's name which is shown to users - `Provider RunnerProvider` The runner's provider - `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 string` - `RunnerManagerID string` The runner manager id specifies the runner manager for the managed runner. This field is only set for managed runners. - `Spec RunnerSpec` The runner's specification - `Configuration RunnerConfiguration` The runner's configuration - `AutoUpdate bool` auto_update indicates whether the runner should automatically update itself. - `DevcontainerImageCacheEnabled bool` 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 LogLevel` log_level is the log level for the runner - `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 MetricsConfiguration` metrics contains configuration for the runner's metrics collection - `Enabled bool` enabled indicates whether the runner should collect metrics - `ManagedMetricsEnabled bool` When true, the runner pushes metrics to the management plane via ReportRunnerMetrics instead of directly to the remote_write endpoint. - `Password string` password is the password to use for the metrics collector - `URL string` url is the URL of the metrics collector - `Username string` username is the username to use for the metrics collector - `Region string` 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 RunnerReleaseChannel` The release channel the runner is on - `const RunnerReleaseChannelUnspecified RunnerReleaseChannel = "RUNNER_RELEASE_CHANNEL_UNSPECIFIED"` - `const RunnerReleaseChannelStable RunnerReleaseChannel = "RUNNER_RELEASE_CHANNEL_STABLE"` - `const RunnerReleaseChannelLatest RunnerReleaseChannel = "RUNNER_RELEASE_CHANNEL_LATEST"` - `UpdateWindow UpdateWindow` update_window defines the daily time window (UTC) during which auto-updates are allowed. If not set, updates are allowed at any time. - `EndHour int64` end_hour is the end of the update window as a UTC hour (0-23). If not set, defaults to start_hour + 2. - `StartHour int64` start_hour is the beginning of the update window as a UTC hour (0-23). +required - `DesiredPhase RunnerPhase` RunnerPhase represents the phase a runner is in - `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 RunnerVariant` The runner's variant - `const RunnerVariantUnspecified RunnerVariant = "RUNNER_VARIANT_UNSPECIFIED"` - `const RunnerVariantStandard RunnerVariant = "RUNNER_VARIANT_STANDARD"` - `const RunnerVariantEnterprise RunnerVariant = "RUNNER_VARIANT_ENTERPRISE"` - `Status RunnerStatus` The runner's status - `AdditionalInfo []FieldValue` additional_info contains additional information about the runner, e.g. a CloudFormation stack URL. - `Key string` - `Value string` - `Capabilities []RunnerCapability` capabilities is a list of capabilities the runner supports. - `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 GatewayInfo` gateway_info is information about the gateway to which the runner is connected. - `Gateway Gateway` 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 string` region is the geographical region where the gateway is located - `Latency string` latency is the round-trip time of the runner to the gateway in milliseconds. - `LlmURL string` llm_url is the URL of the LLM service to which the runner is connected. - `LogURL string` - `Message string` The runner's reported message which is shown to users. This message adds more context to the runner's phase. - `Phase RunnerPhase` The runner's reported phase - `PublicKey string` public_key is the runner's public key used for encryption (32 bytes) - `Region string` region is the region the runner is running in, if applicable. - `SupportBundleURL string` 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 string` - `UpdatedAt Time` Time when the status was last updated. - `Version string` - `UpdatedAt Time` Time when the Runner was last udpated. - `AccessToken string` deprecated, will be removed. Use exchange_token instead. - `ExchangeToken string` exchange_token is a one-time use token that should be exchanged by the runner for an access token, using the IdentityService.ExchangeToken rpc. The token expires after 24 hours. ### Example ```go 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"), ) runner, err := client.Runners.New(context.TODO(), gitpod.RunnerNewParams{ Name: gitpod.F("Production Runner"), Provider: gitpod.F(gitpod.RunnerProviderAwsEc2), Spec: gitpod.F(gitpod.RunnerSpecParam{ Configuration: gitpod.F(gitpod.RunnerConfigurationParam{ AutoUpdate: gitpod.F(true), Region: gitpod.F("us-west"), ReleaseChannel: gitpod.F(gitpod.RunnerReleaseChannelStable), }), DesiredPhase: gitpod.F(gitpod.RunnerPhaseActive), }), }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", runner.Runner) } ``` #### Response ```json { "runner": { "createdAt": "2019-12-27T18:11:19.117Z", "creator": { "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "principal": "PRINCIPAL_UNSPECIFIED" }, "kind": "RUNNER_KIND_UNSPECIFIED", "name": "name", "provider": "RUNNER_PROVIDER_UNSPECIFIED", "runnerId": "runnerId", "runnerManagerId": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "spec": { "configuration": { "autoUpdate": true, "continuousProfiling": true, "devcontainerImageCacheEnabled": true, "encryptedHoneycombApiKey": "U3RhaW5sZXNzIHJvY2tz", "logLevel": "LOG_LEVEL_UNSPECIFIED", "metrics": { "enabled": true, "includeVerboseMetrics": true, "managedMetricsEnabled": true, "password": "password", "url": "url", "username": "username" }, "region": "region", "releaseChannel": "RUNNER_RELEASE_CHANNEL_UNSPECIFIED", "updateWindow": { "endHour": 0, "startHour": 0 } }, "desiredPhase": "RUNNER_PHASE_UNSPECIFIED", "variant": "RUNNER_VARIANT_UNSPECIFIED" }, "status": { "additionalInfo": [ { "key": "key", "value": "value" } ], "capabilities": [ "RUNNER_CAPABILITY_UNSPECIFIED" ], "gatewayInfo": { "gateway": { "name": "name", "url": "url", "region": "region" }, "latency": "+9125115.360s" }, "llmUrl": "llmUrl", "logUrl": "logUrl", "message": "message", "phase": "RUNNER_PHASE_UNSPECIFIED", "publicKey": "U3RhaW5sZXNzIHJvY2tz", "region": "region", "supportBundleUrl": "supportBundleUrl", "systemDetails": "systemDetails", "updatedAt": "2019-12-27T18:11:19.117Z", "version": "version" }, "updatedAt": "2019-12-27T18:11:19.117Z" }, "accessToken": "accessToken", "exchangeToken": "exchangeToken" } ``` ## CreateRunnerLogsToken `client.Runners.NewLogsToken(ctx, body) (*RunnerNewLogsTokenResponse, error)` **post** `/gitpod.v1.RunnerService/CreateRunnerLogsToken` Creates an access token for runner logs and debug information. Generated tokens are valid for one hour and provide runner-specific access permissions. The token is scoped to a specific runner and can be used to access support bundles. ### Examples - Generate runner logs token: ```yaml runnerId: "d2c94c27-3b76-4a42-b88c-95a85e392c68" ``` ### Parameters - `body RunnerNewLogsTokenParams` - `RunnerID param.Field[string]` runner_id specifies the runner for which the logs token should be created. +required ### Returns - `type RunnerNewLogsTokenResponse struct{…}` - `AccessToken string` access_token is the token that can be used to access the logs and support bundle of the runner ### Example ```go 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"), ) response, err := client.Runners.NewLogsToken(context.TODO(), gitpod.RunnerNewLogsTokenParams{ RunnerID: gitpod.F("d2c94c27-3b76-4a42-b88c-95a85e392c68"), }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", response.AccessToken) } ``` #### Response ```json { "accessToken": "accessToken" } ``` ## CreateRunnerToken `client.Runners.NewRunnerToken(ctx, body) (*RunnerNewRunnerTokenResponse, error)` **post** `/gitpod.v1.RunnerService/CreateRunnerToken` Creates a new authentication token for a runner. Use this method to: - Generate runner credentials - Renew expired tokens - Set up runner authentication Note: This does not expire previously issued tokens. ### Examples - Create token: Creates a new token for runner authentication. ```yaml runnerId: "d2c94c27-3b76-4a42-b88c-95a85e392c68" ``` ### Parameters - `body RunnerNewRunnerTokenParams` - `RunnerID param.Field[string]` ### Returns - `type RunnerNewRunnerTokenResponse struct{…}` - `AccessToken string` deprecated, will be removed. Use exchange_token instead. - `ExchangeToken string` exchange_token is a one-time use token that should be exchanged by the runner for an access token, using the IdentityService.ExchangeToken rpc. The token expires after 24 hours. ### Example ```go 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"), ) response, err := client.Runners.NewRunnerToken(context.TODO(), gitpod.RunnerNewRunnerTokenParams{ RunnerID: gitpod.F("d2c94c27-3b76-4a42-b88c-95a85e392c68"), }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", response.AccessToken) } ``` #### Response ```json { "accessToken": "accessToken", "exchangeToken": "exchangeToken" } ``` ## DeleteRunner `client.Runners.Delete(ctx, body) (*RunnerDeleteResponse, error)` **post** `/gitpod.v1.RunnerService/DeleteRunner` Deletes a runner permanently. Use this method to: - Remove unused runners - Clean up runner registrations - Delete obsolete runners ### Examples - Delete runner: Permanently removes a runner. ```yaml runnerId: "d2c94c27-3b76-4a42-b88c-95a85e392c68" ``` ### Parameters - `body RunnerDeleteParams` - `Force param.Field[bool]` force indicates whether the runner should be deleted forcefully. When force deleting a Runner, all Environments on the runner are also force deleted and regular Runner lifecycle is not respected. Force deleting can result in data loss. - `RunnerID param.Field[string]` ### Returns - `type RunnerDeleteResponse interface{…}` ### Example ```go 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"), ) runner, err := client.Runners.Delete(context.TODO(), gitpod.RunnerDeleteParams{ RunnerID: gitpod.F("d2c94c27-3b76-4a42-b88c-95a85e392c68"), }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", runner) } ``` #### Response ```json {} ``` ## ListRunners `client.Runners.List(ctx, params) (*RunnersPage[Runner], error)` **post** `/gitpod.v1.RunnerService/ListRunners` Lists all registered runners with optional filtering. Use this method to: - View all available runners - Filter by runner type - Monitor runner status - Check runner availability ### Examples - List all runners: Shows all runners with pagination. ```yaml pagination: pageSize: 20 ``` - Filter by provider: Lists only AWS EC2 runners. ```yaml filter: providers: ["RUNNER_PROVIDER_AWS_EC2"] pagination: pageSize: 20 ``` ### Parameters - `params RunnerListParams` - `Token param.Field[string]` Query param - `PageSize param.Field[int64]` Query param - `Filter param.Field[RunnerListParamsFilter]` Body param - `CreatorIDs []string` creator_ids filters the response to only runner created by specified users - `Kinds []RunnerKind` kinds filters the response to only runners of the specified kinds - `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"` - `Providers []RunnerProvider` providers filters the response to only runners of the specified providers - `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"` - `Pagination param.Field[RunnerListParamsPagination]` Body param: pagination contains the pagination options for listing runners - `Token string` Token for the next set of results that was returned as next_token of a PaginationResponse - `PageSize int64` Page size is the maximum number of results to retrieve per page. Defaults to 25. Maximum 100. ### Returns - `type Runner struct{…}` - `CreatedAt Time` Time when the Runner was created. - `Creator Subject` creator is the identity of the creator of the environment - `ID string` id is the UUID of the subject - `Principal Principal` Principal is the principal of the subject - `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 RunnerKind` The runner's kind - `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 string` The runner's name which is shown to users - `Provider RunnerProvider` The runner's provider - `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 string` - `RunnerManagerID string` The runner manager id specifies the runner manager for the managed runner. This field is only set for managed runners. - `Spec RunnerSpec` The runner's specification - `Configuration RunnerConfiguration` The runner's configuration - `AutoUpdate bool` auto_update indicates whether the runner should automatically update itself. - `DevcontainerImageCacheEnabled bool` 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 LogLevel` log_level is the log level for the runner - `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 MetricsConfiguration` metrics contains configuration for the runner's metrics collection - `Enabled bool` enabled indicates whether the runner should collect metrics - `ManagedMetricsEnabled bool` When true, the runner pushes metrics to the management plane via ReportRunnerMetrics instead of directly to the remote_write endpoint. - `Password string` password is the password to use for the metrics collector - `URL string` url is the URL of the metrics collector - `Username string` username is the username to use for the metrics collector - `Region string` 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 RunnerReleaseChannel` The release channel the runner is on - `const RunnerReleaseChannelUnspecified RunnerReleaseChannel = "RUNNER_RELEASE_CHANNEL_UNSPECIFIED"` - `const RunnerReleaseChannelStable RunnerReleaseChannel = "RUNNER_RELEASE_CHANNEL_STABLE"` - `const RunnerReleaseChannelLatest RunnerReleaseChannel = "RUNNER_RELEASE_CHANNEL_LATEST"` - `UpdateWindow UpdateWindow` update_window defines the daily time window (UTC) during which auto-updates are allowed. If not set, updates are allowed at any time. - `EndHour int64` end_hour is the end of the update window as a UTC hour (0-23). If not set, defaults to start_hour + 2. - `StartHour int64` start_hour is the beginning of the update window as a UTC hour (0-23). +required - `DesiredPhase RunnerPhase` RunnerPhase represents the phase a runner is in - `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 RunnerVariant` The runner's variant - `const RunnerVariantUnspecified RunnerVariant = "RUNNER_VARIANT_UNSPECIFIED"` - `const RunnerVariantStandard RunnerVariant = "RUNNER_VARIANT_STANDARD"` - `const RunnerVariantEnterprise RunnerVariant = "RUNNER_VARIANT_ENTERPRISE"` - `Status RunnerStatus` The runner's status - `AdditionalInfo []FieldValue` additional_info contains additional information about the runner, e.g. a CloudFormation stack URL. - `Key string` - `Value string` - `Capabilities []RunnerCapability` capabilities is a list of capabilities the runner supports. - `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 GatewayInfo` gateway_info is information about the gateway to which the runner is connected. - `Gateway Gateway` 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 string` region is the geographical region where the gateway is located - `Latency string` latency is the round-trip time of the runner to the gateway in milliseconds. - `LlmURL string` llm_url is the URL of the LLM service to which the runner is connected. - `LogURL string` - `Message string` The runner's reported message which is shown to users. This message adds more context to the runner's phase. - `Phase RunnerPhase` The runner's reported phase - `PublicKey string` public_key is the runner's public key used for encryption (32 bytes) - `Region string` region is the region the runner is running in, if applicable. - `SupportBundleURL string` 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 string` - `UpdatedAt Time` Time when the status was last updated. - `Version string` - `UpdatedAt Time` Time when the Runner was last udpated. ### Example ```go 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"), ) page, err := client.Runners.List(context.TODO(), gitpod.RunnerListParams{ Filter: gitpod.F(gitpod.RunnerListParamsFilter{ Providers: gitpod.F([]gitpod.RunnerProvider{gitpod.RunnerProviderAwsEc2}), }), Pagination: gitpod.F(gitpod.RunnerListParamsPagination{ PageSize: gitpod.F(int64(20)), }), }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", page) } ``` #### Response ```json { "pagination": { "nextToken": "nextToken" }, "runners": [ { "createdAt": "2019-12-27T18:11:19.117Z", "creator": { "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "principal": "PRINCIPAL_UNSPECIFIED" }, "kind": "RUNNER_KIND_UNSPECIFIED", "name": "name", "provider": "RUNNER_PROVIDER_UNSPECIFIED", "runnerId": "runnerId", "runnerManagerId": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "spec": { "configuration": { "autoUpdate": true, "continuousProfiling": true, "devcontainerImageCacheEnabled": true, "encryptedHoneycombApiKey": "U3RhaW5sZXNzIHJvY2tz", "logLevel": "LOG_LEVEL_UNSPECIFIED", "metrics": { "enabled": true, "includeVerboseMetrics": true, "managedMetricsEnabled": true, "password": "password", "url": "url", "username": "username" }, "region": "region", "releaseChannel": "RUNNER_RELEASE_CHANNEL_UNSPECIFIED", "updateWindow": { "endHour": 0, "startHour": 0 } }, "desiredPhase": "RUNNER_PHASE_UNSPECIFIED", "variant": "RUNNER_VARIANT_UNSPECIFIED" }, "status": { "additionalInfo": [ { "key": "key", "value": "value" } ], "capabilities": [ "RUNNER_CAPABILITY_UNSPECIFIED" ], "gatewayInfo": { "gateway": { "name": "name", "url": "url", "region": "region" }, "latency": "+9125115.360s" }, "llmUrl": "llmUrl", "logUrl": "logUrl", "message": "message", "phase": "RUNNER_PHASE_UNSPECIFIED", "publicKey": "U3RhaW5sZXNzIHJvY2tz", "region": "region", "supportBundleUrl": "supportBundleUrl", "systemDetails": "systemDetails", "updatedAt": "2019-12-27T18:11:19.117Z", "version": "version" }, "updatedAt": "2019-12-27T18:11:19.117Z" } ] } ``` ## ListSCMOrganizations `client.Runners.ListScmOrganizations(ctx, params) (*RunnerListScmOrganizationsResponse, error)` **post** `/gitpod.v1.RunnerService/ListSCMOrganizations` Lists SCM organizations the user belongs to. Use this method to: - Get all organizations for a user on a specific SCM host - Check organization admin permissions for webhook creation ### Examples - List GitHub organizations: Lists all organizations the user belongs to on GitHub. ```yaml runnerId: "d2c94c27-3b76-4a42-b88c-95a85e392c68" scmHost: "github.com" ``` ### Parameters - `params RunnerListScmOrganizationsParams` - `Token param.Field[string]` Query param - `PageSize param.Field[int64]` Query param - `RunnerID param.Field[string]` Body param - `ScmHost param.Field[string]` Body param: The SCM host to list organizations from (e.g., "github.com", "gitlab.com") ### Returns - `type RunnerListScmOrganizationsResponse struct{…}` - `Organizations []RunnerListScmOrganizationsResponseOrganization` List of organizations the user belongs to - `IsAdmin bool` Whether the user has admin permissions in this organization. Admin permissions typically allow creating organization-level webhooks. - `Name string` Organization name/slug (e.g., "gitpod-io") - `URL string` Organization URL (e.g., "https://github.com/gitpod-io") ### Example ```go 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"), ) response, err := client.Runners.ListScmOrganizations(context.TODO(), gitpod.RunnerListScmOrganizationsParams{ RunnerID: gitpod.F("d2c94c27-3b76-4a42-b88c-95a85e392c68"), ScmHost: gitpod.F("github.com"), }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", response.Organizations) } ``` #### Response ```json { "organizations": [ { "isAdmin": true, "name": "name", "url": "url" } ] } ``` ## ParseContextURL `client.Runners.ParseContextURL(ctx, body) (*RunnerParseContextURLResponse, error)` **post** `/gitpod.v1.RunnerService/ParseContextURL` Parses a context URL and returns the parsed result. Use this method to: - Validate context URLs - Check repository access - Verify branch existence Returns: - FAILED_PRECONDITION if authentication is required - PERMISSION_DENIED if access is not allowed - INVALID_ARGUMENT if URL is invalid - NOT_FOUND if repository/branch doesn't exist ### Examples - Parse URL: Parses and validates a context URL. ```yaml contextUrl: "https://github.com/org/repo/tree/main" ``` ### Parameters - `body RunnerParseContextURLParams` - `ContextURL param.Field[string]` - `RunnerID param.Field[string]` ### Returns - `type RunnerParseContextURLResponse struct{…}` - `Git RunnerParseContextURLResponseGit` - `Branch string` - `CloneURL string` - `Commit string` - `Host string` - `Owner string` - `Repo string` - `Tag string` - `UpstreamRemoteURL string` - `Issue RunnerParseContextURLResponseIssue` - `ID string` id is the source system's ID of this issue, e.g. BNFRD-6100 - `Title string` - `OriginalContextURL string` - `Pr RunnerParseContextURLResponsePr` Deprecated: Use top-level PullRequest message instead - `ID string` - `FromBranch string` - `Title string` - `ToBranch string` - `ProjectIDs []string` project_ids is a list of projects to which the context URL belongs to. - `PullRequest RunnerParseContextURLResponsePullRequest` PullRequest represents pull request metadata from source control systems. This message is used across workflow triggers, executions, and agent contexts to maintain consistent PR information throughout the system. - `ID string` Unique identifier from the source system (e.g., "123" for GitHub PR #123) - `Author string` Author name as provided by the SCM system - `Draft bool` Whether this is a draft pull request - `FromBranch string` Source branch name (the branch being merged from) - `Repository RunnerParseContextURLResponsePullRequestRepository` Repository information - `CloneURL string` - `Host string` - `Name string` - `Owner string` - `State State` Current state of the pull request - `const StateUnspecified State = "STATE_UNSPECIFIED"` - `const StateOpen State = "STATE_OPEN"` - `const StateClosed State = "STATE_CLOSED"` - `const StateMerged State = "STATE_MERGED"` - `Title string` Pull request title - `ToBranch string` Target branch name (the branch being merged into) - `URL string` Pull request URL (e.g., "https://github.com/owner/repo/pull/123") - `ScmID string` scm_id is the unique identifier of the SCM provider (e.g., "github", "gitlab", "bitbucket") ### Example ```go 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"), ) response, err := client.Runners.ParseContextURL(context.TODO(), gitpod.RunnerParseContextURLParams{ ContextURL: gitpod.F("https://github.com/org/repo/tree/main"), }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", response.Git) } ``` #### Response ```json { "git": { "branch": "branch", "cloneUrl": "cloneUrl", "commit": "commit", "host": "host", "owner": "owner", "repo": "repo", "tag": "tag", "upstreamRemoteUrl": "upstreamRemoteUrl" }, "issue": { "id": "id", "title": "title" }, "originalContextUrl": "originalContextUrl", "pr": { "id": "id", "fromBranch": "fromBranch", "title": "title", "toBranch": "toBranch" }, "projectIds": [ "string" ], "pullRequest": { "id": "id", "author": "author", "draft": true, "fromBranch": "fromBranch", "repository": { "cloneUrl": "cloneUrl", "host": "host", "name": "name", "owner": "owner" }, "state": "STATE_UNSPECIFIED", "title": "title", "toBranch": "toBranch", "url": "url" }, "scmId": "scmId" } ``` ## GetRunner `client.Runners.Get(ctx, body) (*RunnerGetResponse, error)` **post** `/gitpod.v1.RunnerService/GetRunner` Gets details about a specific runner. Use this method to: - Check runner status - View runner configuration - Monitor runner health - Verify runner capabilities ### Examples - Get runner details: Retrieves information about a specific runner. ```yaml runnerId: "d2c94c27-3b76-4a42-b88c-95a85e392c68" ``` ### Parameters - `body RunnerGetParams` - `RunnerID param.Field[string]` ### Returns - `type RunnerGetResponse struct{…}` - `Runner Runner` - `CreatedAt Time` Time when the Runner was created. - `Creator Subject` creator is the identity of the creator of the environment - `ID string` id is the UUID of the subject - `Principal Principal` Principal is the principal of the subject - `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 RunnerKind` The runner's kind - `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 string` The runner's name which is shown to users - `Provider RunnerProvider` The runner's provider - `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 string` - `RunnerManagerID string` The runner manager id specifies the runner manager for the managed runner. This field is only set for managed runners. - `Spec RunnerSpec` The runner's specification - `Configuration RunnerConfiguration` The runner's configuration - `AutoUpdate bool` auto_update indicates whether the runner should automatically update itself. - `DevcontainerImageCacheEnabled bool` 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 LogLevel` log_level is the log level for the runner - `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 MetricsConfiguration` metrics contains configuration for the runner's metrics collection - `Enabled bool` enabled indicates whether the runner should collect metrics - `ManagedMetricsEnabled bool` When true, the runner pushes metrics to the management plane via ReportRunnerMetrics instead of directly to the remote_write endpoint. - `Password string` password is the password to use for the metrics collector - `URL string` url is the URL of the metrics collector - `Username string` username is the username to use for the metrics collector - `Region string` 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 RunnerReleaseChannel` The release channel the runner is on - `const RunnerReleaseChannelUnspecified RunnerReleaseChannel = "RUNNER_RELEASE_CHANNEL_UNSPECIFIED"` - `const RunnerReleaseChannelStable RunnerReleaseChannel = "RUNNER_RELEASE_CHANNEL_STABLE"` - `const RunnerReleaseChannelLatest RunnerReleaseChannel = "RUNNER_RELEASE_CHANNEL_LATEST"` - `UpdateWindow UpdateWindow` update_window defines the daily time window (UTC) during which auto-updates are allowed. If not set, updates are allowed at any time. - `EndHour int64` end_hour is the end of the update window as a UTC hour (0-23). If not set, defaults to start_hour + 2. - `StartHour int64` start_hour is the beginning of the update window as a UTC hour (0-23). +required - `DesiredPhase RunnerPhase` RunnerPhase represents the phase a runner is in - `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 RunnerVariant` The runner's variant - `const RunnerVariantUnspecified RunnerVariant = "RUNNER_VARIANT_UNSPECIFIED"` - `const RunnerVariantStandard RunnerVariant = "RUNNER_VARIANT_STANDARD"` - `const RunnerVariantEnterprise RunnerVariant = "RUNNER_VARIANT_ENTERPRISE"` - `Status RunnerStatus` The runner's status - `AdditionalInfo []FieldValue` additional_info contains additional information about the runner, e.g. a CloudFormation stack URL. - `Key string` - `Value string` - `Capabilities []RunnerCapability` capabilities is a list of capabilities the runner supports. - `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 GatewayInfo` gateway_info is information about the gateway to which the runner is connected. - `Gateway Gateway` 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 string` region is the geographical region where the gateway is located - `Latency string` latency is the round-trip time of the runner to the gateway in milliseconds. - `LlmURL string` llm_url is the URL of the LLM service to which the runner is connected. - `LogURL string` - `Message string` The runner's reported message which is shown to users. This message adds more context to the runner's phase. - `Phase RunnerPhase` The runner's reported phase - `PublicKey string` public_key is the runner's public key used for encryption (32 bytes) - `Region string` region is the region the runner is running in, if applicable. - `SupportBundleURL string` 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 string` - `UpdatedAt Time` Time when the status was last updated. - `Version string` - `UpdatedAt Time` Time when the Runner was last udpated. ### Example ```go 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"), ) runner, err := client.Runners.Get(context.TODO(), gitpod.RunnerGetParams{ RunnerID: gitpod.F("d2c94c27-3b76-4a42-b88c-95a85e392c68"), }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", runner.Runner) } ``` #### Response ```json { "runner": { "createdAt": "2019-12-27T18:11:19.117Z", "creator": { "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "principal": "PRINCIPAL_UNSPECIFIED" }, "kind": "RUNNER_KIND_UNSPECIFIED", "name": "name", "provider": "RUNNER_PROVIDER_UNSPECIFIED", "runnerId": "runnerId", "runnerManagerId": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "spec": { "configuration": { "autoUpdate": true, "continuousProfiling": true, "devcontainerImageCacheEnabled": true, "encryptedHoneycombApiKey": "U3RhaW5sZXNzIHJvY2tz", "logLevel": "LOG_LEVEL_UNSPECIFIED", "metrics": { "enabled": true, "includeVerboseMetrics": true, "managedMetricsEnabled": true, "password": "password", "url": "url", "username": "username" }, "region": "region", "releaseChannel": "RUNNER_RELEASE_CHANNEL_UNSPECIFIED", "updateWindow": { "endHour": 0, "startHour": 0 } }, "desiredPhase": "RUNNER_PHASE_UNSPECIFIED", "variant": "RUNNER_VARIANT_UNSPECIFIED" }, "status": { "additionalInfo": [ { "key": "key", "value": "value" } ], "capabilities": [ "RUNNER_CAPABILITY_UNSPECIFIED" ], "gatewayInfo": { "gateway": { "name": "name", "url": "url", "region": "region" }, "latency": "+9125115.360s" }, "llmUrl": "llmUrl", "logUrl": "logUrl", "message": "message", "phase": "RUNNER_PHASE_UNSPECIFIED", "publicKey": "U3RhaW5sZXNzIHJvY2tz", "region": "region", "supportBundleUrl": "supportBundleUrl", "systemDetails": "systemDetails", "updatedAt": "2019-12-27T18:11:19.117Z", "version": "version" }, "updatedAt": "2019-12-27T18:11:19.117Z" } } ``` ## SearchRepositories `client.Runners.SearchRepositories(ctx, body) (*RunnerSearchRepositoriesResponse, error)` **post** `/gitpod.v1.RunnerService/SearchRepositories` Searches for repositories across all authenticated SCM hosts. Use this method to: - List available repositories - Search repositories by name or content - Discover repositories for environment creation Returns repositories from all authenticated SCM hosts in natural sort order. If no repositories are found, returns an empty list. ### Examples - List all repositories: Returns up to 25 repositories from all authenticated hosts. ```yaml runnerId: "d2c94c27-3b76-4a42-b88c-95a85e392c68" ``` - Search repositories: Searches for repositories matching the query across all hosts. ```yaml runnerId: "d2c94c27-3b76-4a42-b88c-95a85e392c68" searchString: "my-project" limit: 10 ``` ### Parameters - `body RunnerSearchRepositoriesParams` - `Limit param.Field[int64]` Maximum number of repositories to return. Default: 25, Maximum: 100 Deprecated: Use pagination.page_size instead - `Pagination param.Field[RunnerSearchRepositoriesParamsPagination]` Pagination parameters for repository search - `Token string` Token for the next set of results that was returned as next_token of a PaginationResponse - `PageSize int64` Page size is the maximum number of results to retrieve per page. Defaults to 25. Maximum 100. - `RunnerID param.Field[string]` - `ScmHost param.Field[string]` The SCM's host to retrieve repositories from - `SearchMode param.Field[SearchMode]` Search mode determines how search_string is interpreted - `SearchString param.Field[string]` Search query - interpretation depends on search_mode ### Returns - `type RunnerSearchRepositoriesResponse struct{…}` - `LastPage int64` Deprecated: Use pagination token instead. Total pages can be extracted from token. - `Pagination RunnerSearchRepositoriesResponsePagination` Pagination information for the response. Token format: "NEXT_PAGE/TOTAL_PAGES/TOTAL_COUNT" (e.g., "2/40/1000"). Use -1 for unknown values (e.g., "2/-1/-1" when totals unavailable). Empty token means no more pages. - `NextToken string` Token passed for retrieving the next set of results. Empty if there are no more results - `Repositories []RunnerSearchRepositoriesResponseRepository` List of repositories matching the search criteria - `Name string` Repository name (e.g., "my-project") - `URL string` Repository URL (e.g., "https://github.com/owner/my-project") ### Example ```go 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"), ) response, err := client.Runners.SearchRepositories(context.TODO(), gitpod.RunnerSearchRepositoriesParams{ RunnerID: gitpod.F("d2c94c27-3b76-4a42-b88c-95a85e392c68"), }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", response.LastPage) } ``` #### Response ```json { "lastPage": 0, "pagination": { "nextToken": "nextToken" }, "repositories": [ { "name": "name", "url": "url" } ] } ``` ## UpdateRunner `client.Runners.Update(ctx, body) (*RunnerUpdateResponse, error)` **post** `/gitpod.v1.RunnerService/UpdateRunner` Updates a runner's configuration. Use this method to: - Modify runner settings - Update release channels - Change runner status - Configure auto-update settings ### Examples - Update configuration: Changes runner settings. ```yaml runnerId: "d2c94c27-3b76-4a42-b88c-95a85e392c68" name: "Updated Runner Name" spec: configuration: releaseChannel: RUNNER_RELEASE_CHANNEL_LATEST autoUpdate: true ``` ### Parameters - `body RunnerUpdateParams` - `Name param.Field[string]` The runner's name which is shown to users - `RunnerID param.Field[string]` runner_id specifies which runner to be updated. +required - `Spec param.Field[RunnerUpdateParamsSpec]` - `Configuration RunnerUpdateParamsSpecConfiguration` - `AutoUpdate bool` auto_update indicates whether the runner should automatically update itself. - `DevcontainerImageCacheEnabled bool` devcontainer_image_cache_enabled controls whether the shared devcontainer build cache is enabled for this runner. - `LogLevel LogLevel` log_level is the log level for the runner - `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 RunnerUpdateParamsSpecConfigurationMetrics` metrics contains configuration for the runner's metrics collection - `Enabled bool` enabled indicates whether the runner should collect metrics - `ManagedMetricsEnabled bool` When true, the runner pushes metrics to the management plane via ReportRunnerMetrics instead of directly to the remote_write endpoint. - `Password string` password is the password to use for the metrics collector - `URL string` url is the URL of the metrics collector - `Username string` username is the username to use for the metrics collector - `ReleaseChannel RunnerReleaseChannel` The release channel the runner is on - `const RunnerReleaseChannelUnspecified RunnerReleaseChannel = "RUNNER_RELEASE_CHANNEL_UNSPECIFIED"` - `const RunnerReleaseChannelStable RunnerReleaseChannel = "RUNNER_RELEASE_CHANNEL_STABLE"` - `const RunnerReleaseChannelLatest RunnerReleaseChannel = "RUNNER_RELEASE_CHANNEL_LATEST"` - `UpdateWindow UpdateWindow` update_window defines the daily time window (UTC) during which auto-updates are allowed. start_hour is required. If end_hour is omitted, it defaults to start_hour + 2. Send an empty UpdateWindow (no start_hour or end_hour) to clear a custom window and allow updates at any time. - `EndHour int64` end_hour is the end of the update window as a UTC hour (0-23). If not set, defaults to start_hour + 2. - `StartHour int64` start_hour is the beginning of the update window as a UTC hour (0-23). +required - `DesiredPhase RunnerPhase` desired_phase can currently only be updated on local-configuration runners, to toggle whether local runners are allowed for running environments in the organization. Set to: - ACTIVE to enable local runners. - INACTIVE to disable all local runners. Existing local runners and their environments will stop, and cannot be started again until the desired_phase is set to ACTIVE. Use this carefully, as it will affect all users in the organization who use local runners. - `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"` ### Returns - `type RunnerUpdateResponse interface{…}` ### Example ```go 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"), ) runner, err := client.Runners.Update(context.TODO(), gitpod.RunnerUpdateParams{ Name: gitpod.F("Updated Runner Name"), RunnerID: gitpod.F("d2c94c27-3b76-4a42-b88c-95a85e392c68"), Spec: gitpod.F(gitpod.RunnerUpdateParamsSpec{ Configuration: gitpod.F(gitpod.RunnerUpdateParamsSpecConfiguration{ AutoUpdate: gitpod.F(true), ReleaseChannel: gitpod.F(gitpod.RunnerReleaseChannelLatest), }), }), }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", runner) } ``` #### Response ```json {} ``` ## Domain Types ### Gateway Info - `type GatewayInfo struct{…}` - `Gateway Gateway` 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 string` region is the geographical region where the gateway is located - `Latency string` latency is the round-trip time of the runner to the gateway in milliseconds. ### Log Level - `type LogLevel string` - `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 Configuration - `type MetricsConfiguration struct{…}` - `Enabled bool` enabled indicates whether the runner should collect metrics - `ManagedMetricsEnabled bool` When true, the runner pushes metrics to the management plane via ReportRunnerMetrics instead of directly to the remote_write endpoint. - `Password string` password is the password to use for the metrics collector - `URL string` url is the URL of the metrics collector - `Username string` username is the username to use for the metrics collector ### Runner - `type Runner struct{…}` - `CreatedAt Time` Time when the Runner was created. - `Creator Subject` creator is the identity of the creator of the environment - `ID string` id is the UUID of the subject - `Principal Principal` Principal is the principal of the subject - `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 RunnerKind` The runner's kind - `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 string` The runner's name which is shown to users - `Provider RunnerProvider` The runner's provider - `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 string` - `RunnerManagerID string` The runner manager id specifies the runner manager for the managed runner. This field is only set for managed runners. - `Spec RunnerSpec` The runner's specification - `Configuration RunnerConfiguration` The runner's configuration - `AutoUpdate bool` auto_update indicates whether the runner should automatically update itself. - `DevcontainerImageCacheEnabled bool` 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 LogLevel` log_level is the log level for the runner - `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 MetricsConfiguration` metrics contains configuration for the runner's metrics collection - `Enabled bool` enabled indicates whether the runner should collect metrics - `ManagedMetricsEnabled bool` When true, the runner pushes metrics to the management plane via ReportRunnerMetrics instead of directly to the remote_write endpoint. - `Password string` password is the password to use for the metrics collector - `URL string` url is the URL of the metrics collector - `Username string` username is the username to use for the metrics collector - `Region string` 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 RunnerReleaseChannel` The release channel the runner is on - `const RunnerReleaseChannelUnspecified RunnerReleaseChannel = "RUNNER_RELEASE_CHANNEL_UNSPECIFIED"` - `const RunnerReleaseChannelStable RunnerReleaseChannel = "RUNNER_RELEASE_CHANNEL_STABLE"` - `const RunnerReleaseChannelLatest RunnerReleaseChannel = "RUNNER_RELEASE_CHANNEL_LATEST"` - `UpdateWindow UpdateWindow` update_window defines the daily time window (UTC) during which auto-updates are allowed. If not set, updates are allowed at any time. - `EndHour int64` end_hour is the end of the update window as a UTC hour (0-23). If not set, defaults to start_hour + 2. - `StartHour int64` start_hour is the beginning of the update window as a UTC hour (0-23). +required - `DesiredPhase RunnerPhase` RunnerPhase represents the phase a runner is in - `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 RunnerVariant` The runner's variant - `const RunnerVariantUnspecified RunnerVariant = "RUNNER_VARIANT_UNSPECIFIED"` - `const RunnerVariantStandard RunnerVariant = "RUNNER_VARIANT_STANDARD"` - `const RunnerVariantEnterprise RunnerVariant = "RUNNER_VARIANT_ENTERPRISE"` - `Status RunnerStatus` The runner's status - `AdditionalInfo []FieldValue` additional_info contains additional information about the runner, e.g. a CloudFormation stack URL. - `Key string` - `Value string` - `Capabilities []RunnerCapability` capabilities is a list of capabilities the runner supports. - `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 GatewayInfo` gateway_info is information about the gateway to which the runner is connected. - `Gateway Gateway` 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 string` region is the geographical region where the gateway is located - `Latency string` latency is the round-trip time of the runner to the gateway in milliseconds. - `LlmURL string` llm_url is the URL of the LLM service to which the runner is connected. - `LogURL string` - `Message string` The runner's reported message which is shown to users. This message adds more context to the runner's phase. - `Phase RunnerPhase` The runner's reported phase - `PublicKey string` public_key is the runner's public key used for encryption (32 bytes) - `Region string` region is the region the runner is running in, if applicable. - `SupportBundleURL string` 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 string` - `UpdatedAt Time` Time when the status was last updated. - `Version string` - `UpdatedAt Time` Time when the Runner was last udpated. ### Runner Capability - `type RunnerCapability string` - `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"` ### Runner Configuration - `type RunnerConfiguration struct{…}` - `AutoUpdate bool` auto_update indicates whether the runner should automatically update itself. - `DevcontainerImageCacheEnabled bool` 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 LogLevel` log_level is the log level for the runner - `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 MetricsConfiguration` metrics contains configuration for the runner's metrics collection - `Enabled bool` enabled indicates whether the runner should collect metrics - `ManagedMetricsEnabled bool` When true, the runner pushes metrics to the management plane via ReportRunnerMetrics instead of directly to the remote_write endpoint. - `Password string` password is the password to use for the metrics collector - `URL string` url is the URL of the metrics collector - `Username string` username is the username to use for the metrics collector - `Region string` 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 RunnerReleaseChannel` The release channel the runner is on - `const RunnerReleaseChannelUnspecified RunnerReleaseChannel = "RUNNER_RELEASE_CHANNEL_UNSPECIFIED"` - `const RunnerReleaseChannelStable RunnerReleaseChannel = "RUNNER_RELEASE_CHANNEL_STABLE"` - `const RunnerReleaseChannelLatest RunnerReleaseChannel = "RUNNER_RELEASE_CHANNEL_LATEST"` - `UpdateWindow UpdateWindow` update_window defines the daily time window (UTC) during which auto-updates are allowed. If not set, updates are allowed at any time. - `EndHour int64` end_hour is the end of the update window as a UTC hour (0-23). If not set, defaults to start_hour + 2. - `StartHour int64` start_hour is the beginning of the update window as a UTC hour (0-23). +required ### Runner Kind - `type RunnerKind string` RunnerKind represents the kind of a runner - `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"` ### Runner Phase - `type RunnerPhase string` RunnerPhase represents the phase a runner is in - `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"` ### Runner Provider - `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. - `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"` ### Runner Release Channel - `type RunnerReleaseChannel string` - `const RunnerReleaseChannelUnspecified RunnerReleaseChannel = "RUNNER_RELEASE_CHANNEL_UNSPECIFIED"` - `const RunnerReleaseChannelStable RunnerReleaseChannel = "RUNNER_RELEASE_CHANNEL_STABLE"` - `const RunnerReleaseChannelLatest RunnerReleaseChannel = "RUNNER_RELEASE_CHANNEL_LATEST"` ### Runner Spec - `type RunnerSpec struct{…}` - `Configuration RunnerConfiguration` The runner's configuration - `AutoUpdate bool` auto_update indicates whether the runner should automatically update itself. - `DevcontainerImageCacheEnabled bool` 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 LogLevel` log_level is the log level for the runner - `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 MetricsConfiguration` metrics contains configuration for the runner's metrics collection - `Enabled bool` enabled indicates whether the runner should collect metrics - `ManagedMetricsEnabled bool` When true, the runner pushes metrics to the management plane via ReportRunnerMetrics instead of directly to the remote_write endpoint. - `Password string` password is the password to use for the metrics collector - `URL string` url is the URL of the metrics collector - `Username string` username is the username to use for the metrics collector - `Region string` 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 RunnerReleaseChannel` The release channel the runner is on - `const RunnerReleaseChannelUnspecified RunnerReleaseChannel = "RUNNER_RELEASE_CHANNEL_UNSPECIFIED"` - `const RunnerReleaseChannelStable RunnerReleaseChannel = "RUNNER_RELEASE_CHANNEL_STABLE"` - `const RunnerReleaseChannelLatest RunnerReleaseChannel = "RUNNER_RELEASE_CHANNEL_LATEST"` - `UpdateWindow UpdateWindow` update_window defines the daily time window (UTC) during which auto-updates are allowed. If not set, updates are allowed at any time. - `EndHour int64` end_hour is the end of the update window as a UTC hour (0-23). If not set, defaults to start_hour + 2. - `StartHour int64` start_hour is the beginning of the update window as a UTC hour (0-23). +required - `DesiredPhase RunnerPhase` RunnerPhase represents the phase a runner is in - `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 RunnerVariant` The runner's variant - `const RunnerVariantUnspecified RunnerVariant = "RUNNER_VARIANT_UNSPECIFIED"` - `const RunnerVariantStandard RunnerVariant = "RUNNER_VARIANT_STANDARD"` - `const RunnerVariantEnterprise RunnerVariant = "RUNNER_VARIANT_ENTERPRISE"` ### Runner Status - `type RunnerStatus struct{…}` RunnerStatus represents the status of a runner - `AdditionalInfo []FieldValue` additional_info contains additional information about the runner, e.g. a CloudFormation stack URL. - `Key string` - `Value string` - `Capabilities []RunnerCapability` capabilities is a list of capabilities the runner supports. - `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 GatewayInfo` gateway_info is information about the gateway to which the runner is connected. - `Gateway Gateway` 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 string` region is the geographical region where the gateway is located - `Latency string` latency is the round-trip time of the runner to the gateway in milliseconds. - `LlmURL string` llm_url is the URL of the LLM service to which the runner is connected. - `LogURL string` - `Message string` The runner's reported message which is shown to users. This message adds more context to the runner's phase. - `Phase RunnerPhase` The runner's reported phase - `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 string` public_key is the runner's public key used for encryption (32 bytes) - `Region string` region is the region the runner is running in, if applicable. - `SupportBundleURL string` 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 string` - `UpdatedAt Time` Time when the status was last updated. - `Version string` ### Runner Variant - `type RunnerVariant string` - `const RunnerVariantUnspecified RunnerVariant = "RUNNER_VARIANT_UNSPECIFIED"` - `const RunnerVariantStandard RunnerVariant = "RUNNER_VARIANT_STANDARD"` - `const RunnerVariantEnterprise RunnerVariant = "RUNNER_VARIANT_ENTERPRISE"` ### Search Mode - `type SearchMode string` - `const SearchModeUnspecified SearchMode = "SEARCH_MODE_UNSPECIFIED"` - `const SearchModeKeyword SearchMode = "SEARCH_MODE_KEYWORD"` - `const SearchModeNative SearchMode = "SEARCH_MODE_NATIVE"` ### Update Window - `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 int64` end_hour is the end of the update window as a UTC hour (0-23). If not set, defaults to start_hour + 2. - `StartHour int64` start_hour is the beginning of the update window as a UTC hour (0-23). +required # Configurations ## ValidateRunnerConfiguration `client.Runners.Configurations.Validate(ctx, body) (*RunnerConfigurationValidateResponse, error)` **post** `/gitpod.v1.RunnerConfigurationService/ValidateRunnerConfiguration` Validates a runner configuration. Use this method to: - Check configuration validity - Verify integration settings - Validate environment classes ### Examples - Validate SCM integration: Checks if an SCM integration is valid. ```yaml runnerId: "d2c94c27-3b76-4a42-b88c-95a85e392c68" scmIntegration: id: "integration-id" scmId: "github" host: "github.com" oauthClientId: "client_id" oauthPlaintextClientSecret: "client_secret" ``` ### Parameters - `body RunnerConfigurationValidateParams` - `EnvironmentClass param.Field[EnvironmentClass]` - `RunnerID param.Field[string]` - `ScmIntegration param.Field[RunnerConfigurationValidateParamsScmIntegration]` - `ID string` id is the unique identifier of the SCM integration - `Host string` - `IssuerURL string` issuer_url can be set to override the authentication provider URL, if it doesn't match the SCM host. - `OAuthClientID string` oauth_client_id is the OAuth app's client ID, if OAuth is configured. If configured, oauth_client_secret must also be set. - `OAuthEncryptedClientSecret string` oauth_encrypted_client_secret is the OAuth app's client secret encrypted with the runner's public key, if OAuth is configured. This can be used to e.g. validate an already encrypted client secret of an existing SCM integration. - `OAuthPlaintextClientSecret string` oauth_plaintext_client_secret is the OAuth app's client secret in clear text, if OAuth is configured. This can be set to validate any new client secret before it is encrypted and stored. This value will not be stored and get encrypted with the runner's public key before passing it to the runner. - `Pat bool` - `ScmID string` scm_id references the scm_id in the runner's configuration schema that this integration is for - `VirtualDirectory string` 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'. ### Returns - `type RunnerConfigurationValidateResponse struct{…}` - `EnvironmentClass EnvironmentClassValidationResult` - `ConfigurationErrors []FieldValidationError` - `Error string` - `Key string` - `DescriptionError string` - `DisplayNameError string` - `Valid bool` - `ScmIntegration ScmIntegrationValidationResult` - `HostError string` - `OAuthError string` - `PatError string` - `ScmIDError string` - `Valid bool` ### Example ```go 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"), ) response, err := client.Runners.Configurations.Validate(context.TODO(), gitpod.RunnerConfigurationValidateParams{ RunnerID: gitpod.F("d2c94c27-3b76-4a42-b88c-95a85e392c68"), ScmIntegration: gitpod.F(gitpod.RunnerConfigurationValidateParamsScmIntegration{ Host: gitpod.F("github.com"), ID: gitpod.F("integration-id"), OAuthClientID: gitpod.F("client_id"), OAuthPlaintextClientSecret: gitpod.F("client_secret"), ScmID: gitpod.F("github"), }), }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", response.EnvironmentClass) } ``` #### Response ```json { "environmentClass": { "configurationErrors": [ { "error": "error", "key": "key" } ], "descriptionError": "descriptionError", "displayNameError": "displayNameError", "valid": true }, "scmIntegration": { "hostError": "hostError", "oauthError": "oauthError", "patError": "patError", "scmIdError": "scmIdError", "valid": true } } ``` ## Domain Types ### Environment Class Validation Result - `type EnvironmentClassValidationResult struct{…}` - `ConfigurationErrors []FieldValidationError` - `Error string` - `Key string` - `DescriptionError string` - `DisplayNameError string` - `Valid bool` ### Field Validation Error - `type FieldValidationError struct{…}` - `Error string` - `Key string` ### Scm Integration Validation Result - `type ScmIntegrationValidationResult struct{…}` - `HostError string` - `OAuthError string` - `PatError string` - `ScmIDError string` - `Valid bool` # Environment Classes ## CreateEnvironmentClass `client.Runners.Configurations.EnvironmentClasses.New(ctx, body) (*RunnerConfigurationEnvironmentClassNewResponse, error)` **post** `/gitpod.v1.RunnerConfigurationService/CreateEnvironmentClass` Creates a new environment class for a runner. Use this method to: - Define compute resources - Configure environment settings - Set up runtime options ### Examples - Create environment class: Creates a new environment configuration. ```yaml runnerId: "d2c94c27-3b76-4a42-b88c-95a85e392c68" displayName: "Large Instance" description: "8 CPU, 16GB RAM" configuration: - key: "cpu" value: "8" - key: "memory" value: "16384" ``` ### Parameters - `body RunnerConfigurationEnvironmentClassNewParams` - `Configuration param.Field[[]FieldValue]` - `Key string` - `Value string` - `Description param.Field[string]` - `DisplayName param.Field[string]` - `RunnerID param.Field[string]` ### Returns - `type RunnerConfigurationEnvironmentClassNewResponse struct{…}` - `ID string` ### Example ```go package main import ( "context" "fmt" "github.com/gitpod-io/gitpod-sdk-go" "github.com/gitpod-io/gitpod-sdk-go/option" "github.com/gitpod-io/gitpod-sdk-go/shared" ) func main() { client := gitpod.NewClient( option.WithBearerToken("My Bearer Token"), ) environmentClass, err := client.Runners.Configurations.EnvironmentClasses.New(context.TODO(), gitpod.RunnerConfigurationEnvironmentClassNewParams{ Configuration: gitpod.F([]shared.FieldValueParam{shared.FieldValueParam{ Key: gitpod.F("cpu"), Value: gitpod.F("8"), }, shared.FieldValueParam{ Key: gitpod.F("memory"), Value: gitpod.F("16384"), }}), Description: gitpod.F("8 CPU, 16GB RAM"), DisplayName: gitpod.F("Large Instance"), RunnerID: gitpod.F("d2c94c27-3b76-4a42-b88c-95a85e392c68"), }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", environmentClass.ID) } ``` #### Response ```json { "id": "id" } ``` ## ListEnvironmentClasses `client.Runners.Configurations.EnvironmentClasses.List(ctx, params) (*EnvironmentClassesPage[EnvironmentClass], error)` **post** `/gitpod.v1.RunnerConfigurationService/ListEnvironmentClasses` Lists environment classes with optional filtering. Use this method to: - View available classes - Filter by capability - Check enabled status ### Examples - List all classes: Shows all environment classes. ```yaml pagination: pageSize: 20 ``` - Filter enabled classes: Lists only enabled environment classes. ```yaml filter: enabled: true pagination: pageSize: 20 ``` buf:lint:ignore RPC_REQUEST_RESPONSE_UNIQUE ### Parameters - `params RunnerConfigurationEnvironmentClassListParams` - `Token param.Field[string]` Query param - `PageSize param.Field[int64]` Query param - `Filter param.Field[RunnerConfigurationEnvironmentClassListParamsFilter]` Body param - `CanCreateEnvironments bool` can_create_environments filters the response to only environment classes that can be used to create new environments by the caller. Unlike enabled, which indicates general availability, this ensures the caller only sees environment classes they are allowed to use. - `Enabled bool` enabled filters the response to only enabled or disabled environment classes. If not set, all environment classes are returned. - `RunnerIDs []string` runner_ids filters the response to only EnvironmentClasses of these Runner IDs - `RunnerKinds []RunnerKind` runner_kind filters the response to only environment classes from runners of these kinds. - `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"` - `RunnerProviders []RunnerProvider` runner_providers filters the response to only environment classes from runners of these providers. - `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"` - `Pagination param.Field[RunnerConfigurationEnvironmentClassListParamsPagination]` Body param: pagination contains the pagination options for listing environment classes - `Token string` Token for the next set of results that was returned as next_token of a PaginationResponse - `PageSize int64` Page size is the maximum number of results to retrieve per page. Defaults to 25. Maximum 100. ### Returns - `type EnvironmentClass struct{…}` - `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 []FieldValue` configuration describes the configuration of the environment class - `Key string` - `Value string` - `Description string` description is a human readable description of the environment class - `DisplayName string` display_name is the human readable name of the environment class - `Enabled bool` enabled indicates whether the environment class can be used to create new environments. ### Example ```go 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"), ) page, err := client.Runners.Configurations.EnvironmentClasses.List(context.TODO(), gitpod.RunnerConfigurationEnvironmentClassListParams{ Filter: gitpod.F(gitpod.RunnerConfigurationEnvironmentClassListParamsFilter{ Enabled: gitpod.F(true), }), Pagination: gitpod.F(gitpod.RunnerConfigurationEnvironmentClassListParamsPagination{ PageSize: gitpod.F(int64(20)), }), }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", page) } ``` #### Response ```json { "environmentClasses": [ { "id": "id", "runnerId": "runnerId", "configuration": [ { "key": "key", "value": "value" } ], "description": "xxx", "displayName": "xxx", "enabled": true } ], "pagination": { "nextToken": "nextToken" } } ``` ## GetEnvironmentClass `client.Runners.Configurations.EnvironmentClasses.Get(ctx, body) (*RunnerConfigurationEnvironmentClassGetResponse, error)` **post** `/gitpod.v1.RunnerConfigurationService/GetEnvironmentClass` Gets details about a specific environment class. Use this method to: - View class configuration - Check resource settings - Verify availability ### Examples - Get class details: Retrieves information about a specific class. ```yaml environmentClassId: "d2c94c27-3b76-4a42-b88c-95a85e392c68" ``` ### Parameters - `body RunnerConfigurationEnvironmentClassGetParams` - `EnvironmentClassID param.Field[string]` ### Returns - `type RunnerConfigurationEnvironmentClassGetResponse struct{…}` - `EnvironmentClass EnvironmentClass` - `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 []FieldValue` configuration describes the configuration of the environment class - `Key string` - `Value string` - `Description string` description is a human readable description of the environment class - `DisplayName string` display_name is the human readable name of the environment class - `Enabled bool` enabled indicates whether the environment class can be used to create new environments. ### Example ```go 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"), ) environmentClass, err := client.Runners.Configurations.EnvironmentClasses.Get(context.TODO(), gitpod.RunnerConfigurationEnvironmentClassGetParams{ EnvironmentClassID: gitpod.F("d2c94c27-3b76-4a42-b88c-95a85e392c68"), }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", environmentClass.EnvironmentClass) } ``` #### Response ```json { "environmentClass": { "id": "id", "runnerId": "runnerId", "configuration": [ { "key": "key", "value": "value" } ], "description": "xxx", "displayName": "xxx", "enabled": true } } ``` ## UpdateEnvironmentClass `client.Runners.Configurations.EnvironmentClasses.Update(ctx, body) (*RunnerConfigurationEnvironmentClassUpdateResponse, error)` **post** `/gitpod.v1.RunnerConfigurationService/UpdateEnvironmentClass` Updates an environment class. Use this method to: - Modify class settings - Update resource limits - Change availability ### Examples - Update class: Changes class configuration. ```yaml environmentClassId: "d2c94c27-3b76-4a42-b88c-95a85e392c68" displayName: "Updated Large Instance" description: "16 CPU, 32GB RAM" enabled: true ``` ### Parameters - `body RunnerConfigurationEnvironmentClassUpdateParams` - `Description param.Field[string]` - `DisplayName param.Field[string]` - `Enabled param.Field[bool]` - `EnvironmentClassID param.Field[string]` ### Returns - `type RunnerConfigurationEnvironmentClassUpdateResponse interface{…}` ### Example ```go 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"), ) environmentClass, err := client.Runners.Configurations.EnvironmentClasses.Update(context.TODO(), gitpod.RunnerConfigurationEnvironmentClassUpdateParams{ Description: gitpod.F("16 CPU, 32GB RAM"), DisplayName: gitpod.F("Updated Large Instance"), Enabled: gitpod.F(true), EnvironmentClassID: gitpod.F("d2c94c27-3b76-4a42-b88c-95a85e392c68"), }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", environmentClass) } ``` #### Response ```json {} ``` # Host Authentication Tokens ## CreateHostAuthenticationToken `client.Runners.Configurations.HostAuthenticationTokens.New(ctx, body) (*RunnerConfigurationHostAuthenticationTokenNewResponse, error)` **post** `/gitpod.v1.RunnerConfigurationService/CreateHostAuthenticationToken` Creates a new authentication token for accessing remote hosts. Use this method to: - Set up SCM authentication - Configure OAuth credentials - Manage PAT tokens ### Examples - Create OAuth token: Creates a new OAuth-based authentication token. ```yaml runnerId: "d2c94c27-3b76-4a42-b88c-95a85e392c68" userId: "f53d2330-3795-4c5d-a1f3-453121af9c60" host: "github.com" token: "gho_xxxxxxxxxxxx" source: HOST_AUTHENTICATION_TOKEN_SOURCE_OAUTH expiresAt: "2024-12-31T23:59:59Z" refreshToken: "ghr_xxxxxxxxxxxx" ``` ### Parameters - `body RunnerConfigurationHostAuthenticationTokenNewParams` - `Token param.Field[string]` stored encrypted, retrieved via GetHostAuthenticationTokenValue - `ExpiresAt param.Field[Time]` 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](https://developers.google.com/time/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](https://www.ietf.org/rfc/rfc3339.txt) 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](https://www.ietf.org/rfc/rfc3339.txt) 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()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString) method. In Python, a standard `datetime.datetime` object can be converted to this format using [`strftime`](https://docs.python.org/2/library/time.html#time.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()`](http://joda-time.sourceforge.net/apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime\(\)) to obtain a formatter capable of generating timestamps in this format. - `Host param.Field[string]` - `IntegrationID param.Field[string]` - `RefreshToken param.Field[string]` stored encrypted, retrieved via GetHostAuthenticationTokenValue - `RunnerID param.Field[string]` - `Scopes param.Field[[]string]` Maximum 100 scopes allowed (101 for validation purposes) - `Source param.Field[HostAuthenticationTokenSource]` - `Subject param.Field[Subject]` Subject identifies the principal (user or service account) for the token - `UserID param.Field[string]` Deprecated: Use principal_id and principal_type instead ### Returns - `type RunnerConfigurationHostAuthenticationTokenNewResponse struct{…}` - `Token HostAuthenticationToken` - `ID string` - `ExpiresAt Time` 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](https://developers.google.com/time/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](https://www.ietf.org/rfc/rfc3339.txt) 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](https://www.ietf.org/rfc/rfc3339.txt) 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()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString) method. In Python, a standard `datetime.datetime` object can be converted to this format using [`strftime`](https://docs.python.org/2/library/time.html#time.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()`](http://joda-time.sourceforge.net/apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime\(\)) to obtain a formatter capable of generating timestamps in this format. - `Host string` - `IntegrationID string` links to integration instance - `RunnerID string` - `Scopes []string` token permissions - `Source HostAuthenticationTokenSource` auth_type - `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 Subject` 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 - `Principal Principal` Principal is the principal of the subject - `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"` - `UserID string` Deprecated: Use principal_id and principal_type instead principal (user) ### Example ```go package main import ( "context" "fmt" "time" "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"), ) hostAuthenticationToken, err := client.Runners.Configurations.HostAuthenticationTokens.New(context.TODO(), gitpod.RunnerConfigurationHostAuthenticationTokenNewParams{ Token: gitpod.F("gho_xxxxxxxxxxxx"), ExpiresAt: gitpod.F(time.Now()), Host: gitpod.F("github.com"), RefreshToken: gitpod.F("ghr_xxxxxxxxxxxx"), RunnerID: gitpod.F("d2c94c27-3b76-4a42-b88c-95a85e392c68"), Source: gitpod.F(gitpod.HostAuthenticationTokenSourceOAuth), UserID: gitpod.F("f53d2330-3795-4c5d-a1f3-453121af9c60"), }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", hostAuthenticationToken.Token) } ``` #### Response ```json { "token": { "id": "id", "expiresAt": "2019-12-27T18:11:19.117Z", "host": "host", "integrationId": "integrationId", "runnerId": "runnerId", "scopes": [ "string" ], "source": "HOST_AUTHENTICATION_TOKEN_SOURCE_UNSPECIFIED", "subject": { "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "principal": "PRINCIPAL_UNSPECIFIED" }, "userId": "userId" } } ``` ## DeleteHostAuthenticationToken `client.Runners.Configurations.HostAuthenticationTokens.Delete(ctx, body) (*RunnerConfigurationHostAuthenticationTokenDeleteResponse, error)` **post** `/gitpod.v1.RunnerConfigurationService/DeleteHostAuthenticationToken` Deletes a host authentication token. Use this method to: - Remove unused tokens - Revoke access - Clean up expired tokens ### Examples - Delete token: Permanently removes a token. ```yaml id: "d2c94c27-3b76-4a42-b88c-95a85e392c68" ``` ### Parameters - `body RunnerConfigurationHostAuthenticationTokenDeleteParams` - `ID param.Field[string]` ### Returns - `type RunnerConfigurationHostAuthenticationTokenDeleteResponse interface{…}` ### Example ```go 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"), ) hostAuthenticationToken, err := client.Runners.Configurations.HostAuthenticationTokens.Delete(context.TODO(), gitpod.RunnerConfigurationHostAuthenticationTokenDeleteParams{ ID: gitpod.F("d2c94c27-3b76-4a42-b88c-95a85e392c68"), }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", hostAuthenticationToken) } ``` #### Response ```json {} ``` ## ListHostAuthenticationTokens `client.Runners.Configurations.HostAuthenticationTokens.List(ctx, params) (*TokensPage[HostAuthenticationToken], error)` **post** `/gitpod.v1.RunnerConfigurationService/ListHostAuthenticationTokens` Lists host authentication tokens with optional filtering. Use this method to: - View all tokens - Filter by runner or user - Monitor token status ### Examples - List all tokens: Shows all tokens with pagination. ```yaml pagination: pageSize: 20 ``` - Filter by runner: Lists tokens for a specific runner. ```yaml filter: runnerId: "d2c94c27-3b76-4a42-b88c-95a85e392c68" pagination: pageSize: 20 ``` ### Parameters - `params RunnerConfigurationHostAuthenticationTokenListParams` - `Token param.Field[string]` Query param - `PageSize param.Field[int64]` Query param - `Filter param.Field[RunnerConfigurationHostAuthenticationTokenListParamsFilter]` Body param - `RunnerID string` - `SubjectID string` Filter by subject (user or service account) - `UserID string` Deprecated: Use principal_id instead - `Pagination param.Field[RunnerConfigurationHostAuthenticationTokenListParamsPagination]` Body param - `Token string` Token for the next set of results that was returned as next_token of a PaginationResponse - `PageSize int64` Page size is the maximum number of results to retrieve per page. Defaults to 25. Maximum 100. ### Returns - `type HostAuthenticationToken struct{…}` - `ID string` - `ExpiresAt Time` 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](https://developers.google.com/time/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](https://www.ietf.org/rfc/rfc3339.txt) 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](https://www.ietf.org/rfc/rfc3339.txt) 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()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString) method. In Python, a standard `datetime.datetime` object can be converted to this format using [`strftime`](https://docs.python.org/2/library/time.html#time.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()`](http://joda-time.sourceforge.net/apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime\(\)) to obtain a formatter capable of generating timestamps in this format. - `Host string` - `IntegrationID string` links to integration instance - `RunnerID string` - `Scopes []string` token permissions - `Source HostAuthenticationTokenSource` auth_type - `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 Subject` 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 - `Principal Principal` Principal is the principal of the subject - `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"` - `UserID string` Deprecated: Use principal_id and principal_type instead principal (user) ### Example ```go 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"), ) page, err := client.Runners.Configurations.HostAuthenticationTokens.List(context.TODO(), gitpod.RunnerConfigurationHostAuthenticationTokenListParams{ Filter: gitpod.F(gitpod.RunnerConfigurationHostAuthenticationTokenListParamsFilter{ RunnerID: gitpod.F("d2c94c27-3b76-4a42-b88c-95a85e392c68"), }), Pagination: gitpod.F(gitpod.RunnerConfigurationHostAuthenticationTokenListParamsPagination{ PageSize: gitpod.F(int64(20)), }), }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", page) } ``` #### Response ```json { "pagination": { "nextToken": "nextToken" }, "tokens": [ { "id": "id", "expiresAt": "2019-12-27T18:11:19.117Z", "host": "host", "integrationId": "integrationId", "runnerId": "runnerId", "scopes": [ "string" ], "source": "HOST_AUTHENTICATION_TOKEN_SOURCE_UNSPECIFIED", "subject": { "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "principal": "PRINCIPAL_UNSPECIFIED" }, "userId": "userId" } ] } ``` ## GetHostAuthenticationToken `client.Runners.Configurations.HostAuthenticationTokens.Get(ctx, body) (*RunnerConfigurationHostAuthenticationTokenGetResponse, error)` **post** `/gitpod.v1.RunnerConfigurationService/GetHostAuthenticationToken` Gets details about a specific host authentication token. Use this method to: - View token information - Check token expiration - Verify token validity ### Examples - Get token details: Retrieves information about a specific token. ```yaml id: "d2c94c27-3b76-4a42-b88c-95a85e392c68" ``` ### Parameters - `body RunnerConfigurationHostAuthenticationTokenGetParams` - `ID param.Field[string]` ### Returns - `type RunnerConfigurationHostAuthenticationTokenGetResponse struct{…}` - `Token HostAuthenticationToken` - `ID string` - `ExpiresAt Time` 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](https://developers.google.com/time/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](https://www.ietf.org/rfc/rfc3339.txt) 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](https://www.ietf.org/rfc/rfc3339.txt) 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()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString) method. In Python, a standard `datetime.datetime` object can be converted to this format using [`strftime`](https://docs.python.org/2/library/time.html#time.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()`](http://joda-time.sourceforge.net/apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime\(\)) to obtain a formatter capable of generating timestamps in this format. - `Host string` - `IntegrationID string` links to integration instance - `RunnerID string` - `Scopes []string` token permissions - `Source HostAuthenticationTokenSource` auth_type - `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 Subject` 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 - `Principal Principal` Principal is the principal of the subject - `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"` - `UserID string` Deprecated: Use principal_id and principal_type instead principal (user) ### Example ```go 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"), ) hostAuthenticationToken, err := client.Runners.Configurations.HostAuthenticationTokens.Get(context.TODO(), gitpod.RunnerConfigurationHostAuthenticationTokenGetParams{ ID: gitpod.F("d2c94c27-3b76-4a42-b88c-95a85e392c68"), }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", hostAuthenticationToken.Token) } ``` #### Response ```json { "token": { "id": "id", "expiresAt": "2019-12-27T18:11:19.117Z", "host": "host", "integrationId": "integrationId", "runnerId": "runnerId", "scopes": [ "string" ], "source": "HOST_AUTHENTICATION_TOKEN_SOURCE_UNSPECIFIED", "subject": { "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "principal": "PRINCIPAL_UNSPECIFIED" }, "userId": "userId" } } ``` ## UpdateHostAuthenticationToken `client.Runners.Configurations.HostAuthenticationTokens.Update(ctx, body) (*RunnerConfigurationHostAuthenticationTokenUpdateResponse, error)` **post** `/gitpod.v1.RunnerConfigurationService/UpdateHostAuthenticationToken` Updates an existing host authentication token. Use this method to: - Refresh token values - Update expiration - Modify token settings ### Examples - Update token: Updates token value and expiration. ```yaml id: "d2c94c27-3b76-4a42-b88c-95a85e392c68" token: "gho_xxxxxxxxxxxx" expiresAt: "2024-12-31T23:59:59Z" refreshToken: "ghr_xxxxxxxxxxxx" ``` ### Parameters - `body RunnerConfigurationHostAuthenticationTokenUpdateParams` - `ID param.Field[string]` - `Token param.Field[string]` - `ExpiresAt param.Field[Time]` 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](https://developers.google.com/time/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](https://www.ietf.org/rfc/rfc3339.txt) 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](https://www.ietf.org/rfc/rfc3339.txt) 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()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString) method. In Python, a standard `datetime.datetime` object can be converted to this format using [`strftime`](https://docs.python.org/2/library/time.html#time.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()`](http://joda-time.sourceforge.net/apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime\(\)) to obtain a formatter capable of generating timestamps in this format. - `RefreshToken param.Field[string]` - `Scopes param.Field[[]string]` ### Returns - `type RunnerConfigurationHostAuthenticationTokenUpdateResponse interface{…}` ### Example ```go package main import ( "context" "fmt" "time" "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"), ) hostAuthenticationToken, err := client.Runners.Configurations.HostAuthenticationTokens.Update(context.TODO(), gitpod.RunnerConfigurationHostAuthenticationTokenUpdateParams{ ID: gitpod.F("d2c94c27-3b76-4a42-b88c-95a85e392c68"), Token: gitpod.F("gho_xxxxxxxxxxxx"), ExpiresAt: gitpod.F(time.Now()), RefreshToken: gitpod.F("ghr_xxxxxxxxxxxx"), }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", hostAuthenticationToken) } ``` #### Response ```json {} ``` ## Domain Types ### Host Authentication Token - `type HostAuthenticationToken struct{…}` - `ID string` - `ExpiresAt Time` 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](https://developers.google.com/time/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](https://www.ietf.org/rfc/rfc3339.txt) 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](https://www.ietf.org/rfc/rfc3339.txt) 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()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString) method. In Python, a standard `datetime.datetime` object can be converted to this format using [`strftime`](https://docs.python.org/2/library/time.html#time.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()`](http://joda-time.sourceforge.net/apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime\(\)) to obtain a formatter capable of generating timestamps in this format. - `Host string` - `IntegrationID string` links to integration instance - `RunnerID string` - `Scopes []string` token permissions - `Source HostAuthenticationTokenSource` auth_type - `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 Subject` 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 - `Principal Principal` Principal is the principal of the subject - `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"` - `UserID string` Deprecated: Use principal_id and principal_type instead principal (user) ### Host Authentication Token Source - `type HostAuthenticationTokenSource string` - `const HostAuthenticationTokenSourceUnspecified HostAuthenticationTokenSource = "HOST_AUTHENTICATION_TOKEN_SOURCE_UNSPECIFIED"` - `const HostAuthenticationTokenSourceOAuth HostAuthenticationTokenSource = "HOST_AUTHENTICATION_TOKEN_SOURCE_OAUTH"` - `const HostAuthenticationTokenSourcePat HostAuthenticationTokenSource = "HOST_AUTHENTICATION_TOKEN_SOURCE_PAT"` # 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. ```yaml runnerId: "d2c94c27-3b76-4a42-b88c-95a85e392c68" ``` ### Parameters - `body RunnerConfigurationSchemaGetParams` - `RunnerID param.Field[string]` ### Returns - `type RunnerConfigurationSchemaGetResponse struct{…}` - `Schema RunnerConfigurationSchema` - `EnvironmentClasses []RunnerConfigurationSchemaEnvironmentClass` - `ID string` - `Bool RunnerConfigurationSchemaEnvironmentClassesBool` - `Default bool` - `Description string` - `Display RunnerConfigurationSchemaEnvironmentClassesDisplay` - `Default string` - `Enum RunnerConfigurationSchemaEnvironmentClassesEnum` - `Default string` deprecated, will be removed, use default_value instead - `DefaultValue RunnerConfigurationSchemaEnvironmentClassesEnumDefaultValue` - `Detail string` - `Subtitle string` - `Title string` - `PossibleValues []RunnerConfigurationSchemaEnvironmentClassesEnumPossibleValue` - `Detail string` - `Subtitle string` - `Title string` - `Values []string` deprecated, will be removed, use possible_values instead - `Int RunnerConfigurationSchemaEnvironmentClassesInt` - `Default int64` - `Max int64` - `Min int64` - `Name string` - `Required bool` - `Secret bool` - `String RunnerConfigurationSchemaEnvironmentClassesString` - `Default string` - `Pattern string` - `RunnerConfig []RunnerConfigurationSchemaRunnerConfig` - `ID string` - `Bool RunnerConfigurationSchemaRunnerConfigBool` - `Default bool` - `Description string` - `Display RunnerConfigurationSchemaRunnerConfigDisplay` - `Default string` - `Enum RunnerConfigurationSchemaRunnerConfigEnum` - `Default string` deprecated, will be removed, use default_value instead - `DefaultValue RunnerConfigurationSchemaRunnerConfigEnumDefaultValue` - `Detail string` - `Subtitle string` - `Title string` - `PossibleValues []RunnerConfigurationSchemaRunnerConfigEnumPossibleValue` - `Detail string` - `Subtitle string` - `Title string` - `Values []string` deprecated, will be removed, use possible_values instead - `Int RunnerConfigurationSchemaRunnerConfigInt` - `Default int64` - `Max int64` - `Min int64` - `Name string` - `Required bool` - `Secret bool` - `String RunnerConfigurationSchemaRunnerConfigString` - `Default string` - `Pattern string` - `Scm []RunnerConfigurationSchemaScm` - `DefaultHosts []string` - `Name string` - `OAuth RunnerConfigurationSchemaScmOAuth` - `CallbackURL string` callback_url is the URL the OAuth app will redirect to after the user has authenticated. - `Pat RunnerConfigurationSchemaScmPat` - `Description string` description is a human-readable description of the PAT. - `DocsLink string` docs_link is a link to the documentation on how to create a PAT for this SCM system. - `ScmID string` - `Version string` The schema version ### Example ```go 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) } ``` #### Response ```json { "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" } } ``` ## Domain Types ### Runner Configuration Schema - `type RunnerConfigurationSchema struct{…}` - `EnvironmentClasses []RunnerConfigurationSchemaEnvironmentClass` - `ID string` - `Bool RunnerConfigurationSchemaEnvironmentClassesBool` - `Default bool` - `Description string` - `Display RunnerConfigurationSchemaEnvironmentClassesDisplay` - `Default string` - `Enum RunnerConfigurationSchemaEnvironmentClassesEnum` - `Default string` deprecated, will be removed, use default_value instead - `DefaultValue RunnerConfigurationSchemaEnvironmentClassesEnumDefaultValue` - `Detail string` - `Subtitle string` - `Title string` - `PossibleValues []RunnerConfigurationSchemaEnvironmentClassesEnumPossibleValue` - `Detail string` - `Subtitle string` - `Title string` - `Values []string` deprecated, will be removed, use possible_values instead - `Int RunnerConfigurationSchemaEnvironmentClassesInt` - `Default int64` - `Max int64` - `Min int64` - `Name string` - `Required bool` - `Secret bool` - `String RunnerConfigurationSchemaEnvironmentClassesString` - `Default string` - `Pattern string` - `RunnerConfig []RunnerConfigurationSchemaRunnerConfig` - `ID string` - `Bool RunnerConfigurationSchemaRunnerConfigBool` - `Default bool` - `Description string` - `Display RunnerConfigurationSchemaRunnerConfigDisplay` - `Default string` - `Enum RunnerConfigurationSchemaRunnerConfigEnum` - `Default string` deprecated, will be removed, use default_value instead - `DefaultValue RunnerConfigurationSchemaRunnerConfigEnumDefaultValue` - `Detail string` - `Subtitle string` - `Title string` - `PossibleValues []RunnerConfigurationSchemaRunnerConfigEnumPossibleValue` - `Detail string` - `Subtitle string` - `Title string` - `Values []string` deprecated, will be removed, use possible_values instead - `Int RunnerConfigurationSchemaRunnerConfigInt` - `Default int64` - `Max int64` - `Min int64` - `Name string` - `Required bool` - `Secret bool` - `String RunnerConfigurationSchemaRunnerConfigString` - `Default string` - `Pattern string` - `Scm []RunnerConfigurationSchemaScm` - `DefaultHosts []string` - `Name string` - `OAuth RunnerConfigurationSchemaScmOAuth` - `CallbackURL string` callback_url is the URL the OAuth app will redirect to after the user has authenticated. - `Pat RunnerConfigurationSchemaScmPat` - `Description string` description is a human-readable description of the PAT. - `DocsLink string` docs_link is a link to the documentation on how to create a PAT for this SCM system. - `ScmID string` - `Version string` The schema version # Scm Integrations ## CreateSCMIntegration `client.Runners.Configurations.ScmIntegrations.New(ctx, body) (*RunnerConfigurationScmIntegrationNewResponse, error)` **post** `/gitpod.v1.RunnerConfigurationService/CreateSCMIntegration` Creates a new SCM integration for a runner. Use this method to: - Configure source control access - Set up repository integrations - Enable code synchronization ### Examples - Create GitHub integration: Sets up GitHub SCM integration. ```yaml runnerId: "d2c94c27-3b76-4a42-b88c-95a85e392c68" scmId: "github" host: "github.com" oauthClientId: "client_id" oauthPlaintextClientSecret: "client_secret" ``` ### Parameters - `body RunnerConfigurationScmIntegrationNewParams` - `Host param.Field[string]` - `IssuerURL param.Field[string]` issuer_url can be set to override the authentication provider URL, if it doesn't match the SCM host. - `OAuthClientID param.Field[string]` oauth_client_id is the OAuth app's client ID, if OAuth is configured. If configured, oauth_plaintext_client_secret must also be set. - `OAuthPlaintextClientSecret param.Field[string]` oauth_plaintext_client_secret is the OAuth app's client secret in clear text. This will first be encrypted with the runner's public key before being stored. - `Pat param.Field[bool]` - `RunnerID param.Field[string]` - `ScmID param.Field[string]` scm_id references the scm_id in the runner's configuration schema that this integration is for - `VirtualDirectory param.Field[string]` 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'. ### Returns - `type RunnerConfigurationScmIntegrationNewResponse struct{…}` - `ID string` id is a uniquely generated identifier for the SCM integration ### Example ```go 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"), ) scmIntegration, err := client.Runners.Configurations.ScmIntegrations.New(context.TODO(), gitpod.RunnerConfigurationScmIntegrationNewParams{ Host: gitpod.F("github.com"), OAuthClientID: gitpod.F("client_id"), OAuthPlaintextClientSecret: gitpod.F("client_secret"), RunnerID: gitpod.F("d2c94c27-3b76-4a42-b88c-95a85e392c68"), ScmID: gitpod.F("github"), }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", scmIntegration.ID) } ``` #### Response ```json { "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e" } ``` ## DeleteSCMIntegration `client.Runners.Configurations.ScmIntegrations.Delete(ctx, body) (*RunnerConfigurationScmIntegrationDeleteResponse, error)` **post** `/gitpod.v1.RunnerConfigurationService/DeleteSCMIntegration` Deletes an SCM integration. Use this method to: - Remove unused integrations - Clean up configurations - Revoke SCM access ### Examples - Delete integration: Removes an SCM integration. ```yaml id: "d2c94c27-3b76-4a42-b88c-95a85e392c68" ``` ### Parameters - `body RunnerConfigurationScmIntegrationDeleteParams` - `ID param.Field[string]` ### Returns - `type RunnerConfigurationScmIntegrationDeleteResponse interface{…}` ### Example ```go 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"), ) scmIntegration, err := client.Runners.Configurations.ScmIntegrations.Delete(context.TODO(), gitpod.RunnerConfigurationScmIntegrationDeleteParams{ ID: gitpod.F("d2c94c27-3b76-4a42-b88c-95a85e392c68"), }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", scmIntegration) } ``` #### Response ```json {} ``` ## ListSCMIntegrations `client.Runners.Configurations.ScmIntegrations.List(ctx, params) (*IntegrationsPage[ScmIntegration], error)` **post** `/gitpod.v1.RunnerConfigurationService/ListSCMIntegrations` Lists SCM integrations for a runner. Use this method to: - View all integrations - Monitor integration status - Check available SCMs ### Examples - List integrations: Shows all SCM integrations. ```yaml filter: runnerIds: ["d2c94c27-3b76-4a42-b88c-95a85e392c68"] pagination: pageSize: 20 ``` ### Parameters - `params RunnerConfigurationScmIntegrationListParams` - `Token param.Field[string]` Query param - `PageSize param.Field[int64]` Query param - `Filter param.Field[RunnerConfigurationScmIntegrationListParamsFilter]` Body param - `RunnerIDs []string` runner_ids filters the response to only SCM integrations of these Runner IDs - `Pagination param.Field[RunnerConfigurationScmIntegrationListParamsPagination]` Body param: pagination contains the pagination options for listing scm integrations - `Token string` Token for the next set of results that was returned as next_token of a PaginationResponse - `PageSize int64` Page size is the maximum number of results to retrieve per page. Defaults to 25. Maximum 100. ### Returns - `type ScmIntegration struct{…}` - `ID string` id is the unique identifier of the SCM integration - `Host string` - `OAuth ScmIntegrationOAuthConfig` - `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. - `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 bool` - `RunnerID string` - `ScmID string` scm_id references the scm_id in the runner's configuration schema that this integration is for - `VirtualDirectory string` 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'. ### Example ```go 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"), ) page, err := client.Runners.Configurations.ScmIntegrations.List(context.TODO(), gitpod.RunnerConfigurationScmIntegrationListParams{ Filter: gitpod.F(gitpod.RunnerConfigurationScmIntegrationListParamsFilter{ RunnerIDs: gitpod.F([]string{"d2c94c27-3b76-4a42-b88c-95a85e392c68"}), }), Pagination: gitpod.F(gitpod.RunnerConfigurationScmIntegrationListParamsPagination{ PageSize: gitpod.F(int64(20)), }), }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", page) } ``` #### Response ```json { "integrations": [ { "id": "id", "host": "host", "oauth": { "clientId": "clientId", "encryptedClientSecret": "U3RhaW5sZXNzIHJvY2tz", "issuerUrl": "issuerUrl" }, "pat": true, "runnerId": "runnerId", "scmId": "scmId", "virtualDirectory": "virtualDirectory" } ], "pagination": { "nextToken": "nextToken" } } ``` ## GetSCMIntegration `client.Runners.Configurations.ScmIntegrations.Get(ctx, body) (*RunnerConfigurationScmIntegrationGetResponse, error)` **post** `/gitpod.v1.RunnerConfigurationService/GetSCMIntegration` Gets details about a specific SCM integration. Use this method to: - View integration settings - Check integration status - Verify configuration ### Examples - Get integration details: Retrieves information about a specific integration. ```yaml id: "d2c94c27-3b76-4a42-b88c-95a85e392c68" ``` ### Parameters - `body RunnerConfigurationScmIntegrationGetParams` - `ID param.Field[string]` ### Returns - `type RunnerConfigurationScmIntegrationGetResponse struct{…}` - `Integration ScmIntegration` - `ID string` id is the unique identifier of the SCM integration - `Host string` - `OAuth ScmIntegrationOAuthConfig` - `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. - `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 bool` - `RunnerID string` - `ScmID string` scm_id references the scm_id in the runner's configuration schema that this integration is for - `VirtualDirectory string` 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'. ### Example ```go 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"), ) scmIntegration, err := client.Runners.Configurations.ScmIntegrations.Get(context.TODO(), gitpod.RunnerConfigurationScmIntegrationGetParams{ ID: gitpod.F("d2c94c27-3b76-4a42-b88c-95a85e392c68"), }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", scmIntegration.Integration) } ``` #### Response ```json { "integration": { "id": "id", "host": "host", "oauth": { "clientId": "clientId", "encryptedClientSecret": "U3RhaW5sZXNzIHJvY2tz", "issuerUrl": "issuerUrl" }, "pat": true, "runnerId": "runnerId", "scmId": "scmId", "virtualDirectory": "virtualDirectory" } } ``` ## UpdateSCMIntegration `client.Runners.Configurations.ScmIntegrations.Update(ctx, body) (*RunnerConfigurationScmIntegrationUpdateResponse, error)` **post** `/gitpod.v1.RunnerConfigurationService/UpdateSCMIntegration` Updates an existing SCM integration. Use this method to: - Modify integration settings - Update credentials - Change configuration ### Examples - Update integration: Updates OAuth credentials. ```yaml id: "d2c94c27-3b76-4a42-b88c-95a85e392c68" oauthClientId: "new_client_id" oauthPlaintextClientSecret: "new_client_secret" ``` ### Parameters - `body RunnerConfigurationScmIntegrationUpdateParams` - `ID param.Field[string]` - `IssuerURL param.Field[string]` issuer_url can be set to override the authentication provider URL, if it doesn't match the SCM host. - `OAuthClientID param.Field[string]` oauth_client_id can be set to update the OAuth app's client ID. If an empty string is set, the OAuth configuration will be removed (regardless of whether a client secret is set), and any existing Host Authentication Tokens for the SCM integration's runner and host that were created using the OAuth app will be deleted. This might lead to users being unable to access their repositories until they re-authenticate. - `OAuthPlaintextClientSecret param.Field[string]` oauth_plaintext_client_secret can be set to update the OAuth app's client secret. The cleartext secret will be encrypted with the runner's public key before being stored. - `Pat param.Field[bool]` pat can be set to enable or disable Personal Access Tokens support. When disabling PATs, any existing Host Authentication Tokens for the SCM integration's runner and host that were created using a PAT will be deleted. This might lead to users being unable to access their repositories until they re-authenticate. - `VirtualDirectory param.Field[string]` 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'. ### Returns - `type RunnerConfigurationScmIntegrationUpdateResponse interface{…}` ### Example ```go 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"), ) scmIntegration, err := client.Runners.Configurations.ScmIntegrations.Update(context.TODO(), gitpod.RunnerConfigurationScmIntegrationUpdateParams{ ID: gitpod.F("d2c94c27-3b76-4a42-b88c-95a85e392c68"), OAuthClientID: gitpod.F("new_client_id"), OAuthPlaintextClientSecret: gitpod.F("new_client_secret"), }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", scmIntegration) } ``` #### Response ```json {} ``` ## Domain Types ### Scm Integration - `type ScmIntegration struct{…}` - `ID string` id is the unique identifier of the SCM integration - `Host string` - `OAuth ScmIntegrationOAuthConfig` - `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. - `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 bool` - `RunnerID string` - `ScmID string` scm_id references the scm_id in the runner's configuration schema that this integration is for - `VirtualDirectory string` 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'. ### Scm Integration OAuth Config - `type ScmIntegrationOAuthConfig struct{…}` - `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. - `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. # Policies ## CreateRunnerPolicy `client.Runners.Policies.New(ctx, body) (*RunnerPolicyNewResponse, error)` **post** `/gitpod.v1.RunnerService/CreateRunnerPolicy` Creates a new policy for a runner. Use this method to: - Set up access controls - Define group permissions - Configure role-based access ### Examples - Create admin policy: Grants admin access to a group. ```yaml runnerId: "d2c94c27-3b76-4a42-b88c-95a85e392c68" groupId: "f53d2330-3795-4c5d-a1f3-453121af9c60" role: RUNNER_ROLE_ADMIN ``` ### Parameters - `body RunnerPolicyNewParams` - `GroupID param.Field[string]` group_id specifies the group_id identifier - `Role param.Field[RunnerRole]` - `RunnerID param.Field[string]` runner_id specifies the project identifier ### Returns - `type RunnerPolicyNewResponse struct{…}` - `Policy RunnerPolicy` - `GroupID string` - `Role RunnerRole` role is the role assigned to the group - `const RunnerRoleUnspecified RunnerRole = "RUNNER_ROLE_UNSPECIFIED"` - `const RunnerRoleAdmin RunnerRole = "RUNNER_ROLE_ADMIN"` - `const RunnerRoleUser RunnerRole = "RUNNER_ROLE_USER"` ### Example ```go 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"), ) policy, err := client.Runners.Policies.New(context.TODO(), gitpod.RunnerPolicyNewParams{ GroupID: gitpod.F("f53d2330-3795-4c5d-a1f3-453121af9c60"), Role: gitpod.F(gitpod.RunnerRoleAdmin), RunnerID: gitpod.F("d2c94c27-3b76-4a42-b88c-95a85e392c68"), }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", policy.Policy) } ``` #### Response ```json { "policy": { "groupId": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "role": "RUNNER_ROLE_UNSPECIFIED" } } ``` ## DeleteRunnerPolicy `client.Runners.Policies.Delete(ctx, body) (*RunnerPolicyDeleteResponse, error)` **post** `/gitpod.v1.RunnerService/DeleteRunnerPolicy` Deletes a runner policy. Use this method to: - Remove access controls - Revoke permissions - Clean up policies ### Examples - Delete policy: Removes a group's access policy. ```yaml runnerId: "d2c94c27-3b76-4a42-b88c-95a85e392c68" groupId: "f53d2330-3795-4c5d-a1f3-453121af9c60" ``` ### Parameters - `body RunnerPolicyDeleteParams` - `GroupID param.Field[string]` group_id specifies the group_id identifier - `RunnerID param.Field[string]` runner_id specifies the project identifier ### Returns - `type RunnerPolicyDeleteResponse interface{…}` ### Example ```go 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"), ) policy, err := client.Runners.Policies.Delete(context.TODO(), gitpod.RunnerPolicyDeleteParams{ GroupID: gitpod.F("f53d2330-3795-4c5d-a1f3-453121af9c60"), RunnerID: gitpod.F("d2c94c27-3b76-4a42-b88c-95a85e392c68"), }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", policy) } ``` #### Response ```json {} ``` ## ListRunnerPolicies `client.Runners.Policies.List(ctx, params) (*PoliciesPage[RunnerPolicy], error)` **post** `/gitpod.v1.RunnerService/ListRunnerPolicies` Lists policies for a runner. Use this method to: - View access controls - Check policy configurations - Audit permissions ### Examples - List policies: Shows all policies for a runner. ```yaml runnerId: "d2c94c27-3b76-4a42-b88c-95a85e392c68" pagination: pageSize: 20 ``` ### Parameters - `params RunnerPolicyListParams` - `Token param.Field[string]` Query param - `PageSize param.Field[int64]` Query param - `Pagination param.Field[RunnerPolicyListParamsPagination]` Body param: pagination contains the pagination options for listing project policies - `Token string` Token for the next set of results that was returned as next_token of a PaginationResponse - `PageSize int64` Page size is the maximum number of results to retrieve per page. Defaults to 25. Maximum 100. - `RunnerID param.Field[string]` Body param: runner_id specifies the project identifier ### Returns - `type RunnerPolicy struct{…}` - `GroupID string` - `Role RunnerRole` role is the role assigned to the group - `const RunnerRoleUnspecified RunnerRole = "RUNNER_ROLE_UNSPECIFIED"` - `const RunnerRoleAdmin RunnerRole = "RUNNER_ROLE_ADMIN"` - `const RunnerRoleUser RunnerRole = "RUNNER_ROLE_USER"` ### Example ```go 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"), ) page, err := client.Runners.Policies.List(context.TODO(), gitpod.RunnerPolicyListParams{ Pagination: gitpod.F(gitpod.RunnerPolicyListParamsPagination{ PageSize: gitpod.F(int64(20)), }), RunnerID: gitpod.F("d2c94c27-3b76-4a42-b88c-95a85e392c68"), }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", page) } ``` #### Response ```json { "pagination": { "nextToken": "nextToken" }, "policies": [ { "groupId": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "role": "RUNNER_ROLE_UNSPECIFIED" } ] } ``` ## UpdateRunnerPolicy `client.Runners.Policies.Update(ctx, body) (*RunnerPolicyUpdateResponse, error)` **post** `/gitpod.v1.RunnerService/UpdateRunnerPolicy` Updates an existing runner policy. Use this method to: - Modify access levels - Change group roles - Update permissions ### Examples - Update policy role: Changes a group's access level. ```yaml runnerId: "d2c94c27-3b76-4a42-b88c-95a85e392c68" groupId: "f53d2330-3795-4c5d-a1f3-453121af9c60" role: RUNNER_ROLE_USER ``` ### Parameters - `body RunnerPolicyUpdateParams` - `GroupID param.Field[string]` group_id specifies the group_id identifier - `Role param.Field[RunnerRole]` - `RunnerID param.Field[string]` runner_id specifies the project identifier ### Returns - `type RunnerPolicyUpdateResponse struct{…}` - `Policy RunnerPolicy` - `GroupID string` - `Role RunnerRole` role is the role assigned to the group - `const RunnerRoleUnspecified RunnerRole = "RUNNER_ROLE_UNSPECIFIED"` - `const RunnerRoleAdmin RunnerRole = "RUNNER_ROLE_ADMIN"` - `const RunnerRoleUser RunnerRole = "RUNNER_ROLE_USER"` ### Example ```go 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"), ) policy, err := client.Runners.Policies.Update(context.TODO(), gitpod.RunnerPolicyUpdateParams{ GroupID: gitpod.F("f53d2330-3795-4c5d-a1f3-453121af9c60"), Role: gitpod.F(gitpod.RunnerRoleUser), RunnerID: gitpod.F("d2c94c27-3b76-4a42-b88c-95a85e392c68"), }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", policy.Policy) } ``` #### Response ```json { "policy": { "groupId": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "role": "RUNNER_ROLE_UNSPECIFIED" } } ``` ## Domain Types ### Runner Policy - `type RunnerPolicy struct{…}` - `GroupID string` - `Role RunnerRole` role is the role assigned to the group - `const RunnerRoleUnspecified RunnerRole = "RUNNER_ROLE_UNSPECIFIED"` - `const RunnerRoleAdmin RunnerRole = "RUNNER_ROLE_ADMIN"` - `const RunnerRoleUser RunnerRole = "RUNNER_ROLE_USER"` ### Runner Role - `type RunnerRole string` - `const RunnerRoleUnspecified RunnerRole = "RUNNER_ROLE_UNSPECIFIED"` - `const RunnerRoleAdmin RunnerRole = "RUNNER_ROLE_ADMIN"` - `const RunnerRoleUser RunnerRole = "RUNNER_ROLE_USER"`