Sign in

v18

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-014211,6201.8 MB
gitpod.v1.PrebuildService

CreateWarmPool

Creates a warm pool for a project and environment class.

A warm pool maintains pre-created environment instances from a prebuild snapshot so that new environments can start near-instantly.

Only one warm pool is allowed per <project, environment_class> pair. The environment class must have prebuilds enabled on the project.

The pool's snapshot is managed automatically: when a new prebuild completes for the same project and environment class, the pool's snapshot is updated and the runner rotates instances.

Examples

  • Create warm pool:

    Creates a warm pool with 2 instances for a project and environment class.

    projectId: "b0e12f6c-4c67-429d-a4a6-d9838b5da047"
environmentClassId: "d2c94c27-3b76-4a42-b88c-95a85e392c68"
desiredSize: 2
post/gitpod.v1.PrebuildService/CreateWarmPool

Request body

desiredSizeinteger

desired_size is the number of warm instances to maintain. Deprecated: Use min_size and max_size instead for dynamic scaling.

environmentClassIdstring uuid required

environment_class_id specifies which environment class to warm. Must be listed in the project's prebuild configuration environment_class_ids.

maxSizeinteger nullable

max_size is the maximum number of warm instances to maintain. The pool will never scale above this value. Must be >= min_size and <= 20.

minSizeinteger nullable

min_size is the minimum number of warm instances to maintain. The pool will never scale below this value. Must be >= 0 and <= max_size. Set to 0 to allow full scale-down.

projectIdstring uuid required

project_id specifies the project this warm pool belongs to. The project must have prebuilds enabled.

Response

Success