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": "old config line",
"new": "new config line"
},
{
"parents": [
"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": false,
"parents": [
"id",
"veniam",
"in commodo exercitation tempor non",
"incididunt sint"
],
"new": "laboris veniam magna et",
"old": "reprehenderit qui nisi"
},
{
"result": true,
"parents": [
"sed",
"in irure",
"officia laboris id Lorem consequat",
"sunt sed Ut in tempor",
"Excepteur labore"
],
"new": "incididunt exercitation in laboris",
"old": "labore"
},
{
"result": false,
"parents": [
"sit id ea",
"eu officia commodo"
],
"new": "labore",
"old": "exercitation irure eu proident ad"
},
{
"result": true,
"parents": [
"commodo consectetur Lorem labore",
"qui"
],
"new": "consequat minim non voluptate eiusmod",
"old": "sint consequat adipisicing minim"
}
]
}
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"
}
}
}
}
}
}
