List all groups

get/compute-ops/v1beta2/groups

Get the list of a user's groups.

SecurityBearer
Request
query Parameters
offset
integer >= 0
Default: 0

Zero-based resource offset to start the response from

Example: offset=10
limit
integer [ 0 .. 1000 ]

The maximum number of records to return.

Example: limit=10
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. Server 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

Groups can be filtered by:

  • autoAddServerTags
  • autoFwUpdateOnAdd
  • createdAt
  • description
  • generation
  • groupComplianceStatus
  • id
  • name
  • platformFamily
  • serverPolicies
  • serverSettingsUris
  • updatedAt

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

Examples:
Return groups where a property equals a value. <property> eq <value>
filter=name eq 'Production Group'
Return groups where a nested property equals a value. <property>/<nestedProperty> eq <value>
filter=autoAddServerTags/Department eq 'Development - Texas'
Return group where name == my+group
filter=name%20eq%20%27my%2Bgroup%27
Return groups where a property does not equal a value not <property> eq <value>
filter=not autoAddServerTags/Department eq 'Development - Texas'
Return groups with populated property. not <property> eq null
filter=not name eq null
Return groups where property contains a value. contains(<property>, <value>)
filter=contains(name,'Group')
Return groups where property is populated and property contains value. not <property> eq null and contains(<property>, <value>)
filter=not name eq null and contains(name,'Group')
Return groups where property is one of multiple values. <property>/<nestedProperty> in (<value>,<value>)
filter=autoAddServerTags/Department in ('Development - Texas','Development - Colorado')
sort
string

The order in which to return the resources in the collection.

The value of the sort query parameter is a comma separated list of sort expressions. Each sort expression is a property name optionally followed by a direction indicator asc (ascending) or desc (descending).

The first sort expression in the list defines the primary sort order, the second defines the secondary sort order, and so on. If a direciton indicator is omitted the default direction is ascending.

Examples:
Order resources ascending by name
sort=name asc
Order resources ascending by name and then by descending by createdAt
sort=name,createdAt desc
header Parameters
Tenant-Acid
string <uuid>

Tenant-Acid header can be used by an MSP workspace to make API calls on behalf of their tenant by specifying the tenant's application customer ID.

In order to make such an API call, the Bearer token must belong to an MSP workspace and this header value must be the application customer ID of a tenant within the MSP workspace. Use the /compute-ops-mgmt/v1beta1/accounts API to determine the application customer IDs for your tenant accounts.

Responses
200

Successful Response

400

Bad request

401

Unauthorized

403

Forbidden

406

Not acceptable

500

Internal server error

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