Application and Host Status
Use these requests to monitor Alta from your own monitoring system. Both requests are available to the admin and observer roles.
Application Information
Section titled “Application Information”GET /api/aboutExample:
curl -sS -H "Authorization: Bearer $TOKEN" 'http://alta.example.com:8100/api/about'Response:
{ "service_name": "alta", "version": { "version": "261020", "commit": "349de372", "build": 1638139770 }, "runtime": { "instance_id": "8b1f6c3e-6a52-4c0e-9d1a-5f2f2a0c9e11", "uptime": 86400 }}- service_name: Name of the service.
- version: Version, commit, and build of Alta.
- runtime.instance_id: Unique identifier of the Alta instance.
- runtime.uptime: Application uptime in seconds.
Host and Storage Status
Section titled “Host and Storage Status”GET /api/statusResponse:
{ "host": { "cpu": { "usage_percent": 12.5, "load_avg": [0.4, 0.5, 0.6], "cores": 8 }, "mem": { "total_bytes": 16777216000, "used_bytes": 4294967296, "available_bytes": 12482248704 } }, "storages": [ { "name": "archive", "path": "/var/lib/alta/archive", "total_bytes": 1000000000000, "used_bytes": 250000000000, "free_bytes": 750000000000 } ]}- host.cpu: CPU usage in percent, load average for 1, 5, and 15 minutes, and number of cores.
- host.mem: Total, used, and available memory in bytes.
- storages: Name, path, and total, used, and free space in bytes of the disk for each Storage.