Skip to main content
API keys provide programmatic access to BotMux without session cookies.

Format

Keys use the bmx_ prefix: bmx_a1b2c3d4e5f6...

Usage

curl -H "Authorization: Bearer bmx_your_key_here" \
  http://localhost:8080/api/bots

Management

Admin-only via the web UI or API:
MethodEndpointDescription
GET/api/auth/api-keysList all API keys
POST/api/auth/api-keys/createCreate a new key
POST/api/auth/api-keys/disableDisable a key
POST/api/auth/api-keys/deleteDelete a key

Security

  • Keys are bound to users and inherit their role and permissions
  • Stored as SHA-256 hash in the database
  • The actual key is only shown once at creation time