Skip to content
Ona API Reference
Ona Docs
API Reference
Prebuilds

DeleteWarmPool

client.prebuilds.deleteWarmPool(PrebuildDeleteWarmPoolParams { warmPoolId } body, RequestOptionsoptions?): PrebuildDeleteWarmPoolResponse
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
body: PrebuildDeleteWarmPoolParams { warmPoolId }
warmPoolId: string

warm_pool_id specifies the warm pool to delete

formatuuid
ReturnsExpand Collapse
PrebuildDeleteWarmPoolResponse = unknown

DeleteWarmPool

import Gitpod from '@gitpod/sdk';

const client = new Gitpod({
  bearerToken: process.env['GITPOD_API_KEY'], // This is the default and can be omitted
});

const response = await client.prebuilds.deleteWarmPool({
  warmPoolId: 'a1b2c3d4-5678-9abc-def0-1234567890ab',
});

console.log(response);
{}
Returns Examples
{}