Summary
Updates the config rule set of a JSON Golden Config tree version
Description
Updates the config rule set of a JSON Golden Config tree version
Route
PUT /configuration_manager/configurations/rules
Roles
admin
apiwrite
Parameters
DetailsExampleSchema
Name |
Type |
Required |
Description |
treeId |
string |
yes |
- |
version |
string |
yes |
- |
nodePath |
string |
yes |
- |
ruleSet |
object |
yes |
The json rule set to define for this tree. |
Copied to Clipboard
{
"treeId": "5c35355dbebaa82eaf8113f0",
"version": "v3",
"nodePath": "base/US East"
}
Copied to Clipboard
{
"type": "object",
"properties": {
"treeId": {
"title": "treeId",
"$ref": "common#/definitions/mongoObjectId"
},
"version": {
"title": "version",
"$ref": "goldenConfigData#/definitions/goldenConfigTreeVersionName"
},
"nodePath": {
"title": "nodePath",
"$ref": "goldenConfigData#/definitions/goldenConfigNodePath"
},
"ruleSet": {
"title": "ruleSet",
"type": "object",
"properties": {}
}
},
"required": [
"treeId",
"version",
"nodePath",
"ruleSet"
],
"additionalProperties": false
}
Return
DetailsExampleSchema
Name |
Type |
Description |
updateResult |
object |
status of the rule set update. |
Copied to Clipboard
{
"status": "success",
"message": "Rule Set successfully updated."
}
Copied to Clipboard
{
"title": "updateResult",
"type": "object",
"properties": {
"status": {
"type": "string",
"const": "success"
},
"message": {
"type": "string",
"examples": [
"Rule Set successfully updated."
]
}
}
}