Getting Collector Group Details
Last updated on 08 October, 2024You can use LogicMonitor REST API v3 to get collector group details. You must authenticate yourself before making the API request.
Getting List of Collector Groups
You can include the following query parameters to control the kind of data to include in the response and how it is formatted.
URI: GET /setting/collector/groups
| Parameter | Type | Description |
fields | String | The response is filtered to include only the specified fields for each object. You can provide a list of properties separated by a comma. Example – /setting/collector/groups?fields=id,description |
size | Integer | Indicates the number of results to display. A maximum of 1000 results can be requested in a GET call. By default, a list of 50 collector groups is returned if a value is not provided for this parameter. Example – /setting/collector/groups?size=6 |
offset | Integer | Indicates the number of results to offset the displayed results. Example – /setting/collector/groups?offset=3 |
filter | String | The response is filtered according to the operator and specified value that is, filter=property:valueUse an asterisk (*) to match more than one character Use a dot (.) character to filter values within an object (example – custom properties)Use a comma (,) to separate multiple filters Operators include:
/setting/collectors/groups?filter=description~QA* |
Getting Details of Specific Collector Group
URI: GET /setting/collector/groups/{id}
| Parameter | Type | Description |
id | Integer | (Mandatory) The Id of the collector group whose details you want to get. |
fields | String | The response is filtered to include only the specified fields for each object. You can provide a list of properties separated by a comma. Example – /setting/collector/groups/id?fields=id,description |