Skip to Content
ReferenceAPI referenceSystem

Get version, runtime and database details

GET
/api/v1/system/about

Returns the app version and image, the Python and library versions, the PostgreSQL, TimescaleDB and PostGIS versions, the schema migration, and the state of the GeoLite2 databases and DROP lists. When the database is unreachable, every database field is null except migrationHead, the newest migration this build ships.

Authorization

cookiesession<token>

Session cookie authentication.

Response Body

Request fulfilled, document follows

application/json
  1. response

Version, runtime and database details for the About page.

geoip describes the GeoLite2 City database and geoipAsn the ASN database. dropLists is null with DROP_ENABLED=false, or when the database cannot answer.

app*

The running app.

asnClassification?|null
database*

The database server, its extensions and the schema version.

Everything except migrationHead is null when the database is unreachable.

dropLists?|null
geoip*

A GeoLite2 database file.

geoipAsn?|null
geoipAsnEnabled?boolean

Whether ASN lookups are on. With it false, geoipAsn may still describe a file.

Defaultfalse
links*

Links to the GeoMetrikks repository and its issue tracker.

runtime*

The Python runtime and the versions of key libraries.

Example Request
curl -X GET 'https://geometrikks.example.com/api/v1/system/about'
Example Response200
{  "app": {    "changelogDigest": "string",    "commit": "string",    "container": true,    "environment": "string",    "imageTag": "string",    "name": "string",    "startedAt": "2019-08-24T14:15:22Z",    "version": "string"  },  "asnClassification": {    "dataset": "string",    "entries": 0,    "license": "string",    "sourceUrl": "string"  },  "database": {    "migrationHead": "string",    "migrationName": "string",    "migrationRevision": "string",    "postgisVersion": "string",    "postgresVersion": "string",    "timescaledbVersion": "string"  },  "dropLists": {    "copyright": "string",    "enabled": true,    "feeds": [      {        "checkedAt": "2019-08-24T14:15:22Z",        "feed": "string",        "fetchedAt": "2019-08-24T14:15:22Z",        "lastError": "string",        "recordCount": 0,        "upstreamTimestamp": "2019-08-24T14:15:22Z"      }    ],    "loaded": true,    "stale": true,    "termsUrl": "string",    "updatedAt": "2019-08-24T14:15:22Z"  },  "geoip": {    "ageDays": 0,    "available": true,    "buildDate": "2019-08-24T14:15:22Z",    "dbPath": "string"  },  "geoipAsn": {    "ageDays": 0,    "available": true,    "buildDate": "2019-08-24T14:15:22Z",    "dbPath": "string"  },  "geoipAsnEnabled": false,  "links": {    "issues": "string",    "repository": "string"  },  "runtime": {    "apschedulerVersion": "string",    "litestarVersion": "string",    "pythonVersion": "string"  }}

Get the settings the web app needs GET

Returns the app name and version, the retention days, the access log paths and the map setup. Use `/api/v1/system/settings` for every setting with its environment variable.

List the ASNs that count as hosting providers GET

Returns the bundled list that puts an ASN in the hosting category on the ASN views, with its source and license. The whole list comes in one response.