DeleteWorkflow

client.Automations.Delete(ctx, body) (*AutomationDeleteResponse, error)

POST/gitpod.v1.WorkflowService/DeleteWorkflow

Deletes a workflow permanently.

Use this method to:

Remove unused workflows
Clean up test workflows
Delete obsolete configurations

Examples

Delete workflow:

Permanently removes a workflow.

workflowId: "b0e12f6c-4c67-429d-a4a6-d9838b5da047"

ParametersExpand Collapse

body AutomationDeleteParams

Force param.Field[bool]Optional

force indicates whether to immediately delete the workflow and all related resources. When true, performs cascading deletion of:

All workflow executions
All workflow execution actions
All environments created by workflow actions
All agent executions created by workflow actions
The workflow itself When false (default), marks workflow executions for deletion and relies on background reconciliation to clean up resources.

WorkflowID param.Field[string]Optional

formatuuid

ReturnsExpand Collapse

type AutomationDeleteResponse interface{…}

DeleteWorkflow

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"),
  )
  automation, err := client.Automations.Delete(context.TODO(), gitpod.AutomationDeleteParams{
    WorkflowID: gitpod.F("b0e12f6c-4c67-429d-a4a6-d9838b5da047"),
  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", automation)
}

{}

Returns Examples

{}