Modify Custom Group

Modify an existing custom group definition

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

{
    "membershipDefinition": {},
    "resourceKey": {
        "adapterKindKey": "string",
        "name": "string",
        "resourceKindKey": "string"
    }
}

"{\n  \"id\" : \"433b0861-e935-40ad-a0c1-79fc8e65aa94\",\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}"

boolean

autoResolveMembership

Optional

Automatically update membership

string As uuid As uuid

Optional

Identifier of custom group

array of object

links

Optional

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

object

membershipDefinition

Required

Custom group membership definition

string As uuid As uuid

policy

Optional

Policy identifier

object

resourceKey

Required

Represents a composite key for uniquely identifying a Resource.

Authentication

This operation uses the following authentication methods.

Token-based-authorization

Responses

200

The updated custom group

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

"No Custom Example is Available"

boolean

autoResolveMembership

Optional

Automatically update membership

string As uuid As uuid

Optional

Identifier of custom group

array of object

links

Optional

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

object

membershipDefinition

Required

Custom group membership definition

string As uuid As uuid

policy

Optional

Policy identifier

object

resourceKey

Required

Represents a composite key for uniquely identifying a Resource.

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

On This Page

Description

Request

Request Body

Authentication

Response

200 Response Body

Resources Operations