Deployments.ai Docs
Command reference

deployments workflow

Versioned deterministic workflow definitions

CommandSummary
deployments workflow listList workflow definitions
deployments workflow createCreate a workflow definition
deployments workflow showShow a workflow definition
deployments workflow updateUpdate a workflow definition
deployments workflow archiveArchive a workflow definition
deployments workflow releasePublish an immutable workflow release

deployments workflow list

List workflow definitions.

deployments workflow list
  • Calls GET /v1/workflow-definitions (SDK listWorkflowDefinitions).
  • 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

Also accepts the global flags.

deployments workflow create

Create a workflow definition.

deployments workflow create --definition <json>
  • Calls POST /v1/workflow-definitions (SDK createWorkflowDefinition).
  • Needs an environment: --env or the saved context.
  • Sends an idempotency key. The CLI generates one per run; pass --idempotency-key to retry safely.
FlagTypeRequiredDefaultDescription
--definitionstring (json)yesWorkflow definition document

Also accepts the global flags.

deployments workflow show

Show a workflow definition.

deployments workflow show <id>
FlagTypeRequiredDefaultDescription
<id>positionalyesResource ID

Also accepts the global flags.

deployments workflow update

Update a workflow definition.

deployments workflow update <id> --definition <json> --expected-version <number>
  • Calls PATCH /v1/workflow-definitions/{id} (SDK updateWorkflowDefinition).
  • Needs an environment: --env or the saved context.
  • Sends an idempotency key. The CLI generates one per run; pass --idempotency-key to retry safely.
FlagTypeRequiredDefaultDescription
<id>positionalyesResource ID
--definitionstring (json)yesWorkflow definition document
--expected-versionstring (number)yesExpected resource version

Also accepts the global flags.

deployments workflow archive

Archive a workflow definition.

deployments workflow archive <id> --expected-version <number>
  • Calls DELETE /v1/workflow-definitions/{id} (SDK archiveWorkflowDefinition).
  • 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.

deployments workflow release

Publish an immutable workflow release.

deployments workflow release <id> --expected-definition-version <number>
  • Calls POST /v1/workflow-definitions/{id}/releases (SDK publishWorkflowRelease).
  • Needs an environment: --env or the saved context.
  • Sends an idempotency key. The CLI generates one per run; pass --idempotency-key to retry safely.
FlagTypeRequiredDefaultDescription
<id>positionalyesResource ID
--expected-definition-versionstring (number)yesExpected workflow definition version

Also accepts the global flags.

On this page