For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Open sourceSupportFAQsDocs Home
DocumentationAPI referenceRelease notes
DocumentationAPI referenceRelease notes
  • Introduction
    • Overview
    • Authentication
  • Guides
    • Operations Manager search APIs
    • Search API
    • URL query parameters
    • Use query parameters in API requests
  • Reference
        • POSTAdd a new Golden Config tree
        • POSTAdd a new Golden Config tree
        • POSTAdd device groups to node
        • POSTAdd device(s) to a group
        • POSTAdd devices to node
        • POSTAdd new devices to the group
        • POSTAdd node(s) to a compliance plan
        • POSTAdd or remove a pinned item
        • POSTAdd tasks to node
        • POSTAlters a device configuration
        • POSTAlters a device configuration
        • POSTApply a device config
        • POSTApply a device config template
        • POSTBack up device configuration
        • POSTBuild a config spec from raw config
        • GETCall adapter method
        • GETCheck if CM is a maintenance version
        • GETCheck if device is connected
        • POSTCompliance reports totals for a backup
        • POSTCompliance reports totals for a device
        • POSTCompliance reports totals for a task instance
        • POSTConvert a config spec into a readable string
        • POSTConvert patch data to native config
        • POSTCreate a compliance plan
        • POSTCreate a config parser
        • POSTCreate a config spec
        • POSTCreate a device group
        • POSTCreate a device template
        • POSTCreate a JSON spec
        • POSTCreate a task instance
        • POSTCreate Golden Config node
        • DELDelete a config parser
        • DELDelete a Golden Config tree
        • DELDelete a Golden Config tree
        • DELDelete compliance plans
        • DELDelete device groups
        • DELDelete device groups
        • DELDelete device(s) from a group
        • DELDelete Golden Config node
        • DELDelete Golden Config trees
        • DELDelete one or more config parsers by ID
        • DELDelete one or more device backups by ID
        • DELDelete one or more device template(s) by ID
        • DELDelete one or more variables
        • DELDelete pinned items
        • DELDelete task instance(s)
        • DELDelete the cache for OS types
        • PUTDiff two strings from a lookup
        • POSTExport a Golden Config tree
        • GETFetch a compliance plan
        • POSTFetch all the devices that exist on a tree
        • POSTFetch OS types to store into the cache
        • GETFetch the OS types stored in the cache
        • POSTFind devices
        • POSTFind trees which contain the specified device
        • POSTGet a config parser
        • GETGet a config spec document
        • POSTGet a config spec template
        • POSTGet a device template
        • GETGet a JSON spec document
        • POSTGet a JSON spec document with inheritance
        • GETGet a list of all backed up devices
        • GETGet a list of all Golden Config trees
        • POSTGet a list of pinned items
        • POSTGet compliance check details
        • GETGet compliance report
        • GETGet compliance report metadata for a batch
        • GETGet compliance report metadata for a batch
        • GETGet compliance report node summary
        • POSTGet data for a specific adapter task
        • POSTGet data for all adapters with tasks
        • GETGet details of a Golden Config tree version
        • GETGet device backup
        • POSTGet device backup list
        • GETGet device configuration
        • GETGet device details
        • GETGet device group by ID
        • GETGet device group by name
        • GETGet device groups for a device
        • GETGet formatted device config
        • POSTGet graded compliance reports for a node
        • POSTGet historical graded compliance reports
        • POSTGet historical graded compliance reports
        • GETGet JSON compliance report
        • POSTGet operational data for a device
        • GETGet summary of a Golden Config tree
        • POSTGet summary of a Golden Config tree
        • POSTGet task instance(s)
        • POSTGet the top issues from compliance reports
        • POSTGet the top issues from JSON compliance reports
        • POSTGrade report
        • POSTImport backup documents
        • POSTImport compliance plan documents
        • POSTImport device config template documents
        • POSTImport device group documents
        • POSTImport Golden Config tree documents
        • POSTImport parser documents
        • GETList all config parsers
        • GETList all device groups
        • POSTList historical compliance reports
        • DELRemove device groups from node
        • DELRemove devices from a group
        • DELRemove devices from node
        • DELRemove node(s) from a compliance plan
        • DELRemove tasks from node
        • POSTRender a Jinja2 template
        • POSTRun a compliance plan
        • POSTRun a task instance
        • POSTRun an adapter task
        • POSTRun compliance reports
        • POSTRun compliance reports
        • POSTRun compliance reports on backups
        • POSTSearch all compliance plan instances
        • POSTSearch all compliance plans
        • POSTSearch all device groups
        • POSTSearch device groups
        • POSTSearch for task instance(s)
        • GETSummarize compliance reports for a tree
        • PUTUpdate a compliance plan
        • PUTUpdate a config parser
        • PUTUpdate a config spec
        • PUTUpdate a device backup by ID
        • PUTUpdate a device template
        • PUTUpdate a JSON spec
        • PUTUpdate a task instance
        • PUTUpdate device groups
        • PUTUpdate Golden Config node
        • PUTUpdate Golden Config rule set
        • PUTUpdate node configuration
        • PUTUpdate properties of a compliance plan instance
        • PUTUpdate properties of a Golden Config tree
        • PUTUpdate properties of a Golden Config tree version
LogoLogo
Open sourceSupportFAQsDocs Home
ReferenceConfiguration Manager

Search all compliance plan instances

POST
http://localhost:3000/configuration_manager/search/compliance_plan_instances
POST
/configuration_manager/search/compliance_plan_instances
$curl -X POST http://localhost:3000/configuration_manager/search/compliance_plan_instances \
>     -H "Content-Type: application/json" \
>     -u "<username>:<password>" \
>     -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          "startedBy": null,
16          "updated": "2025-03-31T17:38:53.096Z",
17          "updatedBy": null,
18          "finished": "2025-03-31T17:38:54.018Z",
19          "batchId": "67ead32d5f12757d048a48df",
20          "throttle": 5,
21          "nodes": [
22            {
23              "treeId": "67e301050e358ba47dcf79bd",
24              "version": "initial",
25              "nodeId": "67e301050e358ba47dcf79bc",
26              "status": "completed",
27              "variables": {},
28              "devices": [],
29              "deviceGroups": [],
30              "erroredDevices": [],
31              "processedDevices": []
32            }
33          ]
34        }
35      ]
36    }
37  ]
38}
Gets a list of all Compliance Plan Instances that match the search criteria.
Was this page helpful?
Previous

Search all compliance plans

Next
Built with

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