Free feature
Config groups¶
There are multiple ways to configure a sesam-node. One way is to add and modify single systems and pipes via these endpoints:
/api/pipes/{pipe_id}/config GET
/api/pipes/{pipe_id}/config PUT
/api/systems/{systems_id}/config GET
/api/systems/{systems_id}/config PUT
Another way is to upload the configuration for multiple systems and pipes as via these endpoints:
/api/config/{config-group} GET
/api/config/{config-group} PUT
Regardless of which endpoint is used, each pipe or system is placed in a config-group. For the first set of of endpoints the config-group is specified by adding a “$config-group”-property to the “metadata”-property in the configuration. Example:
{
"_id": "testpipe",
"type": "pipe",
"metadata": {
"$config-group": "my-first-group"
}
}
For the second set of endpoints the config-group is specified in the url. In either case, if no config-group is explicitly given, the pipe/system is placed in the “default” config-group (i.e. the /api/config PUT endpoint places the uploaded config into the “default” config-group).
Note: The /api/config PUT and /api/config/{config-group} PUT endpoints will replace all the config in the specified config-group.