Skip to content
BoilStream

Administration command reference

referencepreview
TL;DR

Find the administration command group for the task you need, then check help in the CLI version shipped with your server. Select the intended profile explicitly. Superadmin operations require the appropriate account, and destructive user or catalog changes need a reviewed target and dry run where supported.

Message sequenceThe CLI sends authenticated administration requests
The CLI sends authenticated administration requestsAn operator chooses a CLI profile and target, supplies authentication and submits an administration request. BoilStream checks permissions and returns the result; operators verify the resulting state.Operator / CLIBoilStreamSelect profile and endpointAuthenticated admin requestCheck permission and apply actionResult or errorRead resulting stateTime moves downward · dashed arrows are responsesThe CLI sends authenticated administration requestsAn operator chooses a CLI profile and target, supplies authentication and submits an administration request. BoilStream checks permissions and returns the result; operators verify the resulting state.Operator /CLIBoilStreamSelect profile andendpointAuthenticated adminrequestCheck permission andapply actionResult or errorRead resulting stateTime moves downward · dashed arrows are responses
Select the intended environment before running commands. A profile is connection configuration, not a separate server.
Jump to reference ↓

Catalogs and users

Section titled “Catalogs and users”

Catalog listing and creation require superadmin access. Supply the owner explicitly:

Shell
boilstream-admin catalog list
boilstream-admin catalog create --name events__stream --owner user@example.com \
  --description "Application events"
boilstream-admin catalog info CATALOG_ID
boilstream-admin catalog tables CATALOG_ID

Users obtain credentials under their own authorized profile:

Shell
boilstream-admin --profile work catalog credentials CATALOG_ID

Common superadmin user operations:

Shell
boilstream-admin user list
boilstream-admin user info user@example.com
boilstream-admin user sessions --user user@example.com

For deletion, first inspect boilstream-admin user delete --help and use --dry-run. Deleting a user can also delete owned catalogs and their data; choose the catalog action explicitly.

Tokens and sessions

Section titled “Tokens and sessions”
Shell
boilstream-admin --profile work token create --purpose ingest --topic-id 1
boilstream-admin --profile work auth session list
boilstream-admin --profile work auth session revoke SESSION_ID

Replace the topic ID with the ID of your target table. Use a token with the correct purpose for the interface. See Authentication.

Cluster and service health

Section titled “Cluster and service health”

These operations require administrative access:

Shell
boilstream-admin cluster status
boilstream-admin cluster brokers
boilstream-admin cluster health
boilstream-admin cp-metadata status

Use Cluster mode for availability and rolling-update requirements. Check boilstream-admin node --help and boilstream-admin leader --help before changing node state or leadership.

Hydration

Section titled “Hydration”

Operators can preload historical files for repeated queries:

Shell
boilstream-admin hydration table -d CATALOG_ID -t TABLE_NAME
boilstream-admin hydration list -d CATALOG_ID
boilstream-admin hydration stats

See Cold-tier hydration for status, cancellation and cache controls.

Local server process

Section titled “Local server process”
Shell
boilstream-admin server start --config local-dev.yaml
boilstream-admin server status
boilstream-admin server logs --follow
boilstream-admin server stop

These commands manage a local process. Use your orchestrator for a Kubernetes deployment. For upgrades, inspect boilstream-admin server upgrade --help and review a --dry-run before applying changes.

Other administration

Section titled “Other administration”

Use the matching command group and its --help:

Task Command group
Role assignments role
Cloud accounts cloud-account
S3 buckets s3-bucket
SAML providers saml
Schema discovery schema-registry

The Web Auth GUI provides browser-based administration.