Summary
Alters a device configuration
Description
Apply specified changes to a device configuration with additional options
Route
POST /configuration_manager/patch_device/advanced/:deviceName
Roles
admin
apiwrite
Parameters
DetailsExampleSchema
| Name |
Type |
Required |
Description |
| deviceName |
string |
yes |
- |
| changes |
array |
yes |
- |
| options |
object |
yes |
Additional parameters (optional) |
Copied to Clipboard
{
"changes": [
{
"parents": [
"parent line of config"
],
"old": "old config line",
"new": null
},
{
"parents": [
"parent line of config"
],
"old": "old config line",
"new": "new config line"
},
{
"parents": [
"parent line of config",
"parent line of config",
"parent line of config"
],
"old": null,
"new": null
},
{
"parents": [
"parent line of config",
"parent line of config"
],
"old": null,
"new": null
},
{
"parents": [
"parent line of config"
],
"old": null,
"new": "new config line"
}
],
"options": {
"backupDevice": false
}
}
Copied to Clipboard
{
"type": "object",
"properties": {
"changes": {
"title": "changes",
"type": "array",
"items": {
"type": "object",
"properties": {
"parents": {
"type": "array",
"items": {
"type": "string",
"examples": [
"parent line of config"
]
}
},
"old": {
"anyOf": [
{
"const": null
},
{
"type": "string"
}
],
"examples": [
"old config line",
null
]
},
"new": {
"anyOf": [
{
"const": null
},
{
"type": "string"
}
],
"examples": [
"new config line",
null
]
}
}
}
},
"options": {
"title": "options",
"type": "object",
"properties": {
"backupDevice": {
"type": "boolean"
}
}
}
},
"required": [
"changes",
"options"
],
"additionalProperties": false
}
Return
DetailsExampleSchema
| Name |
Type |
Description |
| patchResult |
object |
Direct reponse from the origin's adapter |
Copied to Clipboard
{
"response": [
{
"result": false,
"parents": [
"veniam consequat ad incididunt commodo",
"quis"
],
"new": "velit sed ut Lorem",
"old": "tempor dolore est"
},
{
"result": true,
"parents": [
"nisi ullamco",
"dolore magna labore",
"sunt laborum"
],
"new": "dolor mollit dolore anim",
"old": "irure dolor"
},
{
"result": true,
"parents": [
"irure",
"labore officia ad",
"exercitation fugiat amet qui"
],
"new": "officia ex do mollit laboris",
"old": "nostrud dolore qui"
},
{
"result": false,
"parents": [
"ea occaecat ipsum incididunt anim",
"deserunt"
],
"new": "deserunt laborum in",
"old": "eiusmod anim"
}
]
}
Copied to Clipboard
{
"title": "patchResult",
"type": "object",
"properties": {
"response": {
"type": "array",
"items": {
"type": "object",
"properties": {
"result": {
"type": "boolean"
},
"parents": {
"type": "array",
"items": {
"type": "string"
}
},
"new": {
"type": "string"
},
"old": {
"type": "string"
}
}
}
}
}
}
