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": null
},
{
"parents": [
"parent line of config",
"parent line of config",
"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": [
"aute eu ea",
"consequat",
"proident quis Lorem magna"
],
"new": "ut amet",
"old": "pariatur ut"
},
{
"result": false,
"parents": [
"veniam sed do",
"tempor voluptate anim dolor aute",
"aute laborum nulla"
],
"new": "eiusmod aute",
"old": "nostrud aliquip voluptate anim eu"
},
{
"result": false,
"parents": [
"adipisicing laboris magna",
"in",
"in sunt sint",
"exercitation in consectetur ut culpa",
"sint ut"
],
"new": "non anim adipisicing Lorem dolor",
"old": "ullamco"
},
{
"result": true,
"parents": [
"cupidatat in ut laborum",
"anim",
"officia voluptate do aliquip nostrud"
],
"new": "consectetur",
"old": "officia ut mollit"
}
]
}
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"
}
}
}
}
}
}
