Deployments.ai Docs
Command reference

deployments deployment

Environment agent deployments

CommandSummary
deployments deployment createCreate an agent deployment
deployments deployment listList agent deployments
deployments deployment showShow an agent deployment
deployments deployment pausePause an agent deployment
deployments deployment resumeResume an agent deployment
deployments deployment updateUpdate an agent deployment
deployments deployment rollbackRoll an agent deployment back to an earlier release
deployments deployment canary-startStart a canary for a candidate agent release
deployments deployment canary-promotePromote the canary candidate to primary
deployments deployment canary-abortAbort the active canary
deployments deployment stopStop an agent deployment

deployments deployment create

Create an agent deployment.

deployments deployment create --release <release>
  • Calls POST /v1/agent-deployments (SDK createAgentDeployment).
  • 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
--releasestringyesAgent release ID
--desired-statestringrunning or paused
--runtime-configstring (json)Deployment runtime configuration

Also accepts the global flags.

deployments deployment list

List agent deployments.

deployments deployment list
  • Calls GET /v1/agent-deployments (SDK listAgentDeployments).
  • 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 deployment show

Show an agent deployment.

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

Also accepts the global flags.

deployments deployment pause

Pause an agent deployment.

deployments deployment pause <id> --expected-version <number>
  • Calls PATCH /v1/agent-deployments/{id} (SDK updateAgentDeployment).
  • 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-versionstring (number)yesExpected resource version

Also accepts the global flags.

deployments deployment resume

Resume an agent deployment.

deployments deployment resume <id> --expected-version <number>
  • Calls PATCH /v1/agent-deployments/{id} (SDK updateAgentDeployment).
  • 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-versionstring (number)yesExpected resource version

Also accepts the global flags.

deployments deployment update

Update an agent deployment.

deployments deployment update <id> --expected-version <number>
  • Calls PATCH /v1/agent-deployments/{id} (SDK updateAgentDeployment).
  • 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-versionstring (number)yesExpected resource version
--runtime-configstring (json)Deployment runtime configuration
--releasestringRetarget to this agent release ID

Also accepts the global flags.

deployments deployment rollback

Roll an agent deployment back to an earlier release.

deployments deployment rollback <id> --to <to> --expected-version <number>
  • Calls PATCH /v1/agent-deployments/{id} (SDK updateAgentDeployment).
  • 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
--tostringyesAgent release ID to roll back to
--expected-versionstring (number)yesExpected resource version

Also accepts the global flags.

deployments deployment canary-start

Start a canary for a candidate agent release.

deployments deployment canary-start <id> --release <release> --weight <number> --expected-version <number>
  • Calls POST /v1/agent-deployments/{id}/canary (SDK startAgentDeploymentCanary).
  • 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
--releasestringyesCandidate agent release ID
--weightstring (number)yesCandidate traffic percentage (1-99)
--expected-versionstring (number)yesExpected resource version

Also accepts the global flags.

deployments deployment canary-promote

Promote the canary candidate to primary.

deployments deployment canary-promote <id> --expected-version <number>
  • Calls POST /v1/agent-deployments/{id}/canary/promote (SDK promoteAgentDeploymentCanary).
  • 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-versionstring (number)yesExpected resource version

Also accepts the global flags.

deployments deployment canary-abort

Abort the active canary.

deployments deployment canary-abort <id> --expected-version <number>
  • Calls POST /v1/agent-deployments/{id}/canary/abort (SDK abortAgentDeploymentCanary).
  • 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-versionstring (number)yesExpected resource version

Also accepts the global flags.

deployments deployment stop

Stop an agent deployment.

deployments deployment stop <id> --expected-version <number>
  • Calls DELETE /v1/agent-deployments/{id} (SDK stopAgentDeployment).
  • 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