Sign in

v18

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

UpdateWarmPool

Updates a warm pool's configuration.

Use this method to change the desired pool size.

Examples

  • Update pool size:

    warmPoolId: "a1b2c3d4-5678-9abc-def0-1234567890ab"
desiredSize: 5
post/gitpod.v1.PrebuildService/UpdateWarmPool

Request body

desiredSizeinteger nullable

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

maxSizeinteger nullable

max_size updates 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 updates 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.

warmPoolIdstring uuid required

warm_pool_id specifies the warm pool to update

Response

Success