DeleteRunner

client.Runners.Delete(ctx, body) (*RunnerDeleteResponse, error)

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 param.Field[bool]Optional

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 param.Field[string]Optional

formatuuid

ReturnsExpand Collapse

type RunnerDeleteResponse interface{…}

DeleteRunner

package main

import (
  "context"
  "fmt"

  "github.com/gitpod-io/gitpod-sdk-go"
  "github.com/gitpod-io/gitpod-sdk-go/option"
)

func main() {
  client := gitpod.NewClient(
    option.WithBearerToken("My Bearer Token"),
  )
  runner, err := client.Runners.Delete(context.TODO(), gitpod.RunnerDeleteParams{
    RunnerID: gitpod.F("d2c94c27-3b76-4a42-b88c-95a85e392c68"),
  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", runner)
}

{}

Returns Examples

{}