Global Properties

We rely a lot on the Global Properties - these are dynamic configurations of the app that can be updated without the restart. This is in contrast to static properties defined in docker-compose.yml.

You can store/update any dynamic property by calling this endpoint:

[your instance URL]/swagger-ui/index.html#/Global%20Settings%20(Properties)/putSingleNotEscaped

While you can create any global property with any name, this functionality is primarily intended to control how Peaksel behaves. Therefore creating properties to store custom information that Peaksel doesn’t understand isn’t recommended.

All Global Properties are visible to everyone who has access to the app, so don’t keep any sensitive info there.