Deployments.ai Docs
Command reference

deployments governance

Retention, tenant data, and immutable audit exports

CommandSummary
deployments governance retention-showShow an organization retention policy
deployments governance retention-updateUpdate an organization retention policy
deployments governance tenant-exportCreate a tenant data export
deployments governance tenant-export-statusShow a tenant data export operation
deployments governance eraseErase tenant data
deployments governance erasure-statusShow a tenant erasure operation
deployments governance audit-exportCreate an immutable audit export
deployments governance audit-export-statusShow an immutable audit export operation
deployments governance operationsList governance operation history, newest first

deployments governance retention-show

Show an organization retention policy.

deployments governance retention-show <organization-id>
FlagTypeRequiredDefaultDescription
<organization-id>positionalyesOrganization ID

Also accepts the global flags.

deployments governance retention-update

Update an organization retention policy.

deployments governance retention-update <organization-id>
  • Calls PATCH /v1/organizations/{id}/retention-policy (SDK updateOrganizationRetentionPolicy).
  • Needs an organization: --org or the saved context.
  • Sends an idempotency key. The CLI generates one per run; pass --idempotency-key to retry safely.
FlagTypeRequiredDefaultDescription
<organization-id>positionalyesOrganization ID
--artifactsstring (number)Artifact retention in days
--auditstring (number)Audit retention in days
--eventsstring (number)Event retention in days
--messagesstring (number)Message retention in days
--runsstring (number)Run retention in days
--threadsstring (number)Thread retention in days

Also accepts the global flags.

deployments governance tenant-export

Create a tenant data export.

deployments governance tenant-export <organization-id>
  • Calls POST /v1/organizations/{id}/data-exports (SDK createTenantDataExport).
  • Needs an organization: --org or the saved context.
  • Sends an idempotency key. The CLI generates one per run; pass --idempotency-key to retry safely.
FlagTypeRequiredDefaultDescription
<organization-id>positionalyesOrganization ID

Also accepts the global flags.

deployments governance tenant-export-status

Show a tenant data export operation.

deployments governance tenant-export-status <organization-id> <operation-id>
FlagTypeRequiredDefaultDescription
<organization-id>positionalyesOrganization ID
<operation-id>positionalyesGovernance operation ID

Also accepts the global flags.

deployments governance erase

Erase tenant data.

deployments governance erase <organization-id>
  • Calls POST /v1/organizations/{id}/erasures (SDK createTenantErasure).
  • Needs an organization: --org 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
<organization-id>positionalyesOrganization ID

Also accepts the global flags.

deployments governance erasure-status

Show a tenant erasure operation.

deployments governance erasure-status <organization-id> <operation-id>
FlagTypeRequiredDefaultDescription
<organization-id>positionalyesOrganization ID
<operation-id>positionalyesGovernance operation ID

Also accepts the global flags.

deployments governance audit-export

Create an immutable audit export.

deployments governance audit-export <organization-id>
  • Calls POST /v1/organizations/{id}/audit-exports (SDK createImmutableAuditExport).
  • Needs an organization: --org or the saved context.
  • Sends an idempotency key. The CLI generates one per run; pass --idempotency-key to retry safely.
FlagTypeRequiredDefaultDescription
<organization-id>positionalyesOrganization ID

Also accepts the global flags.

deployments governance audit-export-status

Show an immutable audit export operation.

deployments governance audit-export-status <organization-id> <operation-id>
FlagTypeRequiredDefaultDescription
<organization-id>positionalyesOrganization ID
<operation-id>positionalyesGovernance operation ID

Also accepts the global flags.

deployments governance operations

List governance operation history, newest first.

deployments governance operations <organization-id>
FlagTypeRequiredDefaultDescription
--cursorstring (cursor)Pagination cursor
--page-sizestring (number)Page size
<organization-id>positionalyesOrganization ID
--kindstringOperation kind: audit-export, end-user-erasure, tenant-erasure, tenant-export, or thread-erasure
--statusstringOperation status: pending, running, completed, failed, or canceled

Also accepts the global flags.

On this page