Deployments.ai Docs
Command reference

deployments system

Install operator status for platform administrators

CommandSummary
deployments system installationShow the deployed release, account, endpoints, and observability data locations
deployments system deploymentsList recorded deployments, newest first
deployments system componentsShow ECS service and Lambda function health for the install
deployments system alarmsList the install's CloudWatch alarms
deployments system model-providersShow model provider key metadata
deployments system organizationsList every organization in the install
deployments system standingShow an organization's holds, grants, data boundary, and effective entitlements
deployments system standing-historyList an organization's hold and grant changes, newest first
deployments system spendShow an organization's spend in a month, split by who paid
deployments system holdPlace an operator hold on an organization
deployments system releaseRelease an operator hold on an organization
deployments system set-entitlementsReplace the operator's entitlement grant; omitted fields fall to other sources
deployments system clear-entitlementsRemove the operator's entitlement grant
deployments system set-data-boundaryLimit where an organization's data can go; only operators can set it
deployments system clear-data-boundaryRemove an organization's data boundary
deployments system set-principal-statusDisable a person, which ends their sessions, or re-enable them
deployments system access-openOpen or renew your operator access to an organization's data
deployments system access-closeClose your operator access to an organization
deployments system access-showShow your operator access to an organization
deployments system access-listList open operator access across the install
deployments system people findFind the person or pending sign-up holding an email; matches the whole address
deployments system people showShow a person's organizations, multi-factor state, and session counts
deployments system people eventsList a person's security events, newest first; secret fields are withheld
deployments system people revoke-sessionsEnd every session, refresh token, and device grant without disabling the person
deployments system people resend-verificationResend a pending sign-up's verification email, under the self-service limits

deployments system installation

Show the deployed release, account, endpoints, and observability data locations.

deployments system installation

Also accepts the global flags.

deployments system deployments

List recorded deployments, newest first.

deployments system deployments
  • Calls GET /v1/system/deployments (SDK listSystemDeployments).
  • No tenancy context required.
  • 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 system components

Show ECS service and Lambda function health for the install.

deployments system components

Also accepts the global flags.

deployments system alarms

List the install's CloudWatch alarms.

deployments system alarms
  • Calls GET /v1/system/alarms (SDK listSystemAlarms).
  • No tenancy context required.
  • 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
--stateALARM | INSUFFICIENT_DATA | OKOnly alarms currently in this state

Also accepts the global flags.

deployments system model-providers

Show model provider key metadata.

deployments system model-providers

Also accepts the global flags.

deployments system organizations

List every organization in the install.

deployments system organizations
  • Calls GET /v1/system/organizations (SDK listSystemOrganizations).
  • No tenancy context required.
  • 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 system standing

Show an organization's holds, grants, data boundary, and effective entitlements.

deployments system standing <organization-id>
FlagTypeRequiredDefaultDescription
<organization-id>positionalyesOrganization ID

Also accepts the global flags.

deployments system standing-history

List an organization's hold and grant changes, newest first.

deployments system standing-history <organization-id>
FlagTypeRequiredDefaultDescription
--cursorstring (cursor)Pagination cursor
--page-sizestring (number)Page size
<organization-id>positionalyesOrganization ID

Also accepts the global flags.

deployments system spend

Show an organization's spend in a month, split by who paid.

deployments system spend <organization-id>
FlagTypeRequiredDefaultDescription
<organization-id>positionalyesOrganization ID
--monthstringUTC month as YYYY-MM; defaults to the current month

Also accepts the global flags.

deployments system hold

Place an operator hold on an organization.

deployments system hold <organization-id> <hold-key> --reason payment --customer-message <customer-message>
FlagTypeRequiredDefaultDescription
<organization-id>positionalyesOrganization ID
<hold-key>positionalyesHold key: lowercase letters, digits, and hyphens
--reasonpayment | abuse | policy | manualyesWhy the organization is held
--customer-messagestringyesShown to the organization's members
--operator-notestringSeen only by operators and services

Also accepts the global flags.

deployments system release

Release an operator hold on an organization.

deployments system release <organization-id> <hold-key>
FlagTypeRequiredDefaultDescription
<organization-id>positionalyesOrganization ID
<hold-key>positionalyesHold key: lowercase letters, digits, and hyphens
--release-notestringWhy the hold is released; recorded in the history

Also accepts the global flags.

deployments system set-entitlements

Replace the operator's entitlement grant; omitted fields fall to other sources.

deployments system set-entitlements <organization-id>
FlagTypeRequiredDefaultDescription
<organization-id>positionalyesOrganization ID
--tenant-limitsstring (json)Tenant limits, such as {"concurrentRuns":32}
--model-spend-ceilingstring (json)"unlimited" or {"monthlyUsdMicros":100000000}

Also accepts the global flags.

deployments system clear-entitlements

Remove the operator's entitlement grant.

deployments system clear-entitlements <organization-id>
FlagTypeRequiredDefaultDescription
<organization-id>positionalyesOrganization ID

Also accepts the global flags.

deployments system set-data-boundary

Limit where an organization's data can go; only operators can set it.

deployments system set-data-boundary --profile phi <organization-id> --operator-note <operator-note>
FlagTypeRequiredDefaultDescription
--profilephiyesphi keeps tools off the public internet and models on Bedrock
<organization-id>positionalyesOrganization ID
--operator-notestringyesWhy, such as the agreement reference; never shown to members

Also accepts the global flags.

deployments system clear-data-boundary

Remove an organization's data boundary.

deployments system clear-data-boundary <organization-id> --operator-note <operator-note>
FlagTypeRequiredDefaultDescription
<organization-id>positionalyesOrganization ID
--operator-notestringyesWhy the boundary ends; recorded in the history

Also accepts the global flags.

deployments system set-principal-status

Disable a person, which ends their sessions, or re-enable them.

deployments system set-principal-status <principal-id> --status active --reason <reason>
FlagTypeRequiredDefaultDescription
<principal-id>positionalyesPrincipal ID of the person
--statusactive | disabledyesdisabled or active
--reasonstringyesWhy the status changes; recorded in the person's security events

Also accepts the global flags.

deployments system access-open

Open or renew your operator access to an organization's data.

deployments system access-open <organization-id> --reason <reason>
FlagTypeRequiredDefaultDescription
<organization-id>positionalyesOrganization ID
--reasonstringyesWhy you need the data; shown in the organization's audit log
--ticketstringSupport ticket or case reference
--duration-minutesstring (number)Minutes until access expires; defaults to 60, at most 480

Also accepts the global flags.

deployments system access-close

Close your operator access to an organization.

deployments system access-close <organization-id>
FlagTypeRequiredDefaultDescription
<organization-id>positionalyesOrganization ID

Also accepts the global flags.

deployments system access-show

Show your operator access to an organization.

deployments system access-show <organization-id>
FlagTypeRequiredDefaultDescription
<organization-id>positionalyesOrganization ID

Also accepts the global flags.

deployments system access-list

List open operator access across the install.

deployments system access-list
  • Calls GET /v1/system/operator-access (SDK listSystemOperatorAccess).
  • No tenancy context required.
  • 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
--organization-idstringOnly access to this organization

Also accepts the global flags.

deployments system people find

Find the person or pending sign-up holding an email; matches the whole address.

deployments system people find --email <email>
FlagTypeRequiredDefaultDescription
--emailstringyesThe whole email address

Also accepts the global flags.

deployments system people show

Show a person's organizations, multi-factor state, and session counts.

deployments system people show <principal-id>
FlagTypeRequiredDefaultDescription
<principal-id>positionalyesPrincipal ID of the person

Also accepts the global flags.

deployments system people events

List a person's security events, newest first; secret fields are withheld.

deployments system people events <principal-id>
FlagTypeRequiredDefaultDescription
--cursorstring (cursor)Pagination cursor
--page-sizestring (number)Page size
<principal-id>positionalyesPrincipal ID of the person

Also accepts the global flags.

deployments system people revoke-sessions

End every session, refresh token, and device grant without disabling the person.

deployments system people revoke-sessions <principal-id> --reason <reason>
FlagTypeRequiredDefaultDescription
<principal-id>positionalyesPrincipal ID of the person
--reasonstringyesWhy the sessions end; recorded in the person's security events

Also accepts the global flags.

deployments system people resend-verification

Resend a pending sign-up's verification email, under the self-service limits.

deployments system people resend-verification <principal-id> --reason <reason>
FlagTypeRequiredDefaultDescription
<principal-id>positionalyesPrincipal ID of the person
--emailstringThe email the sign-up waits on, from system people find
--reasonstringyesWhy the email is resent; recorded in the person's security events

Also accepts the global flags.

On this page