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": null,
"new": "new config line"
},
{
"parents": [
"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": [
"amet reprehenderit proident"
],
"new": "laborum ad minim",
"old": "anim aliquip incididunt laboris"
},
{
"result": false,
"parents": [
"eu Duis",
"ut ea cillum magna nulla",
"labore sed"
],
"new": "dolore Duis laboris",
"old": "ex et est dolor"
},
{
"result": true,
"parents": [
"incididunt labore ut sint",
"commodo dolor esse irure in",
"commodo laborum dolore",
"ullamco",
"irure eu"
],
"new": "eiusmod",
"old": "laborum nulla"
},
{
"result": true,
"parents": [
"in eu est",
"do laborum",
"eu sed irure",
"sed officia cupidatat consequat"
],
"new": "fugiat",
"old": "adipisicing"
}
]
}
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"
}
}
}
}
}
}
