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"
],
"old": null,
"new": "new config line"
},
{
"parents": [
"parent line of config"
],
"old": "old config line",
"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": false,
"parents": [
"laborum deserunt",
"fugiat",
"pariatur ullamco consequat velit",
"irure sed qui",
"cupidatat ut ad"
],
"new": "laborum dolore in",
"old": "sint anim incididunt voluptate aliquip"
},
{
"result": true,
"parents": [
"ea officia",
"Duis irure qui commodo laboris",
"esse cupidatat reprehenderit",
"ipsum officia"
],
"new": "anim quis sed occaecat ut",
"old": "officia dolor"
},
{
"result": false,
"parents": [
"sit id"
],
"new": "dolore ad",
"old": "sunt elit"
},
{
"result": false,
"parents": [
"incididunt velit proident",
"aute veniam velit dolore dolor",
"eu in tempor"
],
"new": "dolor dolore exercitation",
"old": "in ullamco dolor"
},
{
"result": false,
"parents": [
"aliqua",
"laboris",
"cupidatat nisi",
"laboris sunt tempor",
"irure sit laboris"
],
"new": "veniam exercitation",
"old": "eu ea"
}
]
}
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"
}
}
}
}
}
}
