Skip to main content
Unary · Runners 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 an AWS runner: Creates a new runner in AWS EC2.
  • Create a GCP runner: Creates a new runner on Google Cloud Platform.
  • Create local runner (deprecated): Creates a new local runner on Linux. Local runners are deprecated; use RUNNER_PROVIDER_AWS_EC2 or RUNNER_PROVIDER_GCP instead.

Endpoint

Send a Bearer token as described in Authentication. If your organization uses a custom management-plane domain, replace https://app.ona.com with that domain.

Request example

Request

gitpod.v1.CreateRunnerRequest

Response

gitpod.v1.CreateRunnerResponse
gitpod.v1.Runner
gitpod.v1.RunnerConfiguration
gitpod.v1.RunnerSpec
RunnerStatus represents the status of a runnergitpod.v1.RunnerStatus
gitpod.v1.Subject
RunnerKind represents the kind of a runner
RunnerPhase represents the phase a runner is in
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.