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