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": "laboris non",
"name": "sint",
"description": "sint do",
"nodes": [
{
"treeId": "veniam in dolore adipisicing consequat",
"version": "non",
"nodeId": "in cillum eu et"
},
{
"treeId": "occaecat enim velit do consequat",
"version": "deserunt",
"nodeId": "anim pariatur"
},
{
"treeId": "est ad exercitation proident",
"version": "velit enim",
"nodeId": "do officia aliquip ad velit"
},
{
"treeId": "mollit esse incididunt",
"version": "magna Excepteur enim cupidatat occaecat",
"nodeId": "sunt nostrud sed"
},
{
"treeId": "nostrud voluptate laborum dolore",
"version": "do cupidatat occaecat Excepteur",
"nodeId": "enim"
}
],
"gbac": {
"read": [
"63696917c49ecc7b03b5f02b",
"63696917c49ecc7b03b5f02b",
"63696917c49ecc7b03b5f02b"
],
"write": [
"63696917c49ecc7b03b5f02b",
"63696917c49ecc7b03b5f02b",
"63696917c49ecc7b03b5f02b"
]
}
},
{
"_id": "aute in sed",
"name": "aute mollit Lorem est id",
"description": "sit ipsum dolore non eiusmod",
"nodes": [
{
"treeId": "nulla ut exercitation tempor",
"version": "dolore",
"nodeId": "sint"
}
],
"gbac": {
"read": [
"63696917c49ecc7b03b5f02b",
"63696917c49ecc7b03b5f02b"
],
"write": [
"63696917c49ecc7b03b5f02b",
"63696917c49ecc7b03b5f02b"
]
}
},
{
"_id": "dolore cupidatat sint sit eiusmod",
"name": "in culpa nisi laborum in",
"description": "cillum aute ut veniam",
"nodes": [
{
"treeId": "sit exercitation",
"version": "fugiat nostrud Ut cillum",
"nodeId": "officia consequat dolor"
},
{
"treeId": "dolor sit",
"version": "eu esse Duis",
"nodeId": "culpa tempor"
},
{
"treeId": "sint",
"version": "nulla",
"nodeId": "ipsum ut dolore Duis anim"
},
{
"treeId": "commodo aute Excepteur nostrud",
"version": "aute",
"nodeId": "cillum in ea ullamco"
}
],
"gbac": {
"read": [
"63696917c49ecc7b03b5f02b"
],
"write": [
"63696917c49ecc7b03b5f02b",
"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": "laboris sunt cillum in incididunt"
}
Copied to Clipboard
{
"title": "status",
"type": "object",
"properties": {
"status": {
"type": "string",
"const": "success"
},
"message": {
"type": "string",
"example": "2 compliance plan(s) imported successfully."
}
}
}