Modify Custom Group

Modify Custom Group

NOTE: Method is enabled for user groups only

Request
URI
PUT
https://{api_host}/suite-api/api/resources/groups
COPY
Request Body

The custom group definition

custom-group of type(s) application/json
Required

Show optional properties

{
    "resourceKey": {
        "name": "string",
        "adapterKindKey": "string",
        "resourceKindKey": "string"
    },
    "membershipDefinition": {}
}
"{\n  \"id\" : \"e80cba3c-aaec-4b0e-9608-c692126a5915\",\n  \"resourceKey\" : {\n    \"name\" : \"Sample Custom Group with Metric Key Condition\",\n    \"adapterKindKey\" : \"Container\",\n    \"resourceKindKey\" : \"Environment\"\n  },\n  \"autoResolveMembership\" : true,\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.

Authentication
This operation uses the following authentication methods.
Responses
200

The updated custom group

Returns custom-group of type(s) application/json
"No Custom Example is Available"
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 -X PUT -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"membershipDefinition:"object","resourceKey:"object"}' https://{api_host}/suite-api/api/resources/groups