Search device groups by device group name

This call returns device group information for device groups whose name starts with the string specified in the search request.

HTTP Method

GET

Request URI

/msa/v1/cps/rule?name=<name>&offset=<Offset>&limit=<Limit>

Request parameters

 

Parameter

Description

Sample Value

name

Required

Parameter Type: Query

Data Type: String

The prefix string of the device group name on which to perform the search. Not context sensitive. No records are returned if this parameter is blank.

iOS

Response fields

A list of device groups.

See Rules.

Example response

{
    "searchResults": [
        {
            "id": 38089, 
            "name": "rule1", 
            "description": "Rule 1 Description", 
            "definition": "PLATFORMTYPE EQ 'IOS'"
        }, 
        {
            "id": 38090, 
            "name": "rule2", 
            "description": "Rule 2 Description", 
            "definition": "CFDEVICE[nacCompliant] EQ 'false'"
        }
    ], 
    "results": 2, 
    "offset": 0, 
    "limit": 10
}