Updating Collector Group Details

Last updated on 08 October, 2024

You can use LogicMonitor REST API v3 to update collector group details. You must authenticate yourself before making the API request.

To make partial updates to a collector group, make a PATCH request. To completely update a collector group, make a PUT request.

URI: PATCH /setting/collector/groups/{id}

URI: PUT /setting/collector/groups/{id}

Note: As per the REST standards, any property which is not specified in the PUT request will revert to its default value.

ParameterTypeDescription
idInteger(Mandatory) The Id of the collector group that you want to update.
autoBalanceMonitoredDevicesBooleanIndicates if the devices monitored by this collector group should be added to the auto balanced collector group. By default, the value is set to false.
forceUpdateFailedOverDevicesBooleanIndicates if the failed over devices should be added to this collector group. By default, the value is set to false.
Failed over devices are those devices whose preferred collector Id belongs to a different collector group but the current collector Id belongs to this collector group.
opTypeStringSupported opTypes are refreshadd, and replace. By default, it is set to refresh.
  • refresh – If the property specified in custom property already exists, then the value is updated. If it does not exist, then the value is added. However, the remaining properties are deleted.
  • add – If the property specified in custom property does not exist, the value is added.
  • replace – If the property specified in custom property already exists, then the value is updated. If it does not exist, then the value is added.
autoBalanceInstanceCountThresholdIntegerThe threshold for instance count strategy to check if the collector has high load.
descriptionStringThe description of the collector group.
Example – "description": "Group for collectors dedicated to Network Devices."
autoBalanceBooleanIndicates if the collector is auto balanced.
customPropertiesJSON ArrayThe custom properties defined for the collector group. Each property must have a name and a value.
nameString(Mandatory) The name of the collector group. Example – "name": "Collector (Network Devices)"
autoBalanceStrategyStringThe auto balance strategy for collector group. The value can be DEVICECOUNTINSTANCECOUNT or NONE(default).