Settings
This page provides a description of the available API routes for managing settings.
Last updated
Was this helpful?
This page provides a description of the available API routes for managing settings.
Last updated
Was this helpful?
The API offers a range of modules and extensions that require configuration. In order to faciliate the process of module configuration, the API provides methods for accessing and managing stored configurations. These configurations are represented by a class.
Every module has its unique identifier, which is used as key when accessing given configuration section.
GET http://{server-address}/settings
Returns all stored settings. Result is of type Dictionary<string,>. The dictionary keys represents settings section keys.
Authorization*
string
Authorization header with authorization token.
GET http://{server-address}/settings/{key}
key*
string
The settings section identifier.
Authorization*
string
Authorization header with authorization token.
PUT http://{server-address}/settings/{key}
Required rights
No user rights are required.
key*
string
The settings section identifier.
Authorization*
string
Authorization header with authorization token.
(body)*
Settings
Settings object to store.
PATCH http://{server-address}/settings
Required rights
No user rights are required.
Authorization*
string
Authorization header with authorization token.
(body)*
Settings
Partial settings object to store.
DELETE http://{server-address}/settings/{key}
Required rights
No user rights are required.
name*
string
The settings section identifier.
Authorization*
string
Authorization header with authorization token.
Result is of type .
Updates existing or creates new settings section. The result of this operation is of type .
This method updates only a subset of the settings section. Any properties that are not present in the request body will remain unchanged. The result of this operation is of type .