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