Skip to Content
ReferenceAPI referenceSystem

Get the database size, retention and table stats

GET
/api/v1/system/database

Returns the database size, the PostgreSQL and TimescaleDB versions, the retention days, and row and size estimates for the geo_events, access_logs and access_log_debug tables. With the database unreachable it still answers 200, with reachable false and the stats null or empty.

Authorization

cookiesession<token>

Session cookie authentication.

Response Body

Request fulfilled, document follows

application/json
  1. response

Database size, versions, retention and table stats for the Status page.

debugRetentionDays*integer

Days to keep the access log debug lines.

hypertables*array<>

Empty when the database is unreachable.

postgresVersion*string|null
reachable*boolean
retentionDays*integer

Days to keep raw geo events and access log lines.

sizeBytes*|

The whole database on disk, in bytes.

timescaledbVersion*string|null
Example Request
curl -X GET 'https://geometrikks.example.com/api/v1/system/database'
Example Response200
{  "debugRetentionDays": 0,  "hypertables": [    {      "afterCompressionBytes": 0,      "approxRows": 0,      "beforeCompressionBytes": 0,      "name": "string",      "totalBytes": 0    }  ],  "postgresVersion": "string",  "reachable": true,  "retentionDays": 0,  "sizeBytes": 0,  "timescaledbVersion": "string"}

Get the caller's IP address GET

Returns the address this server sees for the request, so a client can filter out its own traffic. Behind a reverse proxy, it is the real address only when the proxy is in APP_TRUSTED_PROXIES. `behindUntrustedProxy` is true when it is not.

Get the newest release above the running version GET

Reports the last check against GitHub Releases. `status` is `off` with APP_UPDATE_CHECK=false, with SCHEDULER_ENABLED=false, on agents and on local builds. This endpoint never calls GitHub itself.