Get Collector Group Using GET

Get Collector Group Using GET

Get details of a particular Collector Group in the system

Request
URI
GET
https://{api_host}/api/collectorgroups/{id}
COPY
Path Parameters
string
id
Required

Identifier of the Collector Group

Authentication
This operation uses the following authentication methods.
Responses
200

The Collector Group object for the specified identifier

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.


404

No Collector Group is found in the system with the specified identifier

Operation doesn't return any data structure

500

In case of any error processing the API response

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