Command reference
deployments workflow-release
Immutable workflow releases
| Command | Summary |
|---|---|
deployments workflow-release list | List releases for a workflow definition |
deployments workflow-release show | Show a workflow release |
deployments workflow-release archive | Archive a workflow release |
deployments workflow-release list
List releases for a workflow definition.
deployments workflow-release list <id>- Calls
GET /v1/workflow-definitions/{id}/releases(SDKlistWorkflowReleases). - Needs an environment:
--envor the saved context. - Paginated.
--page-sizesets the page size; pass the returned cursor as--cursorfor the next page.
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
--cursor | string (cursor) | Pagination cursor | ||
--page-size | string (number) | Page size | ||
<id> | positional | yes | Resource ID |
Also accepts the global flags.
deployments workflow-release show
Show a workflow release.
deployments workflow-release show <id>- Calls
GET /v1/workflow-releases/{id}(SDKgetWorkflowRelease). - Needs an environment:
--envor the saved context.
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
<id> | positional | yes | Resource ID |
Also accepts the global flags.
deployments workflow-release archive
Archive a workflow release.
deployments workflow-release archive <id> --expected-version <number>- Calls
DELETE /v1/workflow-releases/{id}(SDKarchiveWorkflowRelease). - Needs an environment:
--envor the saved context. - Destructive. Live runs ask for confirmation; pass
--yesin scripts or with--json. - Sends an idempotency key. The CLI generates one per run; pass
--idempotency-keyto retry safely.
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
<id> | positional | yes | Resource ID | |
--expected-version | string (number) | yes | Expected resource version |
Also accepts the global flags.