DeleteWarmPool

prebuilds.delete_warm_pool() -> object

POST/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"

ParametersExpand Collapse

warm_pool_id: str

warm_pool_id specifies the warm pool to delete

formatuuid

ReturnsExpand Collapse

object

DeleteWarmPool

import os
from gitpod import Gitpod

client = Gitpod(
    bearer_token=os.environ.get("GITPOD_API_KEY"),  # This is the default and can be omitted
)
response = client.prebuilds.delete_warm_pool(
    warm_pool_id="a1b2c3d4-5678-9abc-def0-1234567890ab",
)
print(response)

{}

Returns Examples

{}