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",
"parent line of config",
"parent line of config",
"parent line of config",
"parent line of config"
],
"old": null,
"new": null
}
]
}
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": false,
"parents": [
"ut enim nostrud consectetur",
"mollit",
"ex ea ipsum esse"
],
"new": "aliqua",
"old": "cillum anim"
},
{
"result": false,
"parents": [
"ipsum mollit deserunt",
"aliqua Lorem",
"elit et ut",
"adipisicing proident occaecat non"
],
"new": "irure aliquip nulla",
"old": "ex"
},
{
"result": true,
"parents": [
"cupidatat sunt dolor",
"cillum",
"dolore in Ut sit exercitation",
"proident eu",
"consequat sint et in id"
],
"new": "ullamco occaecat laboris",
"old": "voluptate ea amet consectetur sint"
},
{
"result": false,
"parents": [
"cillum aliquip est Excepteur in",
"laboris velit dolor Lorem est",
"est labore ex et",
"in aute",
"aute"
],
"new": "ad voluptate veniam",
"old": "ex reprehenderit irure anim velit"
}
]
}
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"
}
}
}
}
}
}