Summary
Alters a device configuration
Description
Apply specified changes to a device configuration
Route
POST /configuration_manager/patch_device/:deviceName
Roles
admin
apiwrite
Parameters
Details Example Schema
Name
Type
Required
Description
deviceName
string
yes
-
changes
array
yes
-
Copied to Clipboard
{
"changes": [
{
"parents": [
"parent line of config",
"parent line of config"
],
"old": null,
"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": "new config line"
},
{
"parents": [
"parent line of config"
],
"old": "old config line",
"new": "new config line"
}
]
}
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
]
}
}
}
}
},
"required": [
"changes"
],
"additionalProperties": false
}
Return
Details Example Schema
Name
Type
Description
patchResult
object
Direct reponse from the origin's adapter
Copied to Clipboard
{
"response": [
{
"result": true,
"parents": [
"ullamco",
"aute",
"aliquip ut velit minim",
"Ut quis laborum nostrud sint",
"non pariatur magna"
],
"new": "dolor",
"old": "deserunt cupidatat"
},
{
"result": true,
"parents": [
"laboris",
"irure Lorem ut id laboris",
"nisi est amet Duis sint",
"culpa in fugiat in incididunt",
"cupidatat Duis qui"
],
"new": "aute anim amet",
"old": "non ipsum in Excepteur ut"
},
{
"result": true,
"parents": [
"enim",
"enim eu est consequat",
"sunt nisi ex voluptate",
"pariatur"
],
"new": "quis esse",
"old": "pariatur sunt cillum magna"
},
{
"result": true,
"parents": [
"sit voluptate",
"sit",
"in consequat",
"voluptate fugiat et officia Duis"
],
"new": "sunt sint",
"old": "ex proident cillum"
},
{
"result": false,
"parents": [
"laboris Duis",
"in nostrud anim magna",
"dolor laborum dolor",
"dolore",
"magna sed veniam proident"
],
"new": "adipisicing do consectetur",
"old": "eu in eiusmod"
}
]
}
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"
}
}
}
}
}
}
