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 device groups

POST
http://localhost:3000/configuration_manager/deviceGroups/query
POST
/configuration_manager/deviceGroups/query
$curl -X POST http://localhost:3000/configuration_manager/deviceGroups/query \
>     -H "Content-Type: application/json" \
>     -u "<username>:<password>" \
>     -d '{}'
1{
2  "totalCount": 10,
3  "groups": [
4    {
5      "_id": "5c35355dbebaa82eaf8113f0",
6      "name": "Cisco Devices",
7      "description": "Common device group",
8      "devices": [
9        "xr9kv-atl"
10      ]
11    }
12  ]
13}
Returns device groups that match the specified input.
Was this page helpful?
Previous

Search for task instance(s)

Next
Built with

Authentication

AuthorizationBasic

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

Request

request body
namestringOptional
startdoubleOptional
limitdoubleOptional
optionsobjectOptional

Response

List of device groups that match the search criteria
totalCountdouble
groupslist of objects

Errors

500
Internal Server Error