Update Collector Group

This Replaces all existing configuration of a Collector Group
with the data specified as part of the Request.

Request

URI

PUT

https://{api_host}/suite-api/api/collectorgroups

COPY

Query Parameters

boolean

checkCollectorMembers

Optional

Constraints: default: false

Check if collector group members are valid, before proceeding with collector group update

Request Body

The Collector Group that needs to be updated

collector-group of type(s) application/json

Required

Show optional properties

{
    "id": "string",
    "name": "string"
}

"{\n  \"id\" : \"b9b211c8-845b-4d55-9f3b-819b84591618\",\n  \"name\" : \"collector_group_1\",\n  \"description\" : \"collector_group_1 description\",\n  \"collectorId\" : [ 3, 4 ],\n  \"systemDefined\" : false,\n  \"haEnabled\" : true,\n  \"lbEnabled\" : false,\n  \"virtualIP\" : \"1.2.3.4\"\n}"

string As uuid As uuid

Required

Identifier of the Collector Group.
This is system generated during the creation time.

string

name

Required

Name of the Collector Group. This uniquely identifier a Collector Group in the system but is user specified and mutable.

string

description

Optional

Description of the Collector Group

array of integer

collectorId

Optional

Set of Collector IDs that belong to a Collector Group

boolean

systemDefined

Optional

Is the Collector group system defined? This is a Read Only attribute and is set by the system.

array of object

links

Optional

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

boolean

haEnabled

Optional

is the collector group ha enabled or not

boolean

lbEnabled

Optional

is the collector group LB enabled or not

string

virtualIP

Optional

virtual IP value of collector group

Authentication

This operation uses the following authentication methods.

Token-based-authorization

Responses

200

The updated Collector Group

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

"{\n  \"id\" : \"c5e4bd5c-3c5b-47ac-9773-c998a43da8bb\",\n  \"name\" : \"collector_group_1\",\n  \"description\" : \"collector_group_1 description\",\n  \"collectorId\" : [ 3, 4 ],\n  \"systemDefined\" : false,\n  \"haEnabled\" : true,\n  \"lbEnabled\" : false,\n  \"virtualIP\" : \"1.2.3.4\"\n}"

string As uuid As uuid

Required

Identifier of the Collector Group.
This is system generated during the creation time.

string

name

Required

Name of the Collector Group. This uniquely identifier a Collector Group in the system but is user specified and mutable.

string

description

Optional

Description of the Collector Group

array of integer

collectorId

Optional

Set of Collector IDs that belong to a Collector Group

boolean

systemDefined

Optional

Is the Collector group system defined? This is a Read Only attribute and is set by the system.

array of object

links

Optional

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

boolean

haEnabled

Optional

is the collector group ha enabled or not

boolean

lbEnabled

Optional

is the collector group LB enabled or not

string

virtualIP

Optional

virtual IP value of collector group

500

Error occurred while updating the Collector Group

Operation doesn't return any data structure

Code Samples

COPY

                    curl -X PUT -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"id:"string","name:"string"}' https://{api_host}/suite-api/api/collectorgroups

On This Page

Description

Request

Query Parameters

Request Body

Authentication

Response

200 Response Body

Errors

Collector Groups Operations

GET

Get Collector Groups