Search all compliance plan instances

POST

https://example.itential.io/configuration_manager/search/compliance_plan_instances

POST

/configuration_manager/search/compliance_plan_instances

$ curl -X POST https://example.itential.io/configuration_manager/search/compliance_plan_instances \
>      -H "Content-Type: application/json" \
>      -u "<username>:<password>" \
>      -d '{}'

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

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

totalCountdoubleOptional

groupslist of anyOptional

Errors

500

Internal Server Error