Summary
Alters a device configuration
Description
Apply specified changes to a device configuration
Route
POST /configuration_manager/patch_device/:deviceName
Roles
admin
apiwrite
Parameters
DetailsExampleSchema
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": 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
DetailsExampleSchema
Name |
Type |
Description |
patchResult |
object |
Direct reponse from the origin's adapter |
Copied to Clipboard
{
"response": [
{
"result": true,
"parents": [
"ad eiusmod velit",
"exercitation consequat est laboris",
"proident officia do Lorem"
],
"new": "nulla ea sunt laborum irure",
"old": "sunt adipisicing Excepteur"
},
{
"result": true,
"parents": [
"est ipsum",
"ut exercitation esse in magna",
"consectetur fugiat nisi",
"irure voluptate exercitation magna eu",
"consectetur labore nisi ipsum sit"
],
"new": "sunt nostrud nulla aliquip",
"old": "aliqua"
},
{
"result": false,
"parents": [
"ad",
"ipsum tempor sunt sed mollit",
"aliquip"
],
"new": "eiusmod eu",
"old": "veniam pariatur tempor consectetur sunt"
},
{
"result": false,
"parents": [
"adipisicing proident sunt",
"ullamco do ea Ut",
"sed aute laboris cillum veniam",
"proident quis do"
],
"new": "occaecat et in",
"old": "in ea qui sit"
}
]
}
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"
}
}
}
}
}
}