Skip to Content
ReferenceAPI referenceSettings

Get the settings the web app needs

GET
/api/v1/settings

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.

Authorization

cookiesession<token>

Session cookie authentication.

Response Body

Request fulfilled, document follows

application/json
  1. response

The settings the web app reads to set itself up. No credentials appear here.

analytics*

How many days the database keeps each kind of data, and when it compresses it.

environment*string

APP_ENVIRONMENT, one of development, staging or production.

logparser*

The log ingestion settings.

map*

The map setup.

name*string
runtime*

Where the app runs.

version*string
Example Request
curl -X GET 'https://geometrikks.example.com/api/v1/settings'
Example Response200
{  "analytics": {    "compressionAfterDays": 0,    "debugRetentionDays": 0,    "hourlyRetentionDays": 0,    "rawRetentionDays": 0  },  "environment": "string",  "logparser": {    "logPaths": [      "string"    ],    "sendLogs": true,    "storeDebugLines": true  },  "map": {    "cartoApiKey": "string",    "defaultView": {      "latitude": 0,      "longitude": 0,      "zoom": 0    },    "esriApiKey": "string",    "serverLatitude": 0,    "serverLocationSource": "configured",    "serverLongitude": 0  },  "name": "string",  "runtime": {    "container": true,    "imageTag": "string"  },  "version": "string"}