DeleteRunner

client.runners.delete(, ?): RunnerDeleteResponse

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

body: RunnerDeleteParams { force, runnerId }

force?: boolean

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.

runnerId?: string

formatuuid

ReturnsExpand Collapse

RunnerDeleteResponse = unknown

DeleteRunner

import Gitpod from '@gitpod/sdk';

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

const runner = await client.runners.delete({ runnerId: 'd2c94c27-3b76-4a42-b88c-95a85e392c68' });

console.log(runner);

{}

Returns Examples

{}