Get Custom Group

Get Custom Group

Get a custom group with or without policy

Request
URI
GET
https://{api_host}/suite-api/api/resources/groups/{groupId}
COPY
Path Parameters
string
groupId
Required

Group identifier

Query Parameters
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

The custom group with sought identifier

Returns custom-group of type(s) application/json 
"{\n  \"id\" : \"28874271-f4b0-446b-ac67-5350e24fb7ea\",\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}"
string As uuid As uuid
id
Optional

Identifier of custom group

object
resourceKey
Required

Represents a composite key for uniquely identifying a Resource.

string As uuid As uuid
policy
Optional

Policy identifier

boolean
autoResolveMembership
Optional

Automatically update membership

object
membershipDefinition
Required

Custom group membership definition

array of object
links
Optional

Represents a HTTP 'link' element.
It is implicit that all the link tags support http 'GET' method.


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/suite-api/api/resources/groups/{groupId}
On This Page
Resources Operations
GET
Get Resources
PUT
Update Resource
GET
Get Custom Profiles
PUT
Modify Custom Profile
POST
Create Custom Profile
PUT
Stop Monitoring Resources
Deprecated
PUT
Start Monitoring Resources
Deprecated
PUT
Mark Resources As Being Maintained
DELETE
Unmark Resources As Being Maintained
GET
Get Custom Groups
PUT
Modify Custom Group
POST
Create Custom Group
GET
Get Custom Datacenters
PUT
Update Custom Datacenter
POST
Create Custom Datacenter
DELETE
Delete Custom Datacenters
GET
Get Stats Of Resources
POST
Add Stats For Resources
POST
Get Stats For Resources
POST
Query Latest Stats Of Resources
POST
Get Stats And DT For Resources
POST
Add Stats For Resources Using Push Adapter Kind
POST
Get Matching Resources
GET
Get Resource Properties List
POST
Add Resources Properties
POST
Query Latest Properties Of Resources
POST
Add Resources Properties Using Adapter Kind
GET
Get Group Types
POST
Add Group Type
POST
Get Resources Relationships
POST
Create Resource Using Adapter Instance
POST
Create Resource Using Adapter Kind
GET
Get Top N Stats Of Resources
GET
Get Latest Stats Of Resources
GET
Get Stat Keys Of Resources
GET
Get Custom Profile
DELETE
Delete Custom Profile
GET
Get Custom Group
DELETE
Delete Custom Group
GET
Get Custom Group Members
GET
Get Custom Datacenter
DELETE
Delete Group Type
DELETE
Delete Resources