Parameters
Management of the parameters included in configuration files.
Parameters Settings Model
Field |
Type |
Description |
Example |
Required |
|
String |
Path of the configuration file that includes the parameter. |
/opt/test.json |
True |
|
Enum(String)[json,yaml] |
Format of the configuration file where the parameter is included. |
yaml |
True |
|
List(String) |
List of keys to indicate the xpath in the configuration file. |
(‘agent’, ‘enabled’) |
True |
Parameters Output Model
Merge to Parameters Settings Model with the following model:
Field |
Type |
Description |
Example |
Required |
|
Any |
Parameter value. |
1.2 |
True |
Read
Read the data of all tbe available parameters with the following REST call:
- GET /parameters
without request body.
The output is a JSON dictionary with the following mappings:
key: Parameter ID;
value: Parameters Output Model.
Read a single parameter with the following REST call:
- GET /parameters/{string:id}
without the request body.
- Parameters:
id – indentifies the parameter to read.
- Response Headers:
Content-Type – application/json
The output is the Parameters Output Model in JSON format.
Update
To update the values of multiple parameters at the same time it is possible to use the following REST call:
- POST /parameters
with the request body as a JSON dictionary with the following mappings:
key: Parameter ID;
value: any possible value.
- Request Headers:
Content-Type – application/json
- Response Headers:
Content-Type – application/json
The output is the a JSON dictionary with the following mappings:
key: Parameter ID
value: Action Model
To update a single parameter use the following REST call:
- POST /parameters/{string:id}
with the request body as JSON dictionary of any possible value.
- Parameters:
id – indentifies the parameter to update.
- Request Headers:
Content-Type – application/json
- Response Headers:
Content-Type – application/json
The output is the Action Model in JSON format.
To update a single parameter inline without a request body use the following REST call:
- POST /parameters/{string:id}/{string:value}
without the request body.
- Parameters:
id – indentifies the parameter to update.
value – new value of the parameter.
- Response Headers:
Content-Type – application/json
The output is the Action Model in JSON format.