Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Admin API

⚠️ Note: This API is not yet implemented and is planned for a future release.

The Admin API will provide endpoints for system administration, user management, and configuration management.

Planned Features

  • System configuration management
  • User and role administration
  • Bot lifecycle management
  • System health monitoring
  • Audit logging and compliance
  • Backup and restore operations

Base URL (Planned)

http://localhost:8080/api/v1/admin

Authentication

Will use the standard BotServer authentication mechanism with administrator-level permissions required.

Endpoints (Planned)

System Configuration

GET /api/v1/admin/config PUT /api/v1/admin/config

User Management

GET /api/v1/admin/users POST /api/v1/admin/users DELETE /api/v1/admin/users/{user_id}

Bot Management

GET /api/v1/admin/bots POST /api/v1/admin/bots/{bot_id}/restart DELETE /api/v1/admin/bots/{bot_id}

System Health

GET /api/v1/admin/health GET /api/v1/admin/metrics

Audit Logs

GET /api/v1/admin/audit

Implementation Status

This API is currently in the planning phase. Check back in future releases for availability.