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"
],
"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": true,
"parents": [
"veniam proident cillum voluptate commodo",
"ex eu ullamco deserunt",
"dolor"
],
"new": "qui sed",
"old": "ea"
},
{
"result": true,
"parents": [
"incididunt tempor velit elit commodo"
],
"new": "elit consequat Lorem",
"old": "culpa dolore non commodo"
},
{
"result": false,
"parents": [
"dolor",
"labore Excepteur",
"minim dolore ad velit",
"incididunt amet ea nisi dolor"
],
"new": "ad",
"old": "deserunt nulla fugiat veniam"
},
{
"result": true,
"parents": [
"ad",
"irure anim Ut"
],
"new": "deserunt exercitation dolore",
"old": "proident pariatur magna"
},
{
"result": true,
"parents": [
"dolore sint",
"cupidatat in commodo irure sed",
"quis tempor aliquip veniam"
],
"new": "ut cupidatat",
"old": "anim id in"
}
]
}
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"
}
}
}
}
}
}