v18

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

DeleteWarmPool

Deletes a warm pool.

Deletion is processed asynchronously. The pool is marked for deletion and the runner drains instances in the background.

Warm pools are also automatically deleted when prebuilds are disabled on the project or the environment class is removed from the prebuild configuration.

Examples

  • Delete warm pool:

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

Request body

warmPoolIdstring uuid required

warm_pool_id specifies the warm pool to delete

Response

Success

GitpodV1DeleteWarmPoolResponse required