Skip to content
GitLab

akili tenant

Manage tenants on the Akili platform. Every resource in the platform belongs to a tenant. Tenants provide isolation boundaries for data products, connections, and all associated resources.

List all tenants.

Examples:

Terminal window
# List all tenants
akili tenant list
# List as JSON
akili tenant list --json

Show detailed information about a specific tenant.

Arguments:

ArgumentTypeRequiredDescription
idstringyesTenant ID

Examples:

Terminal window
# Get tenant details
akili tenant get abc-123
# Get as JSON
akili tenant get abc-123 --json

Create a new tenant.

Arguments:

ArgumentTypeRequiredDescription
slugstringyesTenant slug (unique identifier, used in URLs and paths)

Flags:

FlagShortDefaultDescription
--display-nameslug valueHuman-readable display name
--tierstandardTenant tier: standard, premium, or enterprise

Examples:

Terminal window
# Create a tenant with defaults
akili tenant create acme-corp
# Create with display name and tier
akili tenant create acme-corp \
--display-name "Acme Corporation" \
--tier enterprise

Update an existing tenant. Only provided fields are updated.

Arguments:

ArgumentTypeRequiredDescription
idstringyesTenant ID

Flags:

FlagShortDefaultDescription
--display-nameNew display name
--tierNew tier

Examples:

Terminal window
# Update display name
akili tenant update abc-123 --display-name "Acme Corp International"
# Upgrade tier
akili tenant update abc-123 --tier premium

Suspend a tenant. Suspended tenants cannot run products or access data. Requires the --confirm flag.

Arguments:

ArgumentTypeRequiredDescription
idstringyesTenant ID

Flags:

FlagShortDefaultDescription
--confirmfalseConfirm the suspension (required)

Examples:

Terminal window
# Suspend a tenant
akili tenant suspend abc-123 --confirm

Reactivate a previously suspended tenant.

Arguments:

ArgumentTypeRequiredDescription
idstringyesTenant ID

Examples:

Terminal window
# Reactivate a suspended tenant
akili tenant reactivate abc-123

Archive (soft-delete) a tenant. Archived tenants are no longer accessible but data is retained. Requires the --confirm flag.

Arguments:

ArgumentTypeRequiredDescription
idstringyesTenant ID

Flags:

FlagShortDefaultDescription
--confirmfalseConfirm the archive operation (required)

Examples:

Terminal window
# Archive a tenant
akili tenant archive abc-123 --confirm