# Configurations ## ValidateRunnerConfiguration `runners.configurations.validate(ConfigurationValidateParams**kwargs) -> ConfigurationValidateResponse` **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 - `environment_class: Optional[EnvironmentClass]` - `id: str` id is the unique identifier of the environment class - `runner_id: str` runner_id is the unique identifier of the runner the environment class belongs to - `configuration: Optional[List[FieldValue]]` configuration describes the configuration of the environment class - `key: Optional[str]` - `value: Optional[str]` - `description: Optional[str]` description is a human readable description of the environment class - `display_name: Optional[str]` display_name is the human readable name of the environment class - `enabled: Optional[bool]` enabled indicates whether the environment class can be used to create new environments. - `runner_id: Optional[str]` - `scm_integration: Optional[ScmIntegration]` - `id: Optional[str]` id is the unique identifier of the SCM integration - `host: Optional[str]` - `issuer_url: Optional[str]` issuer_url can be set to override the authentication provider URL, if it doesn't match the SCM host. - `oauth_client_id: Optional[str]` oauth_client_id is the OAuth app's client ID, if OAuth is configured. If configured, oauth_client_secret must also be set. - `oauth_encrypted_client_secret: Optional[Union[str, Base64FileInput]]` 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. - `oauth_plaintext_client_secret: Optional[str]` 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: Optional[bool]` - `scm_id: Optional[str]` scm_id references the scm_id in the runner's configuration schema that this integration is for - `virtual_directory: Optional[str]` 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 - `class ConfigurationValidateResponse: …` - `environment_class: Optional[EnvironmentClassValidationResult]` - `configuration_errors: Optional[List[FieldValidationError]]` - `error: Optional[str]` - `key: Optional[str]` - `description_error: Optional[str]` - `display_name_error: Optional[str]` - `valid: Optional[bool]` - `scm_integration: Optional[ScmIntegrationValidationResult]` - `host_error: Optional[str]` - `oauth_error: Optional[str]` - `pat_error: Optional[str]` - `scm_id_error: Optional[str]` - `valid: Optional[bool]` ### Example ```python import os from gitpod import Gitpod client = Gitpod( bearer_token=os.environ.get("GITPOD_API_KEY"), # This is the default and can be omitted ) response = client.runners.configurations.validate( runner_id="d2c94c27-3b76-4a42-b88c-95a85e392c68", scm_integration={ "host": "github.com", "id": "integration-id", "oauth_client_id": "client_id", "oauth_plaintext_client_secret": "client_secret", "scm_id": "github", }, ) print(response.environment_class) ``` #### 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 - `class EnvironmentClassValidationResult: …` - `configuration_errors: Optional[List[FieldValidationError]]` - `error: Optional[str]` - `key: Optional[str]` - `description_error: Optional[str]` - `display_name_error: Optional[str]` - `valid: Optional[bool]` ### Field Validation Error - `class FieldValidationError: …` - `error: Optional[str]` - `key: Optional[str]` ### Scm Integration Validation Result - `class ScmIntegrationValidationResult: …` - `host_error: Optional[str]` - `oauth_error: Optional[str]` - `pat_error: Optional[str]` - `scm_id_error: Optional[str]` - `valid: Optional[bool]` ### Configuration Validate Response - `class ConfigurationValidateResponse: …` - `environment_class: Optional[EnvironmentClassValidationResult]` - `configuration_errors: Optional[List[FieldValidationError]]` - `error: Optional[str]` - `key: Optional[str]` - `description_error: Optional[str]` - `display_name_error: Optional[str]` - `valid: Optional[bool]` - `scm_integration: Optional[ScmIntegrationValidationResult]` - `host_error: Optional[str]` - `oauth_error: Optional[str]` - `pat_error: Optional[str]` - `scm_id_error: Optional[str]` - `valid: Optional[bool]` # Environment Classes ## CreateEnvironmentClass `runners.configurations.environment_classes.create(EnvironmentClassCreateParams**kwargs) -> EnvironmentClassCreateResponse` **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 - `configuration: Optional[Iterable[FieldValue]]` - `key: Optional[str]` - `value: Optional[str]` - `description: Optional[str]` - `display_name: Optional[str]` - `runner_id: Optional[str]` ### Returns - `class EnvironmentClassCreateResponse: …` - `id: Optional[str]` ### Example ```python import os from gitpod import Gitpod client = Gitpod( bearer_token=os.environ.get("GITPOD_API_KEY"), # This is the default and can be omitted ) environment_class = client.runners.configurations.environment_classes.create( configuration=[{ "key": "cpu", "value": "8", }, { "key": "memory", "value": "16384", }], description="8 CPU, 16GB RAM", display_name="Large Instance", runner_id="d2c94c27-3b76-4a42-b88c-95a85e392c68", ) print(environment_class.id) ``` #### Response ```json { "id": "id" } ``` ## ListEnvironmentClasses `runners.configurations.environment_classes.list(EnvironmentClassListParams**kwargs) -> SyncEnvironmentClassesPage[EnvironmentClass]` **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 - `token: Optional[str]` - `page_size: Optional[int]` - `filter: Optional[Filter]` - `can_create_environments: Optional[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: Optional[bool]` enabled filters the response to only enabled or disabled environment classes. If not set, all environment classes are returned. - `runner_ids: Optional[Sequence[str]]` runner_ids filters the response to only EnvironmentClasses of these Runner IDs - `runner_kinds: Optional[List[RunnerKind]]` runner_kind filters the response to only environment classes from runners of these kinds. - `"RUNNER_KIND_UNSPECIFIED"` - `"RUNNER_KIND_LOCAL"` - `"RUNNER_KIND_REMOTE"` - `"RUNNER_KIND_LOCAL_CONFIGURATION"` - `runner_providers: Optional[List[RunnerProvider]]` runner_providers filters the response to only environment classes from runners of these providers. - `"RUNNER_PROVIDER_UNSPECIFIED"` - `"RUNNER_PROVIDER_AWS_EC2"` - `"RUNNER_PROVIDER_LINUX_HOST"` - `"RUNNER_PROVIDER_DESKTOP_MAC"` - `"RUNNER_PROVIDER_MANAGED"` - `"RUNNER_PROVIDER_GCP"` - `"RUNNER_PROVIDER_DEV_AGENT"` - `pagination: Optional[Pagination]` pagination contains the pagination options for listing environment classes - `token: Optional[str]` Token for the next set of results that was returned as next_token of a PaginationResponse - `page_size: Optional[int]` Page size is the maximum number of results to retrieve per page. Defaults to 25. Maximum 100. ### Returns - `class EnvironmentClass: …` - `id: str` id is the unique identifier of the environment class - `runner_id: str` runner_id is the unique identifier of the runner the environment class belongs to - `configuration: Optional[List[FieldValue]]` configuration describes the configuration of the environment class - `key: Optional[str]` - `value: Optional[str]` - `description: Optional[str]` description is a human readable description of the environment class - `display_name: Optional[str]` display_name is the human readable name of the environment class - `enabled: Optional[bool]` enabled indicates whether the environment class can be used to create new environments. ### Example ```python import os from gitpod import Gitpod client = Gitpod( bearer_token=os.environ.get("GITPOD_API_KEY"), # This is the default and can be omitted ) page = client.runners.configurations.environment_classes.list( filter={ "enabled": True }, pagination={ "page_size": 20 }, ) page = page.environment_classes[0] print(page.id) ``` #### Response ```json { "environmentClasses": [ { "id": "id", "runnerId": "runnerId", "configuration": [ { "key": "key", "value": "value" } ], "description": "xxx", "displayName": "xxx", "enabled": true } ], "pagination": { "nextToken": "nextToken" } } ``` ## GetEnvironmentClass `runners.configurations.environment_classes.retrieve(EnvironmentClassRetrieveParams**kwargs) -> EnvironmentClassRetrieveResponse` **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 - `environment_class_id: Optional[str]` ### Returns - `class EnvironmentClassRetrieveResponse: …` - `environment_class: Optional[EnvironmentClass]` - `id: str` id is the unique identifier of the environment class - `runner_id: str` runner_id is the unique identifier of the runner the environment class belongs to - `configuration: Optional[List[FieldValue]]` configuration describes the configuration of the environment class - `key: Optional[str]` - `value: Optional[str]` - `description: Optional[str]` description is a human readable description of the environment class - `display_name: Optional[str]` display_name is the human readable name of the environment class - `enabled: Optional[bool]` enabled indicates whether the environment class can be used to create new environments. ### Example ```python import os from gitpod import Gitpod client = Gitpod( bearer_token=os.environ.get("GITPOD_API_KEY"), # This is the default and can be omitted ) environment_class = client.runners.configurations.environment_classes.retrieve( environment_class_id="d2c94c27-3b76-4a42-b88c-95a85e392c68", ) print(environment_class.environment_class) ``` #### Response ```json { "environmentClass": { "id": "id", "runnerId": "runnerId", "configuration": [ { "key": "key", "value": "value" } ], "description": "xxx", "displayName": "xxx", "enabled": true } } ``` ## UpdateEnvironmentClass `runners.configurations.environment_classes.update(EnvironmentClassUpdateParams**kwargs) -> object` **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 - `description: Optional[str]` - `display_name: Optional[str]` - `enabled: Optional[bool]` - `environment_class_id: Optional[str]` ### Returns - `object` ### Example ```python import os from gitpod import Gitpod client = Gitpod( bearer_token=os.environ.get("GITPOD_API_KEY"), # This is the default and can be omitted ) environment_class = client.runners.configurations.environment_classes.update( description="16 CPU, 32GB RAM", display_name="Updated Large Instance", enabled=True, environment_class_id="d2c94c27-3b76-4a42-b88c-95a85e392c68", ) print(environment_class) ``` #### Response ```json {} ``` ## Domain Types ### Environment Class Create Response - `class EnvironmentClassCreateResponse: …` - `id: Optional[str]` ### Environment Class Retrieve Response - `class EnvironmentClassRetrieveResponse: …` - `environment_class: Optional[EnvironmentClass]` - `id: str` id is the unique identifier of the environment class - `runner_id: str` runner_id is the unique identifier of the runner the environment class belongs to - `configuration: Optional[List[FieldValue]]` configuration describes the configuration of the environment class - `key: Optional[str]` - `value: Optional[str]` - `description: Optional[str]` description is a human readable description of the environment class - `display_name: Optional[str]` display_name is the human readable name of the environment class - `enabled: Optional[bool]` enabled indicates whether the environment class can be used to create new environments. # Host Authentication Tokens ## CreateHostAuthenticationToken `runners.configurations.host_authentication_tokens.create(HostAuthenticationTokenCreateParams**kwargs) -> HostAuthenticationTokenCreateResponse` **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 - `token: Optional[str]` stored encrypted, retrieved via GetHostAuthenticationTokenValue - `expires_at: Optional[Union[str, datetime]]` 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: Optional[str]` - `integration_id: Optional[str]` - `refresh_token: Optional[str]` stored encrypted, retrieved via GetHostAuthenticationTokenValue - `runner_id: Optional[str]` - `scopes: Optional[Sequence[str]]` Maximum 100 scopes allowed (101 for validation purposes) - `source: Optional[HostAuthenticationTokenSource]` - `"HOST_AUTHENTICATION_TOKEN_SOURCE_UNSPECIFIED"` - `"HOST_AUTHENTICATION_TOKEN_SOURCE_OAUTH"` - `"HOST_AUTHENTICATION_TOKEN_SOURCE_PAT"` - `subject: Optional[Subject]` Subject identifies the principal (user or service account) for the token - `id: Optional[str]` id is the UUID of the subject - `principal: Optional[Principal]` Principal is the principal of the subject - `"PRINCIPAL_UNSPECIFIED"` - `"PRINCIPAL_ACCOUNT"` - `"PRINCIPAL_USER"` - `"PRINCIPAL_RUNNER"` - `"PRINCIPAL_ENVIRONMENT"` - `"PRINCIPAL_SERVICE_ACCOUNT"` - `"PRINCIPAL_RUNNER_MANAGER"` - `user_id: Optional[str]` Deprecated: Use principal_id and principal_type instead ### Returns - `class HostAuthenticationTokenCreateResponse: …` - `token: HostAuthenticationToken` - `id: str` - `expires_at: Optional[datetime]` 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: Optional[str]` - `integration_id: Optional[str]` links to integration instance - `runner_id: Optional[str]` - `scopes: Optional[List[str]]` token permissions - `source: Optional[HostAuthenticationTokenSource]` auth_type - `"HOST_AUTHENTICATION_TOKEN_SOURCE_UNSPECIFIED"` - `"HOST_AUTHENTICATION_TOKEN_SOURCE_OAUTH"` - `"HOST_AUTHENTICATION_TOKEN_SOURCE_PAT"` - `subject: Optional[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: Optional[str]` id is the UUID of the subject - `principal: Optional[Principal]` Principal is the principal of the subject - `"PRINCIPAL_UNSPECIFIED"` - `"PRINCIPAL_ACCOUNT"` - `"PRINCIPAL_USER"` - `"PRINCIPAL_RUNNER"` - `"PRINCIPAL_ENVIRONMENT"` - `"PRINCIPAL_SERVICE_ACCOUNT"` - `"PRINCIPAL_RUNNER_MANAGER"` - `user_id: Optional[str]` Deprecated: Use principal_id and principal_type instead principal (user) ### Example ```python import os from datetime import datetime from gitpod import Gitpod client = Gitpod( bearer_token=os.environ.get("GITPOD_API_KEY"), # This is the default and can be omitted ) host_authentication_token = client.runners.configurations.host_authentication_tokens.create( token="gho_xxxxxxxxxxxx", expires_at=datetime.fromisoformat("2024-12-31T23:59:59"), host="github.com", refresh_token="ghr_xxxxxxxxxxxx", runner_id="d2c94c27-3b76-4a42-b88c-95a85e392c68", source="HOST_AUTHENTICATION_TOKEN_SOURCE_OAUTH", user_id="f53d2330-3795-4c5d-a1f3-453121af9c60", ) print(host_authentication_token.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 `runners.configurations.host_authentication_tokens.delete(HostAuthenticationTokenDeleteParams**kwargs) -> object` **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 - `id: Optional[str]` ### Returns - `object` ### Example ```python import os from gitpod import Gitpod client = Gitpod( bearer_token=os.environ.get("GITPOD_API_KEY"), # This is the default and can be omitted ) host_authentication_token = client.runners.configurations.host_authentication_tokens.delete( id="d2c94c27-3b76-4a42-b88c-95a85e392c68", ) print(host_authentication_token) ``` #### Response ```json {} ``` ## ListHostAuthenticationTokens `runners.configurations.host_authentication_tokens.list(HostAuthenticationTokenListParams**kwargs) -> SyncTokensPage[HostAuthenticationToken]` **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 - `token: Optional[str]` - `page_size: Optional[int]` - `filter: Optional[Filter]` - `runner_id: Optional[str]` - `subject_id: Optional[str]` Filter by subject (user or service account) - `user_id: Optional[str]` Deprecated: Use principal_id instead - `pagination: Optional[Pagination]` - `token: Optional[str]` Token for the next set of results that was returned as next_token of a PaginationResponse - `page_size: Optional[int]` Page size is the maximum number of results to retrieve per page. Defaults to 25. Maximum 100. ### Returns - `class HostAuthenticationToken: …` - `id: str` - `expires_at: Optional[datetime]` 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: Optional[str]` - `integration_id: Optional[str]` links to integration instance - `runner_id: Optional[str]` - `scopes: Optional[List[str]]` token permissions - `source: Optional[HostAuthenticationTokenSource]` auth_type - `"HOST_AUTHENTICATION_TOKEN_SOURCE_UNSPECIFIED"` - `"HOST_AUTHENTICATION_TOKEN_SOURCE_OAUTH"` - `"HOST_AUTHENTICATION_TOKEN_SOURCE_PAT"` - `subject: Optional[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: Optional[str]` id is the UUID of the subject - `principal: Optional[Principal]` Principal is the principal of the subject - `"PRINCIPAL_UNSPECIFIED"` - `"PRINCIPAL_ACCOUNT"` - `"PRINCIPAL_USER"` - `"PRINCIPAL_RUNNER"` - `"PRINCIPAL_ENVIRONMENT"` - `"PRINCIPAL_SERVICE_ACCOUNT"` - `"PRINCIPAL_RUNNER_MANAGER"` - `user_id: Optional[str]` Deprecated: Use principal_id and principal_type instead principal (user) ### Example ```python import os from gitpod import Gitpod client = Gitpod( bearer_token=os.environ.get("GITPOD_API_KEY"), # This is the default and can be omitted ) page = client.runners.configurations.host_authentication_tokens.list( filter={ "runner_id": "d2c94c27-3b76-4a42-b88c-95a85e392c68" }, pagination={ "page_size": 20 }, ) page = page.tokens[0] print(page.id) ``` #### 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 `runners.configurations.host_authentication_tokens.retrieve(HostAuthenticationTokenRetrieveParams**kwargs) -> HostAuthenticationTokenRetrieveResponse` **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 - `id: Optional[str]` ### Returns - `class HostAuthenticationTokenRetrieveResponse: …` - `token: HostAuthenticationToken` - `id: str` - `expires_at: Optional[datetime]` 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: Optional[str]` - `integration_id: Optional[str]` links to integration instance - `runner_id: Optional[str]` - `scopes: Optional[List[str]]` token permissions - `source: Optional[HostAuthenticationTokenSource]` auth_type - `"HOST_AUTHENTICATION_TOKEN_SOURCE_UNSPECIFIED"` - `"HOST_AUTHENTICATION_TOKEN_SOURCE_OAUTH"` - `"HOST_AUTHENTICATION_TOKEN_SOURCE_PAT"` - `subject: Optional[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: Optional[str]` id is the UUID of the subject - `principal: Optional[Principal]` Principal is the principal of the subject - `"PRINCIPAL_UNSPECIFIED"` - `"PRINCIPAL_ACCOUNT"` - `"PRINCIPAL_USER"` - `"PRINCIPAL_RUNNER"` - `"PRINCIPAL_ENVIRONMENT"` - `"PRINCIPAL_SERVICE_ACCOUNT"` - `"PRINCIPAL_RUNNER_MANAGER"` - `user_id: Optional[str]` Deprecated: Use principal_id and principal_type instead principal (user) ### Example ```python import os from gitpod import Gitpod client = Gitpod( bearer_token=os.environ.get("GITPOD_API_KEY"), # This is the default and can be omitted ) host_authentication_token = client.runners.configurations.host_authentication_tokens.retrieve( id="d2c94c27-3b76-4a42-b88c-95a85e392c68", ) print(host_authentication_token.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 `runners.configurations.host_authentication_tokens.update(HostAuthenticationTokenUpdateParams**kwargs) -> object` **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 - `id: Optional[str]` - `token: Optional[str]` - `expires_at: Optional[Union[str, datetime, null]]` 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. - `refresh_token: Optional[str]` - `scopes: Optional[Sequence[str]]` ### Returns - `object` ### Example ```python import os from datetime import datetime from gitpod import Gitpod client = Gitpod( bearer_token=os.environ.get("GITPOD_API_KEY"), # This is the default and can be omitted ) host_authentication_token = client.runners.configurations.host_authentication_tokens.update( id="d2c94c27-3b76-4a42-b88c-95a85e392c68", token="gho_xxxxxxxxxxxx", expires_at=datetime.fromisoformat("2024-12-31T23:59:59"), refresh_token="ghr_xxxxxxxxxxxx", ) print(host_authentication_token) ``` #### Response ```json {} ``` ## Domain Types ### Host Authentication Token - `class HostAuthenticationToken: …` - `id: str` - `expires_at: Optional[datetime]` 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: Optional[str]` - `integration_id: Optional[str]` links to integration instance - `runner_id: Optional[str]` - `scopes: Optional[List[str]]` token permissions - `source: Optional[HostAuthenticationTokenSource]` auth_type - `"HOST_AUTHENTICATION_TOKEN_SOURCE_UNSPECIFIED"` - `"HOST_AUTHENTICATION_TOKEN_SOURCE_OAUTH"` - `"HOST_AUTHENTICATION_TOKEN_SOURCE_PAT"` - `subject: Optional[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: Optional[str]` id is the UUID of the subject - `principal: Optional[Principal]` Principal is the principal of the subject - `"PRINCIPAL_UNSPECIFIED"` - `"PRINCIPAL_ACCOUNT"` - `"PRINCIPAL_USER"` - `"PRINCIPAL_RUNNER"` - `"PRINCIPAL_ENVIRONMENT"` - `"PRINCIPAL_SERVICE_ACCOUNT"` - `"PRINCIPAL_RUNNER_MANAGER"` - `user_id: Optional[str]` Deprecated: Use principal_id and principal_type instead principal (user) ### Host Authentication Token Source - `Literal["HOST_AUTHENTICATION_TOKEN_SOURCE_UNSPECIFIED", "HOST_AUTHENTICATION_TOKEN_SOURCE_OAUTH", "HOST_AUTHENTICATION_TOKEN_SOURCE_PAT"]` - `"HOST_AUTHENTICATION_TOKEN_SOURCE_UNSPECIFIED"` - `"HOST_AUTHENTICATION_TOKEN_SOURCE_OAUTH"` - `"HOST_AUTHENTICATION_TOKEN_SOURCE_PAT"` ### Host Authentication Token Create Response - `class HostAuthenticationTokenCreateResponse: …` - `token: HostAuthenticationToken` - `id: str` - `expires_at: Optional[datetime]` 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: Optional[str]` - `integration_id: Optional[str]` links to integration instance - `runner_id: Optional[str]` - `scopes: Optional[List[str]]` token permissions - `source: Optional[HostAuthenticationTokenSource]` auth_type - `"HOST_AUTHENTICATION_TOKEN_SOURCE_UNSPECIFIED"` - `"HOST_AUTHENTICATION_TOKEN_SOURCE_OAUTH"` - `"HOST_AUTHENTICATION_TOKEN_SOURCE_PAT"` - `subject: Optional[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: Optional[str]` id is the UUID of the subject - `principal: Optional[Principal]` Principal is the principal of the subject - `"PRINCIPAL_UNSPECIFIED"` - `"PRINCIPAL_ACCOUNT"` - `"PRINCIPAL_USER"` - `"PRINCIPAL_RUNNER"` - `"PRINCIPAL_ENVIRONMENT"` - `"PRINCIPAL_SERVICE_ACCOUNT"` - `"PRINCIPAL_RUNNER_MANAGER"` - `user_id: Optional[str]` Deprecated: Use principal_id and principal_type instead principal (user) ### Host Authentication Token Retrieve Response - `class HostAuthenticationTokenRetrieveResponse: …` - `token: HostAuthenticationToken` - `id: str` - `expires_at: Optional[datetime]` 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: Optional[str]` - `integration_id: Optional[str]` links to integration instance - `runner_id: Optional[str]` - `scopes: Optional[List[str]]` token permissions - `source: Optional[HostAuthenticationTokenSource]` auth_type - `"HOST_AUTHENTICATION_TOKEN_SOURCE_UNSPECIFIED"` - `"HOST_AUTHENTICATION_TOKEN_SOURCE_OAUTH"` - `"HOST_AUTHENTICATION_TOKEN_SOURCE_PAT"` - `subject: Optional[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: Optional[str]` id is the UUID of the subject - `principal: Optional[Principal]` Principal is the principal of the subject - `"PRINCIPAL_UNSPECIFIED"` - `"PRINCIPAL_ACCOUNT"` - `"PRINCIPAL_USER"` - `"PRINCIPAL_RUNNER"` - `"PRINCIPAL_ENVIRONMENT"` - `"PRINCIPAL_SERVICE_ACCOUNT"` - `"PRINCIPAL_RUNNER_MANAGER"` - `user_id: Optional[str]` Deprecated: Use principal_id and principal_type instead principal (user) # Schema ## GetRunnerConfigurationSchema `runners.configurations.schema.retrieve(SchemaRetrieveParams**kwargs) -> SchemaRetrieveResponse` **post** `/gitpod.v1.RunnerConfigurationService/GetRunnerConfigurationSchema` Gets the latest runner configuration schema. Use this method to: - View available settings - Check configuration options - Validate configurations ### Examples - Get schema: Retrieves configuration schema for a runner. ```yaml runnerId: "d2c94c27-3b76-4a42-b88c-95a85e392c68" ``` ### Parameters - `runner_id: Optional[str]` ### Returns - `class SchemaRetrieveResponse: …` - `schema: Optional[RunnerConfigurationSchema]` - `environment_classes: Optional[List[EnvironmentClass]]` - `id: Optional[str]` - `bool: Optional[EnvironmentClassBool]` - `default: Optional[bool]` - `description: Optional[str]` - `display: Optional[EnvironmentClassDisplay]` - `default: Optional[str]` - `enum: Optional[EnvironmentClassEnum]` - `default: Optional[str]` deprecated, will be removed, use default_value instead - `default_value: Optional[EnvironmentClassEnumDefaultValue]` - `detail: Optional[str]` - `subtitle: Optional[str]` - `title: Optional[str]` - `possible_values: Optional[List[EnvironmentClassEnumPossibleValue]]` - `detail: Optional[str]` - `subtitle: Optional[str]` - `title: Optional[str]` - `values: Optional[List[str]]` deprecated, will be removed, use possible_values instead - `int: Optional[EnvironmentClassInt]` - `default: Optional[int]` - `max: Optional[int]` - `min: Optional[int]` - `name: Optional[str]` - `required: Optional[bool]` - `secret: Optional[bool]` - `string: Optional[EnvironmentClassString]` - `default: Optional[str]` - `pattern: Optional[str]` - `runner_config: Optional[List[RunnerConfig]]` - `id: Optional[str]` - `bool: Optional[RunnerConfigBool]` - `default: Optional[bool]` - `description: Optional[str]` - `display: Optional[RunnerConfigDisplay]` - `default: Optional[str]` - `enum: Optional[RunnerConfigEnum]` - `default: Optional[str]` deprecated, will be removed, use default_value instead - `default_value: Optional[RunnerConfigEnumDefaultValue]` - `detail: Optional[str]` - `subtitle: Optional[str]` - `title: Optional[str]` - `possible_values: Optional[List[RunnerConfigEnumPossibleValue]]` - `detail: Optional[str]` - `subtitle: Optional[str]` - `title: Optional[str]` - `values: Optional[List[str]]` deprecated, will be removed, use possible_values instead - `int: Optional[RunnerConfigInt]` - `default: Optional[int]` - `max: Optional[int]` - `min: Optional[int]` - `name: Optional[str]` - `required: Optional[bool]` - `secret: Optional[bool]` - `string: Optional[RunnerConfigString]` - `default: Optional[str]` - `pattern: Optional[str]` - `scm: Optional[List[Scm]]` - `default_hosts: Optional[List[str]]` - `name: Optional[str]` - `oauth: Optional[ScmOAuth]` - `callback_url: Optional[str]` callback_url is the URL the OAuth app will redirect to after the user has authenticated. - `pat: Optional[ScmPat]` - `description: Optional[str]` description is a human-readable description of the PAT. - `docs_link: Optional[str]` docs_link is a link to the documentation on how to create a PAT for this SCM system. - `scm_id: Optional[str]` - `version: Optional[str]` The schema version ### Example ```python import os from gitpod import Gitpod client = Gitpod( bearer_token=os.environ.get("GITPOD_API_KEY"), # This is the default and can be omitted ) schema = client.runners.configurations.schema.retrieve( runner_id="d2c94c27-3b76-4a42-b88c-95a85e392c68", ) print(schema.schema) ``` #### 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 - `class RunnerConfigurationSchema: …` - `environment_classes: Optional[List[EnvironmentClass]]` - `id: Optional[str]` - `bool: Optional[EnvironmentClassBool]` - `default: Optional[bool]` - `description: Optional[str]` - `display: Optional[EnvironmentClassDisplay]` - `default: Optional[str]` - `enum: Optional[EnvironmentClassEnum]` - `default: Optional[str]` deprecated, will be removed, use default_value instead - `default_value: Optional[EnvironmentClassEnumDefaultValue]` - `detail: Optional[str]` - `subtitle: Optional[str]` - `title: Optional[str]` - `possible_values: Optional[List[EnvironmentClassEnumPossibleValue]]` - `detail: Optional[str]` - `subtitle: Optional[str]` - `title: Optional[str]` - `values: Optional[List[str]]` deprecated, will be removed, use possible_values instead - `int: Optional[EnvironmentClassInt]` - `default: Optional[int]` - `max: Optional[int]` - `min: Optional[int]` - `name: Optional[str]` - `required: Optional[bool]` - `secret: Optional[bool]` - `string: Optional[EnvironmentClassString]` - `default: Optional[str]` - `pattern: Optional[str]` - `runner_config: Optional[List[RunnerConfig]]` - `id: Optional[str]` - `bool: Optional[RunnerConfigBool]` - `default: Optional[bool]` - `description: Optional[str]` - `display: Optional[RunnerConfigDisplay]` - `default: Optional[str]` - `enum: Optional[RunnerConfigEnum]` - `default: Optional[str]` deprecated, will be removed, use default_value instead - `default_value: Optional[RunnerConfigEnumDefaultValue]` - `detail: Optional[str]` - `subtitle: Optional[str]` - `title: Optional[str]` - `possible_values: Optional[List[RunnerConfigEnumPossibleValue]]` - `detail: Optional[str]` - `subtitle: Optional[str]` - `title: Optional[str]` - `values: Optional[List[str]]` deprecated, will be removed, use possible_values instead - `int: Optional[RunnerConfigInt]` - `default: Optional[int]` - `max: Optional[int]` - `min: Optional[int]` - `name: Optional[str]` - `required: Optional[bool]` - `secret: Optional[bool]` - `string: Optional[RunnerConfigString]` - `default: Optional[str]` - `pattern: Optional[str]` - `scm: Optional[List[Scm]]` - `default_hosts: Optional[List[str]]` - `name: Optional[str]` - `oauth: Optional[ScmOAuth]` - `callback_url: Optional[str]` callback_url is the URL the OAuth app will redirect to after the user has authenticated. - `pat: Optional[ScmPat]` - `description: Optional[str]` description is a human-readable description of the PAT. - `docs_link: Optional[str]` docs_link is a link to the documentation on how to create a PAT for this SCM system. - `scm_id: Optional[str]` - `version: Optional[str]` The schema version ### Schema Retrieve Response - `class SchemaRetrieveResponse: …` - `schema: Optional[RunnerConfigurationSchema]` - `environment_classes: Optional[List[EnvironmentClass]]` - `id: Optional[str]` - `bool: Optional[EnvironmentClassBool]` - `default: Optional[bool]` - `description: Optional[str]` - `display: Optional[EnvironmentClassDisplay]` - `default: Optional[str]` - `enum: Optional[EnvironmentClassEnum]` - `default: Optional[str]` deprecated, will be removed, use default_value instead - `default_value: Optional[EnvironmentClassEnumDefaultValue]` - `detail: Optional[str]` - `subtitle: Optional[str]` - `title: Optional[str]` - `possible_values: Optional[List[EnvironmentClassEnumPossibleValue]]` - `detail: Optional[str]` - `subtitle: Optional[str]` - `title: Optional[str]` - `values: Optional[List[str]]` deprecated, will be removed, use possible_values instead - `int: Optional[EnvironmentClassInt]` - `default: Optional[int]` - `max: Optional[int]` - `min: Optional[int]` - `name: Optional[str]` - `required: Optional[bool]` - `secret: Optional[bool]` - `string: Optional[EnvironmentClassString]` - `default: Optional[str]` - `pattern: Optional[str]` - `runner_config: Optional[List[RunnerConfig]]` - `id: Optional[str]` - `bool: Optional[RunnerConfigBool]` - `default: Optional[bool]` - `description: Optional[str]` - `display: Optional[RunnerConfigDisplay]` - `default: Optional[str]` - `enum: Optional[RunnerConfigEnum]` - `default: Optional[str]` deprecated, will be removed, use default_value instead - `default_value: Optional[RunnerConfigEnumDefaultValue]` - `detail: Optional[str]` - `subtitle: Optional[str]` - `title: Optional[str]` - `possible_values: Optional[List[RunnerConfigEnumPossibleValue]]` - `detail: Optional[str]` - `subtitle: Optional[str]` - `title: Optional[str]` - `values: Optional[List[str]]` deprecated, will be removed, use possible_values instead - `int: Optional[RunnerConfigInt]` - `default: Optional[int]` - `max: Optional[int]` - `min: Optional[int]` - `name: Optional[str]` - `required: Optional[bool]` - `secret: Optional[bool]` - `string: Optional[RunnerConfigString]` - `default: Optional[str]` - `pattern: Optional[str]` - `scm: Optional[List[Scm]]` - `default_hosts: Optional[List[str]]` - `name: Optional[str]` - `oauth: Optional[ScmOAuth]` - `callback_url: Optional[str]` callback_url is the URL the OAuth app will redirect to after the user has authenticated. - `pat: Optional[ScmPat]` - `description: Optional[str]` description is a human-readable description of the PAT. - `docs_link: Optional[str]` docs_link is a link to the documentation on how to create a PAT for this SCM system. - `scm_id: Optional[str]` - `version: Optional[str]` The schema version # Scm Integrations ## CreateSCMIntegration `runners.configurations.scm_integrations.create(ScmIntegrationCreateParams**kwargs) -> ScmIntegrationCreateResponse` **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 - `host: Optional[str]` - `issuer_url: Optional[str]` issuer_url can be set to override the authentication provider URL, if it doesn't match the SCM host. - `oauth_client_id: Optional[str]` oauth_client_id is the OAuth app's client ID, if OAuth is configured. If configured, oauth_plaintext_client_secret must also be set. - `oauth_plaintext_client_secret: Optional[str]` 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: Optional[bool]` - `runner_id: Optional[str]` - `scm_id: Optional[str]` scm_id references the scm_id in the runner's configuration schema that this integration is for - `virtual_directory: Optional[str]` 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 - `class ScmIntegrationCreateResponse: …` - `id: Optional[str]` id is a uniquely generated identifier for the SCM integration ### Example ```python import os from gitpod import Gitpod client = Gitpod( bearer_token=os.environ.get("GITPOD_API_KEY"), # This is the default and can be omitted ) scm_integration = client.runners.configurations.scm_integrations.create( host="github.com", oauth_client_id="client_id", oauth_plaintext_client_secret="client_secret", runner_id="d2c94c27-3b76-4a42-b88c-95a85e392c68", scm_id="github", ) print(scm_integration.id) ``` #### Response ```json { "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e" } ``` ## DeleteSCMIntegration `runners.configurations.scm_integrations.delete(ScmIntegrationDeleteParams**kwargs) -> object` **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 - `id: Optional[str]` ### Returns - `object` ### Example ```python import os from gitpod import Gitpod client = Gitpod( bearer_token=os.environ.get("GITPOD_API_KEY"), # This is the default and can be omitted ) scm_integration = client.runners.configurations.scm_integrations.delete( id="d2c94c27-3b76-4a42-b88c-95a85e392c68", ) print(scm_integration) ``` #### Response ```json {} ``` ## ListSCMIntegrations `runners.configurations.scm_integrations.list(ScmIntegrationListParams**kwargs) -> SyncIntegrationsPage[ScmIntegration]` **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 - `token: Optional[str]` - `page_size: Optional[int]` - `filter: Optional[Filter]` - `runner_ids: Optional[Sequence[str]]` runner_ids filters the response to only SCM integrations of these Runner IDs - `pagination: Optional[Pagination]` pagination contains the pagination options for listing scm integrations - `token: Optional[str]` Token for the next set of results that was returned as next_token of a PaginationResponse - `page_size: Optional[int]` Page size is the maximum number of results to retrieve per page. Defaults to 25. Maximum 100. ### Returns - `class ScmIntegration: …` - `id: Optional[str]` id is the unique identifier of the SCM integration - `host: Optional[str]` - `oauth: Optional[ScmIntegrationOAuthConfig]` - `client_id: Optional[str]` client_id is the OAuth app's client ID in clear text. - `encrypted_client_secret: Optional[str]` encrypted_client_secret is the OAuth app's secret encrypted with the runner's public key. - `issuer_url: Optional[str]` 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: Optional[bool]` - `runner_id: Optional[str]` - `scm_id: Optional[str]` scm_id references the scm_id in the runner's configuration schema that this integration is for - `virtual_directory: Optional[str]` 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 ```python import os from gitpod import Gitpod client = Gitpod( bearer_token=os.environ.get("GITPOD_API_KEY"), # This is the default and can be omitted ) page = client.runners.configurations.scm_integrations.list( filter={ "runner_ids": ["d2c94c27-3b76-4a42-b88c-95a85e392c68"] }, pagination={ "page_size": 20 }, ) page = page.integrations[0] print(page.id) ``` #### 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 `runners.configurations.scm_integrations.retrieve(ScmIntegrationRetrieveParams**kwargs) -> ScmIntegrationRetrieveResponse` **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 - `id: Optional[str]` ### Returns - `class ScmIntegrationRetrieveResponse: …` - `integration: Optional[ScmIntegration]` - `id: Optional[str]` id is the unique identifier of the SCM integration - `host: Optional[str]` - `oauth: Optional[ScmIntegrationOAuthConfig]` - `client_id: Optional[str]` client_id is the OAuth app's client ID in clear text. - `encrypted_client_secret: Optional[str]` encrypted_client_secret is the OAuth app's secret encrypted with the runner's public key. - `issuer_url: Optional[str]` 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: Optional[bool]` - `runner_id: Optional[str]` - `scm_id: Optional[str]` scm_id references the scm_id in the runner's configuration schema that this integration is for - `virtual_directory: Optional[str]` 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 ```python import os from gitpod import Gitpod client = Gitpod( bearer_token=os.environ.get("GITPOD_API_KEY"), # This is the default and can be omitted ) scm_integration = client.runners.configurations.scm_integrations.retrieve( id="d2c94c27-3b76-4a42-b88c-95a85e392c68", ) print(scm_integration.integration) ``` #### Response ```json { "integration": { "id": "id", "host": "host", "oauth": { "clientId": "clientId", "encryptedClientSecret": "U3RhaW5sZXNzIHJvY2tz", "issuerUrl": "issuerUrl" }, "pat": true, "runnerId": "runnerId", "scmId": "scmId", "virtualDirectory": "virtualDirectory" } } ``` ## UpdateSCMIntegration `runners.configurations.scm_integrations.update(ScmIntegrationUpdateParams**kwargs) -> object` **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 - `id: Optional[str]` - `issuer_url: Optional[str]` issuer_url can be set to override the authentication provider URL, if it doesn't match the SCM host. - `oauth_client_id: Optional[str]` 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. - `oauth_plaintext_client_secret: Optional[str]` 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: Optional[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. - `virtual_directory: Optional[str]` 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 - `object` ### Example ```python import os from gitpod import Gitpod client = Gitpod( bearer_token=os.environ.get("GITPOD_API_KEY"), # This is the default and can be omitted ) scm_integration = client.runners.configurations.scm_integrations.update( id="d2c94c27-3b76-4a42-b88c-95a85e392c68", oauth_client_id="new_client_id", oauth_plaintext_client_secret="new_client_secret", ) print(scm_integration) ``` #### Response ```json {} ``` ## Domain Types ### Scm Integration - `class ScmIntegration: …` - `id: Optional[str]` id is the unique identifier of the SCM integration - `host: Optional[str]` - `oauth: Optional[ScmIntegrationOAuthConfig]` - `client_id: Optional[str]` client_id is the OAuth app's client ID in clear text. - `encrypted_client_secret: Optional[str]` encrypted_client_secret is the OAuth app's secret encrypted with the runner's public key. - `issuer_url: Optional[str]` 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: Optional[bool]` - `runner_id: Optional[str]` - `scm_id: Optional[str]` scm_id references the scm_id in the runner's configuration schema that this integration is for - `virtual_directory: Optional[str]` 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 - `class ScmIntegrationOAuthConfig: …` - `client_id: Optional[str]` client_id is the OAuth app's client ID in clear text. - `encrypted_client_secret: Optional[str]` encrypted_client_secret is the OAuth app's secret encrypted with the runner's public key. - `issuer_url: Optional[str]` 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. ### Scm Integration Create Response - `class ScmIntegrationCreateResponse: …` - `id: Optional[str]` id is a uniquely generated identifier for the SCM integration ### Scm Integration Retrieve Response - `class ScmIntegrationRetrieveResponse: …` - `integration: Optional[ScmIntegration]` - `id: Optional[str]` id is the unique identifier of the SCM integration - `host: Optional[str]` - `oauth: Optional[ScmIntegrationOAuthConfig]` - `client_id: Optional[str]` client_id is the OAuth app's client ID in clear text. - `encrypted_client_secret: Optional[str]` encrypted_client_secret is the OAuth app's secret encrypted with the runner's public key. - `issuer_url: Optional[str]` 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: Optional[bool]` - `runner_id: Optional[str]` - `scm_id: Optional[str]` scm_id references the scm_id in the runner's configuration schema that this integration is for - `virtual_directory: Optional[str]` 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'.