Skip to Content
ReferenceAPI referenceSystem

Get every setting with its environment variable

GET
/api/v1/system/settings

Returns the whole configuration in sections, with each setting's value, default, description and environment variable. A secret that is set shows as ****** and one that is not shows as null. Some rows add a value worked out at runtime, such as the auto-detected server location.

Authorization

cookiesession<token>

Session cookie authentication.

Response Body

Request fulfilled, document follows

application/json
  1. response

Every setting, grouped into sections, with secrets hidden.

sections*array<>
Example Request
curl -X GET 'https://geometrikks.example.com/api/v1/system/settings'
Example Response200
{  "sections": [    {      "description": "string",      "fields": [        {          "computedSource": "string",          "computedValue": null,          "default": null,          "description": "string",          "envVar": "string",          "isSecret": true,          "key": "string",          "value": null        }      ],      "name": "string",      "title": "string"    }  ]}