DeletePrebuild

client.Prebuilds.Delete(ctx, body) (*PrebuildDeleteResponse, error)

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

prebuild_id specifies the prebuild to delete

formatuuid

ReturnsExpand Collapse

type PrebuildDeleteResponse interface{…}

DeletePrebuild

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"),
  )
  prebuild, err := client.Prebuilds.Delete(context.TODO(), gitpod.PrebuildDeleteParams{
    PrebuildID: gitpod.F("07e03a28-65a5-4d98-b532-8ea67b188048"),
  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", prebuild)
}

{}

Returns Examples

{}