Sign in
gitpod.v1.RunnerService

CreateRunner

CreateRunner creates a new runner with the server. Registrations are very short-lived and must be renewed every 30 seconds. Runners can be registered for an entire organisation or a single user.

post/gitpod.v1.RunnerService/CreateRunner

Request body

kind'RUNNER_KIND_UNSPECIFIED' | 'RUNNER_KIND_LOCAL' | 'RUNNER_KIND_REMOTE' | 'RUNNER_KIND_LOCAL_CONFIGURATION'

RunnerKind represents the kind of a runner

namestring

The runner name for humans

provider'RUNNER_PROVIDER_UNSPECIFIED' | 'RUNNER_PROVIDER_AWS_EC2' | 'RUNNER_PROVIDER_LINUX_HOST' | 'RUNNER_PROVIDER_DESKTOP_MAC'

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.

Response

Success

accessTokenstring

deprecated, will be removed. Use exchange_token instead.

exchangeTokenstring

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.

Changes