PrebuildService manages prebuilds for projects to enable faster environment startup times. Prebuilds create snapshots of environments that can be used to provision new environments quickly.
Gitpod gitpod.v1.PrebuildService 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
11 operations
across 11 paths,
and defines 42 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.
11 operations11 paths42 schemas11 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.PrebuildService API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (JWT) (bearerAuth).
Paths & Operations 11
Across 11 paths, the API surfaces 11 operations — 11 POST. Each is listed below with its method, path, parameters, and response codes.
gitpod.v1.PrebuildService 11
PrebuildService manages prebuilds for projects to enable faster environment startup times. Prebuilds create snapshots of environments that can be used to provision new environment…
The contract defines 42 schemas that model the data the API accepts and returns. The most detailed are gitpod.v1.PrebuildStatus (9 properties), gitpod.v1.PrebuildMetadata (8 properties), gitpod.v1.WarmPoolMetadata (6 properties), gitpod.v1.WarmPoolStatus (6 properties). Each schema is shown below with its type and property counts.
gitpod.v1.Principal
string
gitpod.v1.CreatePrebuildLogsTokenResponse
object
1 property1 required
gitpod.v1.CreatePrebuildResponse
object
1 property1 required
gitpod.v1.UpdateWarmPoolResponse
object
1 property1 required
gitpod.v1.GetPrebuildRequest
object
1 property1 required
gitpod.v1.PrebuildSpec
object
PrebuildSpec contains the configuration used to create a prebuild
3 properties
gitpod.v1.ListWarmPoolsRequest.Filter
object
2 properties
gitpod.v1.GetPrebuildResponse
object
1 property1 required
gitpod.v1.DeleteWarmPoolRequest
object
1 property1 required
gitpod.v1.DeleteWarmPoolResponse
object
gitpod.v1.ListWarmPoolsResponse
object
2 properties
gitpod.v1.CreateWarmPoolResponse
object
1 property1 required
gitpod.v1.Subject
object
2 properties
gitpod.v1.PrebuildPhase
string
PrebuildPhase represents the lifecycle phase of a prebuild
gitpod.v1.PrebuildMetadata.PrebuildTrigger
string
PrebuildTrigger indicates how the prebuild was triggered
gitpod.v1.WarmPoolMetadata
object
WarmPoolMetadata contains metadata about the warm pool
6 properties2 required
gitpod.v1.WarmPoolStatus
object
WarmPoolStatus contains the current status of a warm pool as reported by the runner
6 properties1 required
connect.error
object
Error type returned by Connect: https://connectrpc.com/docs/go/errors/http-representation
2 properties
gitpod.v1.ListPrebuildsRequest
object
2 properties
gitpod.v1.PaginationRequest
object
2 properties
gitpod.v1.CreateWarmPoolRequest
object
5 properties2 required
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.WarmPoolPhase
string
WarmPoolPhase represents the lifecycle phase of a warm pool
gitpod.v1.CreatePrebuildRequest
object
3 properties2 required
gitpod.v1.CancelPrebuildResponse
object
1 property1 required
gitpod.v1.GetWarmPoolRequest
object
1 property1 required
gitpod.v1.ListPrebuildsRequest.Filter
object
5 properties
gitpod.v1.PrebuildMetadata
object
PrebuildMetadata contains metadata about the prebuild
8 properties3 required
gitpod.v1.CancelPrebuildRequest
object
1 property1 required
gitpod.v1.WarmPoolSpec
object
WarmPoolSpec contains the desired configuration for a warm pool
6 properties
gitpod.v1.PaginationResponse
object
1 property
gitpod.v1.DeletePrebuildRequest
object
1 property1 required
gitpod.v1.CreatePrebuildLogsTokenRequest
object
1 property1 required
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.UpdateWarmPoolRequest
object
4 properties1 required
gitpod.v1.ListPrebuildsResponse
object
2 properties
gitpod.v1.DeletePrebuildResponse
object
gitpod.v1.Prebuild
object
Prebuild represents a prebuild for a project that creates a snapshot for faster environment startup times.
4 properties3 required
gitpod.v1.PrebuildStatus
object
PrebuildStatus contains the current status and progress of a prebuild
9 properties1 required
gitpod.v1.GetWarmPoolResponse
object
1 property1 required
gitpod.v1.WarmPool
object
WarmPool maintains pre-created environment instances from a prebuild snapshot for near-instant environment startup. One warm pool exists per pair.
4 properties3 required
gitpod.v1.ListWarmPoolsRequest
object
2 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.
Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.
MCP tools for apis
4 tools reach this content
search_api_evangelistSearch every content type across the network at once.
find_relatedThe shared-tag relevance graph — what else covers this.
get_tagEverything one tag labels, across all content types.
guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
A second provider on the same verified email joins the account you already have.
Your account
ⓘWhere this information came from
This is an independent, third-party profile of Gitpod gitpod.v1.PrebuildService 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.
