Skip to content
Ona API Reference
Ona Docs
API Reference
Runners

DeleteRunner

runners.delete(RunnerDeleteParams**kwargs) -> object
POST/gitpod.v1.RunnerService/DeleteRunner

Deletes a runner permanently.

Use this method to:

  • Remove unused runners
  • Clean up runner registrations
  • Delete obsolete runners

Examples

  • Delete runner:

    Permanently removes a runner.

    runnerId: "d2c94c27-3b76-4a42-b88c-95a85e392c68"
ParametersExpand Collapse
force: Optional[bool]

force indicates whether the runner should be deleted forcefully. When force deleting a Runner, all Environments on the runner are also force deleted and regular Runner lifecycle is not respected. Force deleting can result in data loss.

runner_id: Optional[str]
formatuuid
ReturnsExpand Collapse
object

DeleteRunner

import os
from gitpod import Gitpod

client = Gitpod(
    bearer_token=os.environ.get("GITPOD_API_KEY"),  # This is the default and can be omitted
)
runner = client.runners.delete(
    runner_id="d2c94c27-3b76-4a42-b88c-95a85e392c68",
)
print(runner)
{}
Returns Examples
{}