2023-09-09 04:03:09 +00:00
|
|
|
# Administrator API: Server Statistics
|
|
|
|
|
|
|
|
|
|
The administrator API allows users with the proper privileges to get
|
|
|
|
|
information about how the server process is performing.
|
|
|
|
|
|
|
|
|
|
## API Endpoints
|
|
|
|
|
|
2023-11-08 16:21:20 +00:00
|
|
|
### **GET** `/_telodendria/admin/v1/stats`
|
2023-09-09 04:03:09 +00:00
|
|
|
|
|
|
|
|
Retrieve basic statistics about the currently running Telodendria
|
|
|
|
|
process.
|
|
|
|
|
|
|
|
|
|
| Requires Token | Rate Limited |
|
|
|
|
|
|----------------|--------------|
|
|
|
|
|
| Yes | Yes |
|
|
|
|
|
|
|
|
|
|
| Response Code | Description |
|
2023-09-09 04:11:32 +00:00
|
|
|
|---------------|-------------|
|
2023-09-09 04:03:09 +00:00
|
|
|
| 200 | The server statistics were successfully retrieved.|
|
|
|
|
|
|
|
|
|
|
#### 200 Response Format
|
|
|
|
|
|
|
|
|
|
| Field | Type | Description |
|
2023-09-09 04:11:32 +00:00
|
|
|
|-------|------|-------------|
|
2023-09-09 04:03:09 +00:00
|
|
|
| `memory_allocated` | `Integer` | The total amount of memory allocated, measured in bytes.|
|
|
|
|
|
| `version` | `String` | The current version of Telodendria.|
|
