Update Collector Group Using PUT

Update Collector Group Using PUT

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

Request
URI
PUT
https://{api_host}/api/collectorgroups
COPY
Request Body

The Collector Group that needs to be updated

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

Show optional properties

{
    "name": "string"
}
{
    "collectorIds": [
        0
    ],
    "description": "string",
    "id": "string",
    "links": [
        {
            "description": "string",
            "href": "string",
            "name": "string",
            "rel": "string"
        }
    ],
    "name": "string",
    "systemDefined": false
}
array of integer
collectorIds
Optional

Set of Collector IDs that belong to a Collector Group

string
description
Optional

Description of the Collector Group

string As uuid As uuid
id
Optional

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

array of link
links
Optional

links

string
name
Required

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

boolean
systemDefined
Optional

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

Authentication
This operation uses the following authentication methods.
Responses
200

The updated Collector Group

Returns collector-group of type(s) application/json 
{
    "collectorIds": [
        0
    ],
    "description": "string",
    "id": "string",
    "links": [
        {
            "description": "string",
            "href": "string",
            "name": "string",
            "rel": "string"
        }
    ],
    "name": "string",
    "systemDefined": false
}
array of integer
collectorIds
Optional

Set of Collector IDs that belong to a Collector Group

string
description
Optional

Description of the Collector Group

string As uuid As uuid
id
Optional

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

array of link
links
Optional

links

string
name
Required

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

boolean
systemDefined
Optional

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


500

Error occurred while updating the Collector Group

Operation doesn't return any data structure

On This Page
Collector Groups Operations
PUT
Add Collector To Collector Group Using PUT
POST
Create Collector Group Using POST
DELETE
Delete Collector Group Using DELETE
GET
Get Collector Groups Using GET
GET
Get Collector Group Using GET
DELETE
Remove Collector From Collector Group Using DELETE
PUT
Update Collector Group Using PUT