Skip to content

Where would you like to start?

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

WorkflowClient.deploy_release

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

Deploy a workflow release to one or more clusters.

Parameters

Section titled “Parameters”
workflow_or_slug Workflow | str required

The workflow or workflow slug containing the release to deploy.

release_or_id WorkflowRelease | UUID | str required

The workflow release or release ID to deploy.

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

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

Returns

Section titled “Returns”

The deployment result, including the release and affected clusters.