List all devices in a group

get/compute-ops-mgmt/v1/groups/{group-id}/devices

List all devices in a group

SecurityBearer
Request
path Parameters
group-id
required
string <uuid>
query Parameters
filter
string

Limit the resources operated on by an endpoint or when used with a multiple-GET endpoint, return only the subset of resources that match the filter. The filter grammar is a subset of OData 4.0.

NOTE: The filter query parameter must use URL encoding. Most clients do this automatically with inputs provided to them specifically as query parameters. Encoding must be done manually for any query parameters provided as part of the URL.
The reserved characters ! # $ & ' ( ) * + , / : ; = ? @ [ ] must be encoded with percent encoded equivalents. Device IDs contain a +, which must be encoded as %2B.
For example: the value P06760-B21+2M212504P8 must be encoded as P06760-B21%2B2M212504P8 when it is used in a query parameter.

CLASS EXAMPLES
Types integer, decimal, timestamp, string, boolean, null
Operations eq, ne, gt, ge, lt, le, in
Logic and, or, not

Devices in a group can be filtered by:

  • eTag
  • groupId
  • overallSecurityStatus
  • productId
  • serial
  • subscriptionState
  • subscriptionTier

The following examples are not an exhaustive list of all possible filtering options.

Examples:
Return devices in a group where a property equals a value. <property> eq <value>
filter=productId eq '000001-A01'
Return devices in a group where a property does not equal a value not <property> eq <value>
filter=not overallSecurityStatus eq 'OK'
Return devices in a group with populated property. not <property> eq null
filter=not eTag eq null
Return devices in a group where property contains a value. contains(<property>, <value>)
filter=contains(productId,'A01')
Return devices in a group where property is populated and property contains value. not <property> eq null and contains(<property>, <value>)
filter=not eTag eq null and contains(productId,'A01')
Return devices in a group where property is one of multiple values. <property>/<nestedProperty> in (<value>,<value>)
filter=overallSecurityStatus in ('RISK', 'UNKNOWN')
Responses
200

Successful Response

400

Bad request

401

Unauthorized

403

Forbidden

404

Not found

406

Not acceptable

500

Internal server error

Request samples 
Response samples 
application/json
{
  • "offset": 0,
  • "count": 1,
  • "total": 12,
  • "items": [
    ]
}