How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Gitpod gitpod.v1.RunnerService API

The gitpod.v1.RunnerService API from Gitpod — 16 operation(s) for gitpod.v1.runnerservice.

Gitpod gitpod.v1.RunnerService API is one of 34 APIs that Gitpod publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 16 operations across 16 paths, and defines 72 schemas. It is described by OpenAPI 3.0.0, at version v1.0.0.

Requests are made against a single base URL, https://api.gitpod.io.

16 operations 16 paths 72 schemas 16 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
v1.0.0
Base URL
https://api.gitpod.io
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Gitpod gitpod.v1.RunnerService API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth).

Paths & Operations 16

Across 16 paths, the API surfaces 16 operations — 16 POST. Each is listed below with its method, path, parameters, and response codes.

gitpod.v1.RunnerService 16
POST
/gitpod.v1.RunnerService/CheckAuthenticationForHost
CheckAuthenticationForHost
gitpod.v1.RunnerService.CheckAuthenticationForHost body → 200default
POST
/gitpod.v1.RunnerService/CheckRepositoryAccess
CheckRepositoryAccess
gitpod.v1.RunnerService.CheckRepositoryAccess body → 200default
POST
/gitpod.v1.RunnerService/CreateRunner
CreateRunner
gitpod.v1.RunnerService.CreateRunner body → 200default
POST
/gitpod.v1.RunnerService/CreateRunnerLogsToken
CreateRunnerLogsToken
gitpod.v1.RunnerService.CreateRunnerLogsToken body → 200default
POST
/gitpod.v1.RunnerService/CreateRunnerPolicy
CreateRunnerPolicy
gitpod.v1.RunnerService.CreateRunnerPolicy body → 200default
POST
/gitpod.v1.RunnerService/CreateRunnerToken
CreateRunnerToken
gitpod.v1.RunnerService.CreateRunnerToken body → 200default
POST
/gitpod.v1.RunnerService/DeleteRunner
DeleteRunner
gitpod.v1.RunnerService.DeleteRunner body → 200default
POST
/gitpod.v1.RunnerService/DeleteRunnerPolicy
DeleteRunnerPolicy
gitpod.v1.RunnerService.DeleteRunnerPolicy body → 200default
POST
/gitpod.v1.RunnerService/GetRunner
GetRunner
gitpod.v1.RunnerService.GetRunner body → 200default
POST
/gitpod.v1.RunnerService/ListRunnerPolicies
ListRunnerPolicies
gitpod.v1.RunnerService.ListRunnerPolicies 2 params body → 200default
POST
/gitpod.v1.RunnerService/ListRunners
ListRunners
gitpod.v1.RunnerService.ListRunners 2 params body → 200default
POST
/gitpod.v1.RunnerService/ListSCMOrganizations
ListSCMOrganizations
gitpod.v1.RunnerService.ListSCMOrganizations 2 params body → 200default
POST
/gitpod.v1.RunnerService/ParseContextURL
ParseContextURL
gitpod.v1.RunnerService.ParseContextURL body → 200default
POST
/gitpod.v1.RunnerService/SearchRepositories
SearchRepositories
gitpod.v1.RunnerService.SearchRepositories body → 200default
POST
/gitpod.v1.RunnerService/UpdateRunner
UpdateRunner
gitpod.v1.RunnerService.UpdateRunner body → 200default
POST
/gitpod.v1.RunnerService/UpdateRunnerPolicy
UpdateRunnerPolicy
gitpod.v1.RunnerService.UpdateRunnerPolicy body → 200default

Schemas 72

The contract defines 72 schemas that model the data the API accepts and returns. The most detailed are gitpod.v1.RunnerStatus (13 properties), gitpod.v1.Runner (10 properties), gitpod.v1.PullRequest (9 properties), gitpod.v1.RunnerConfiguration (9 properties). Each schema is shown below with its type and property counts.

gitpod.v1.RunnerRole
string
gitpod.v1.Principal
string
gitpod.v1.RunnerCapability
string
gitpod.v1.GetRunnerRequest
object
1 property
gitpod.v1.PullRequest.State
string
Current state of the pull request
gitpod.v1.CreateRunnerLogsTokenRequest
object
1 property
gitpod.v1.ListSCMOrganizationsRequest
object
2 properties
gitpod.v1.DeleteRunnerPolicyRequest
object
DeleteRunnerPolicyRequest deletes a Project Policy.
2 properties
gitpod.v1.ParseContextURLResponse.Issue
object
2 properties
gitpod.v1.RunnerVariant
string
gitpod.v1.CheckRepositoryAccessResponse
object
2 properties
gitpod.v1.Subject
object
2 properties
gitpod.v1.RunnerPhase
string
RunnerPhase represents the phase a runner is in
gitpod.v1.CreateRunnerRequest
object
5 properties
gitpod.v1.GetRunnerResponse
object
1 property 1 required
gitpod.v1.MetricsConfiguration
object
5 properties
gitpod.v1.UpdateRunnerRequest.RunnerConfiguration
object
8 properties
gitpod.v1.RunnerStatus
object
RunnerStatus represents the status of a runner
13 properties
connect.error
object
Error type returned by Connect: https://connectrpc.com/docs/go/errors/http-representation
2 properties
gitpod.v1.UpdateRunnerRequest
object
3 properties
gitpod.v1.ParseContextURLResponse
object
7 properties
gitpod.v1.Runner
object
10 properties
gitpod.v1.ListSCMOrganizationsResponse
object
1 property
gitpod.v1.PaginationRequest
object
2 properties
gitpod.v1.DeleteRunnerPolicyResponse
object
gitpod.v1.FieldValue
object
2 properties
gitpod.v1.SearchRepositoriesResponse
object
3 properties
gitpod.v1.GatewayInfo
object
2 properties
google.protobuf.Duration
string
A Duration represents a signed, fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independen…
gitpod.v1.CheckAuthenticationForHostRequest
object
2 properties
gitpod.v1.CheckAuthenticationForHostResponse.AuthenticationMethodOAuth2
object
2 properties
gitpod.v1.SearchMode
string
gitpod.v1.RunnerSpec
object
3 properties
gitpod.v1.UpdateRunnerPolicyRequest
object
UpdateRunnerPolicyRequest updates a Project Policy.
3 properties
gitpod.v1.CreateRunnerPolicyResponse
object
1 property 1 required
gitpod.v1.CheckAuthenticationForHostResponse.AuthenticationMethodPersonalAccessToken
object
4 properties
gitpod.v1.LogLevel
string
gitpod.v1.UpdateRunnerPolicyResponse
object
1 property 1 required
gitpod.v1.DeleteRunnerRequest
object
2 properties
gitpod.v1.UpdateRunnerRequest.Spec
object
2 properties
gitpod.v1.SearchRepositoriesResponse.Repository
object
2 properties
gitpod.v1.CreateRunnerLogsTokenResponse
object
1 property 1 required
gitpod.v1.PaginationResponse
object
1 property
gitpod.v1.Gateway
object
Gateway represents a system gateway that provides access to services
3 properties 2 required
gitpod.v1.CreateRunnerResponse
object
3 properties 1 required
gitpod.v1.PullRequest
object
PullRequest represents pull request metadata from source control systems. This message is used across workflow triggers, executions, and agent contexts to main…
9 properties
gitpod.v1.PullRequest.Repository
object
Repository information
4 properties
google.protobuf.Timestamp
string
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 res…
gitpod.v1.ListRunnersResponse
object
2 properties
gitpod.v1.UpdateRunnerRequest.MetricsConfiguration
object
5 properties
gitpod.v1.DeleteRunnerResponse
object
gitpod.v1.RunnerConfiguration
object
9 properties
gitpod.v1.RunnerReleaseChannel
string
gitpod.v1.UpdateRunnerResponse
object
gitpod.v1.SearchRepositoriesRequest
object
6 properties
gitpod.v1.ParseContextURLResponse.PullRequest
object
Deprecated: Use top-level PullRequest message instead
4 properties
gitpod.v1.ListRunnersRequest
object
2 properties
gitpod.v1.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 f…
gitpod.v1.ParseContextURLRequest
object
2 properties
gitpod.v1.CreateRunnerTokenRequest
object
1 property
gitpod.v1.ListSCMOrganizationsResponse.SCMOrganization
object
3 properties
gitpod.v1.RunnerPolicy
object
2 properties
gitpod.v1.CreateRunnerTokenResponse
object
2 properties
gitpod.v1.RunnerKind
string
RunnerKind represents the kind of a runner
gitpod.v1.CreateRunnerPolicyRequest
object
CreateRunnerPolicyRequest creates a Runner Policy.
3 properties
gitpod.v1.ListRunnerPoliciesRequest
object
ListRunnerPoliciesRequest lists policies for a project.
2 properties
gitpod.v1.ParseContextURLResponse.GitContext
object
8 properties
gitpod.v1.ListRunnersRequest.Filter
object
3 properties
gitpod.v1.UpdateWindow
object
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…
2 properties
gitpod.v1.CheckAuthenticationForHostResponse
object
7 properties
gitpod.v1.CheckRepositoryAccessRequest
object
2 properties
gitpod.v1.ListRunnerPoliciesResponse
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

gitpod-gitpod-v1-runnerservice-api-openapi.yml Raw ↑

Other APIs Gitpod publishes across the network.

Gitpod Organizations API
Gitpod Projects API
Gitpod Accounts and Billing API
Gitpod gitpod.v1.AccountService API
Gitpod gitpod.v1.AgentSecurityService API
Gitpod gitpod.v1.AgentService API
Gitpod gitpod.v1.BillingService API
Gitpod gitpod.v1.EditorService API
Gitpod gitpod.v1.EnvironmentAutomationService API
Gitpod gitpod.v1.EnvironmentService API
Gitpod gitpod.v1.ErrorsService API
Gitpod gitpod.v1.EventService API
Where this information came from

This is an independent, third-party profile of Gitpod gitpod.v1.RunnerService API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.