2025-12-03 19:56:35 -03:00
|
|
|
# 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
|
|
|
|
|
|
2025-12-12 23:18:36 -03:00
|
|
|
Will use the standard botserver authentication mechanism with administrator-level permissions required.
|
2025-12-03 19:56:35 -03:00
|
|
|
|
|
|
|
|
## 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.
|
