Skip to content

Where would you like to start?

↑ ↓ to move · Enter to open · Esc to close

WorkflowClient.undeploy_release

def WorkflowClient.undeploy_release(
    workflow_or_slug: Workflow | str,
    release_or_id: WorkflowRelease | UUID | str,
    clusters: Cluster | str | list[Cluster | str] | None = None,
) -> WorkflowReleaseDeployment

Remove a workflow release from one or more clusters.

Parameters

Section titled “Parameters”
workflow_or_slug Workflow | str required

The workflow or workflow slug containing the release to remove from clusters.

release_or_id WorkflowRelease | UUID | str required

The workflow release or release ID to remove from clusters.

clusters Cluster | str | list[Cluster | str] | None

The cluster or clusters to remove the release from. If omitted, the API uses the default cluster.

Returns

Section titled “Returns”

The result, including the release and affected clusters.