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