Summary
Import device group documents
Description
Insert device group documents into the device_groups collection
Route
POST /configuration_manager/import/groups
Roles
admin
apiwrite
Parameters
DetailsExampleSchema
| Name |
Type |
Required |
Description |
| groups |
array |
yes |
Array of device groups |
Copied to Clipboard
{
"groups": [
{
"name": "my standard name",
"description": "my standard description",
"devices": [
"xr9kv-atl",
"xr9kv-atl",
"xr9kv-atl",
"xr9kv-atl"
]
}
]
}
Copied to Clipboard
{
"type": "object",
"properties": {
"groups": {
"title": "groups",
"type": "array",
"items": {
"$ref": "deviceGroupDocument#/definitions/groupDetails"
}
}
},
"required": [
"groups"
],
"additionalProperties": false
}
Return
DetailsExampleSchema
| Name |
Type |
Description |
| status |
object |
Status of group import operation |
Copied to Clipboard
{
"status": "success",
"message": "occaecat pariatur incididunt"
}
Copied to Clipboard
{
"title": "status",
"type": "object",
"properties": {
"status": {
"type": "string",
"const": "success"
},
"message": {
"type": "string",
"example": "2 device groups imported successfully"
}
}
}
