Skip to content
Ona Docs

DeletePrebuild

prebuilds.delete(PrebuildDeleteParams**kwargs) -> object
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
prebuild_id: str

prebuild_id specifies the prebuild to delete

formatuuid
ReturnsExpand Collapse
object

DeletePrebuild

import os
from gitpod import Gitpod

client = Gitpod(
    bearer_token=os.environ.get("GITPOD_API_KEY"),  # This is the default and can be omitted
)
prebuild = client.prebuilds.delete(
    prebuild_id="07e03a28-65a5-4d98-b532-8ea67b188048",
)
print(prebuild)
{}
Returns Examples
{}