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",
"parent line of config",
"parent line of config",
"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": [
"sed fugiat anim"
],
"new": "in dolor eiusmod reprehenderit",
"old": "ea amet nulla"
},
{
"result": false,
"parents": [
"tempor",
"enim ut deserunt",
"quis enim qui",
"magna",
"eu"
],
"new": "fugiat eiusmod exercitation Excepteur",
"old": "nostrud"
},
{
"result": false,
"parents": [
"commodo in est",
"amet quis commodo cupidatat laborum",
"ut",
"do anim",
"labore qui et"
],
"new": "ea proident tempor quis",
"old": "dolore proident officia dolor aliqua"
},
{
"result": false,
"parents": [
"sint in commodo irure amet",
"veniam enim",
"eiusmod Duis consequat dolor ut",
"in",
"incididunt pariatur adipisicing irure ipsum"
],
"new": "sint incididunt ut qui id",
"old": "ea magna dolore irure"
},
{
"result": false,
"parents": [
"est sint"
],
"new": "Excepteur sunt officia",
"old": "consectetur labore fugiat"
}
]
}
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"
}
}
}
}
}
}
