Search all compliance plan instances

POST

http://localhost:3000/configuration_manager/search/compliance_plan_instances

POST

/configuration_manager/search/compliance_plan_instances

1 curl -X POST http://localhost:3000/configuration_manager/search/compliance_plan_instances \
2      -H "Content-Type: application/json" \
3      -u "<username>:<password>" \
4      -d '{}'

1 {
2   "totalCount": 10,
3   "groups": [
4     {
5       "totalCount": 3,
6       "plans": [
7         {
8           "id": "67ead32c5f12757d048a48de",
9           "name": "Cisco IOS",
10           "description": "",
11           "jobStatus": "complete",
12           "planId": "67ead2e85f12757d048a48dd",
13           "jobId": "93e9aafa34e24e81953dae00",
14           "started": "2025-03-31T17:38:53.096Z",
15           "updated": "2025-03-31T17:38:53.096Z",
16           "finished": "2025-03-31T17:38:54.018Z",
17           "batchId": "67ead32d5f12757d048a48df",
18           "throttle": 5,
19           "nodes": [
20             {
21               "treeId": "67e301050e358ba47dcf79bd",
22               "version": "initial",
23               "nodeId": "67e301050e358ba47dcf79bc",
24               "status": "completed",
25               "variables": {},
26               "devices": [],
27               "deviceGroups": [],
28               "erroredDevices": [],
29               "processedDevices": []
30             }
31           ]
32         }
33       ]
34     }
35   ]
36 }

Gets a list of all Compliance Plan Instances that match the search criteria.

Authentication

AuthorizationBasic

Basic authentication of the form Basic <base64(username:password)>.

Request

request body

searchParamsanyOptional

Response

List of Compliance Plan Instances that match the search criteria

totalCountdouble

groupslist of any

Errors

500

Internal Server Error