Get Custom Groups

Get Custom Groups

Get all custom groups with or without policy

Request
URI
GET
https://{api_host}/suite-api/api/resources/groups
COPY
Query Parameters
string of array
groupId
Optional

Collection of group identifiers

boolean
includePolicy
Optional
Constraints: default: false

Flag that controls the retrieval of policy identifier applied to group


Authentication
This operation uses the following authentication methods.
Responses
200

Collection of custom groups

Returns cgroups of type(s) application/json
"{\n  \"groups\" : [ {\n    \"id\" : \"e665d215-9d36-4e3e-9d3a-40357d952b4f\",\n    \"resourceKey\" : {\n      \"name\" : \"Sample Custom Group with Metric Key Condition\",\n      \"adapterKindKey\" : \"Container\",\n      \"resourceKindKey\" : \"Environment\"\n    },\n    \"autoResolveMembership\" : false,\n    \"membershipDefinition\" : {\n      \"includedResources\" : [ ],\n      \"excludedResources\" : [ ],\n      \"custom-group-properties\" : [ ],\n      \"rules\" : [ {\n        \"resourceKindKey\" : {\n          \"resourceKind\" : \"VirtualMachine\",\n          \"adapterKind\" : \"VMWARE\"\n        },\n        \"statConditionRules\" : [ {\n          \"key\" : \"cpu|usage_average\",\n          \"doubleValue\" : 85.0,\n          \"compareOperator\" : \"GT\"\n        } ],\n        \"propertyConditionRules\" : [ ],\n        \"resourceNameConditionRules\" : [ ],\n        \"relationshipConditionRules\" : [ ],\n        \"resourceTagConditionRules\" : [ ]\n      } ]\n    }\n  } ]\n}"
array of object
groups
Optional

A collection of custom groups


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/suite-api/api/resources/groups