Deployments.ai Docs
Command reference

deployments workflow-release

Immutable workflow releases

CommandSummary
deployments workflow-release listList releases for a workflow definition
deployments workflow-release showShow a workflow release
deployments workflow-release archiveArchive 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 (SDK listWorkflowReleases).
  • Needs an environment: --env or the saved context.
  • Paginated. --page-size sets the page size; pass the returned cursor as --cursor for the next page.
FlagTypeRequiredDefaultDescription
--cursorstring (cursor)Pagination cursor
--page-sizestring (number)Page size
<id>positionalyesResource ID

Also accepts the global flags.

deployments workflow-release show

Show a workflow release.

deployments workflow-release show <id>
FlagTypeRequiredDefaultDescription
<id>positionalyesResource 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} (SDK archiveWorkflowRelease).
  • Needs an environment: --env or the saved context.
  • Destructive. Live runs ask for confirmation; pass --yes in scripts or with --json.
  • Sends an idempotency key. The CLI generates one per run; pass --idempotency-key to retry safely.
FlagTypeRequiredDefaultDescription
<id>positionalyesResource ID
--expected-versionstring (number)yesExpected resource version

Also accepts the global flags.

On this page