DeletePrebuild

client.prebuilds.delete(, ?): PrebuildDeleteResponse

POST/gitpod.v1.PrebuildService/DeletePrebuild

Deletes a prebuild.

Prebuilds are automatically deleted after some time. Use this method to manually delete a prebuild before automatic cleanup, for example to remove a prebuild that should no longer be used.

Deletion is processed asynchronously. The prebuild will be marked for deletion and removed from the system in the background.

Examples

Delete prebuild:

Marks a prebuild for deletion and removes it from the system.
```
prebuildId: "07e03a28-65a5-4d98-b532-8ea67b188048"
```

ParametersExpand Collapse

body: PrebuildDeleteParams { prebuildId }

prebuildId: string

prebuild_id specifies the prebuild to delete

formatuuid

ReturnsExpand Collapse

PrebuildDeleteResponse = unknown

DeletePrebuild

import Gitpod from '@gitpod/sdk';

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

const prebuild = await client.prebuilds.delete({
  prebuildId: '07e03a28-65a5-4d98-b532-8ea67b188048',
});

console.log(prebuild);

{}

Returns Examples

{}