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"
],
"old": "old config line",
"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": true,
"parents": [
"incididunt reprehenderit minim",
"sed deserunt",
"ut ipsum consectetur",
"occaecat aute pariatur",
"sed"
],
"new": "proident",
"old": "in"
},
{
"result": false,
"parents": [
"consequat",
"est in nisi labore consequat",
"ullamco nostrud elit dolor",
"in",
"nisi"
],
"new": "exercitation cillum Ut",
"old": "Duis in ea laborum laboris"
},
{
"result": false,
"parents": [
"ea dolore",
"ad qui irure tempor Ut",
"dolore est proident cillum anim",
"Lorem sint dolor culpa",
"anim dolor ut"
],
"new": "proident",
"old": "Ut reprehenderit dolore velit"
},
{
"result": true,
"parents": [
"pariatur amet",
"dolor"
],
"new": "in do ex sunt amet",
"old": "velit commodo in Lorem do"
},
{
"result": false,
"parents": [
"labore",
"minim",
"sunt minim dolor",
"magna nisi in enim",
"quis"
],
"new": "in reprehenderit",
"old": "voluptate occaecat non veniam"
}
]
}
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"
}
}
}
}
}
}
