Skip to content

Workflows.UndeployRelease

go
func (workflowClient) UndeployRelease(
    ctx context.Context,
    workflowReference string,
    clusterSlugs []string,
    options ...workflow.UndeployOption,
) (*workflows.WorkflowReleaseDeployment, error)

Remove a workflow release from one or more clusters.

Parameters

workflowReference string required

The remote workflow reference, not a project slug or UUID.

workflow.WithReleaseID(releaseID uuid.UUID) workflow.UndeployOption

Restrict removal to this release. Omit the option to remove the workflow’s active deployment from the selected clusters.

clusterSlugs []string required

The clusters to remove the release from.

Returns

The result, including the release and affected clusters.

Type to search…