Summary
Import compliance plan documents
Description
Insert compliance plan documents into the ucm_compliance_plans collection
Route
POST /configuration_manager/import/plans
Roles
admin
apiwrite
Parameters
DetailsExampleSchema
Name |
Type |
Required |
Description |
plans |
array |
yes |
Array of compliance plans |
Copied to Clipboard
{
"plans": [
{
"_id": "ex eu",
"name": "aliquip",
"description": "mollit cupidatat",
"nodes": [
{
"treeId": "commodo",
"version": "non labore enim ea magna",
"nodeId": "esse in et est ea"
},
{
"treeId": "proident in cillum ipsum sint",
"version": "qui aliquip minim labore anim",
"nodeId": "sunt eu"
}
],
"gbac": {
"read": [
"63696917c49ecc7b03b5f02b"
],
"write": [
"63696917c49ecc7b03b5f02b",
"63696917c49ecc7b03b5f02b",
"63696917c49ecc7b03b5f02b"
]
}
},
{
"_id": "in Lorem ea",
"name": "nostrud",
"description": "ut velit id anim minim",
"nodes": [
{
"treeId": "minim non esse nisi",
"version": "reprehenderit anim quis Excepteur",
"nodeId": "non reprehenderit officia voluptate ea"
},
{
"treeId": "sunt",
"version": "nostrud consequat ipsum deserunt sit",
"nodeId": "est"
},
{
"treeId": "amet irure Lorem pariatur fugiat",
"version": "Ut Duis",
"nodeId": "enim Duis sunt"
},
{
"treeId": "amet dolor",
"version": "laboris veniam ut",
"nodeId": "Duis ullamco fugiat"
},
{
"treeId": "exercitation pariatur",
"version": "labore nisi eiusmod",
"nodeId": "dolore enim"
}
],
"gbac": {
"read": [
"63696917c49ecc7b03b5f02b",
"63696917c49ecc7b03b5f02b"
],
"write": [
"63696917c49ecc7b03b5f02b",
"63696917c49ecc7b03b5f02b"
]
}
},
{
"_id": "nostrud in",
"name": "nostrud consectetur",
"description": "nisi incididunt",
"nodes": [
{
"treeId": "ipsum cupidatat eiusmod voluptate Excepteur",
"version": "deserunt",
"nodeId": "exercitation labore do id mollit"
},
{
"treeId": "in aute reprehenderit ut aliquip",
"version": "est dolor Excepteur do aliquip",
"nodeId": "magna aute exercitation in"
},
{
"treeId": "culpa consequat laboris",
"version": "irure",
"nodeId": "minim pariatur qui"
},
{
"treeId": "ut deserunt ullamco voluptate ipsum",
"version": "proident",
"nodeId": "irure non"
},
{
"treeId": "dolore proident",
"version": "culpa qui occaecat",
"nodeId": "culpa sit"
}
],
"gbac": {
"read": [
"63696917c49ecc7b03b5f02b",
"63696917c49ecc7b03b5f02b"
],
"write": [
"63696917c49ecc7b03b5f02b",
"63696917c49ecc7b03b5f02b"
]
}
}
]
}
Copied to Clipboard
{
"type": "object",
"properties": {
"plans": {
"title": "plans",
"type": "array",
"items": {
"type": "object",
"properties": {
"_id": {
"type": "string",
"description": "The ID of the compliance plan."
},
"name": {
"type": "string",
"description": "The name of the compliance plan to import"
},
"description": {
"type": "string",
"description": "The description of the compliance plan to import"
},
"nodes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"treeId": {
"type": "string",
"description": "The treeId of the GC that the node belongs to."
},
"version": {
"type": "string",
"description": "The version of the GC tree that the node belongs to."
},
"nodeId": {
"type": "string",
"description": "The configId of the node."
},
"variables": {
"type": "object",
"example": "{ \"ipAddress\": \"1.2.3.4\" }"
}
}
}
},
"gbac": {
"type": "object",
"properties": {
"read": {
"type": "array",
"items": {
"type": "string",
"examples": [
"63696917c49ecc7b03b5f02b"
]
}
},
"write": {
"type": "array",
"items": {
"type": "string",
"examples": [
"63696917c49ecc7b03b5f02b"
]
}
}
}
}
}
}
}
},
"required": [
"plans"
],
"additionalProperties": false
}
Return
DetailsExampleSchema
Name |
Type |
Description |
status |
object |
Status of compliance plan import operation |
Copied to Clipboard
{
"status": "success",
"message": "culpa"
}
Copied to Clipboard
{
"title": "status",
"type": "object",
"properties": {
"status": {
"type": "string",
"const": "success"
},
"message": {
"type": "string",
"example": "2 compliance plan(s) imported successfully."
}
}
}