Summary
Alters a device configuration
Description
Apply specified changes to a device configuration with additional options
Route
POST /configuration_manager/patch_device/advanced/:deviceName
Roles
admin
apiwrite
Parameters
Details Example Schema
Name
Type
Required
Description
deviceName
string
yes
-
changes
array
yes
-
options
object
yes
Additional parameters (optional)
Copied to Clipboard
{
"changes": [
{
"parents": [
"parent line of config",
"parent line of config",
"parent line of config"
],
"old": "old config line",
"new": "new config line"
}
],
"options": {
"backupDevice": true
}
}
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
]
}
}
}
},
"options": {
"title": "options",
"type": "object",
"properties": {
"backupDevice": {
"type": "boolean"
}
}
}
},
"required": [
"changes",
"options"
],
"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": [
"occaecat amet aliquip laboris",
"irure magna cillum ipsum",
"qui adipisicing velit do reprehenderit"
],
"new": "non do in",
"old": "dolore Excepteur"
},
{
"result": true,
"parents": [
"Excepteur id tempor dolor",
"proident",
"ad aute veniam",
"officia minim labore",
"exercitation labore id dolor pariatur"
],
"new": "tempor",
"old": "dolor pariatur cillum Duis"
},
{
"result": false,
"parents": [
"cupidatat qui elit",
"id in Lorem",
"fugiat",
"Ut"
],
"new": "in nulla Excepteur ut veniam",
"old": "nulla minim"
},
{
"result": false,
"parents": [
"veniam adipisicing"
],
"new": "qui elit dolor occaecat dolor",
"old": "in nisi in amet incididunt"
},
{
"result": true,
"parents": [
"veniam cillum anim reprehenderit in",
"reprehenderit veniam amet eu"
],
"new": "laborum aliquip veniam dolore",
"old": "id esse"
}
]
}
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"
}
}
}
}
}
}
