About the Collectors Resource
Last updated on 06 December, 2020Overview
The collector resource allows you to programmatically manage your LogicMonitor Collectors. As with all of our API calls, authentication is required.
Using LogicMonitor’s REST API you can:
- Get a list of Collectors
- Get information about a particular Collector
- Add a Collector
- Download a Collector installer
- Update a Collector
- Delete a Collector
Resource Information
URI: /setting/collectors
Resource Properties: Each Collector has the following properties.
| Property | Description | Type |
| id | The id of the Collector | Integer |
| createdOn | The time that the Collector was created, in epoch format | Integer |
| updatedOn | The time that the Collector was last updated, in epoch format | Integer |
| upTime | The time the Collector has been up, in seconds | Integer |
| watchdogUpdatedOn | The time that the Watchdog Services was last updated, in epoch format | Integer |
| status | 0|1|2|3 – The registration status of the Collector. 0= unregistered, 1= registered, 2= stopped, 3= suspended | Integer |
| confVersion | The version of the agent.conf configuration file | String |
| netscanVersion | The Netscan version associated with the Collector | String |
| build | The Collector version | String |
| collectorConf | The Collector’s configuration file | String |
| lastSentNotificationOn | The time, in epoch format, that a notification was last sent for the Collector | Integer |
| platform | The OS of the Collector device (e.g. Linux, Windows) | String |
| acked | true | false, whether or not the Collector is currently acknowledged | Boolean |
| ackedOn | The epoch at which the Collector was acknowledged (if it is in alert) | Integer |
| ackedBy | The user that acknowledged the Collector (if it is in alert) | String |
| ackComment | The comment associated with the Collector acknowledgement (if it is in alert and acknowledged) | String |
| clearSent | Whether or not an alert clear notifcation has been sent for this Collector | Boolean |
| isDown | Whether or not the Collector is currently down | Boolean |
| createdOnLocal | The time that the Collector was created, in local time format | String |
| updatedOnLocal | The time that the Collector was last updated, in local time format | String |
| watchdogUpdatedOnLocal | The time that the Collector Watchdog was last updated, in local time format | String |
| lastSentNotificationOnLocal | The time that a notification was last sent for this Collector, in local time format | String |
| ackedOnLocal | The time that the Collector was acknowledged (if it is in alert), in local time format | String |
| hostname | The hostname of the device the Collector is installed on | String |
| numberOfHosts | The number of devices monitored by the Collector | Integer |
| numberOfServices | The number of services monitored by the Collector | Integer |
| userVisibleHostsNum | The number of devices monitored by the Collector and visible to the user that made the query | Integer |
| userVisibleServicesNum | The number of services monitored by the Collector and visible to the user that made the query | Integer |
| nextUpgradeInfo | The details of the Collector’s next upgrade, if one has been scheduled | JSON object |
| description | The Collector’s description | String |
| backupAgentId | The Id of the backup Collector assigned to the Collector | Integer |
| enableFailBack | Whether or not automatic failback is enabled for the Collector | Boolean |
| resendIval | The interval, in minutes, after which alert notifications for the Collector will be resent | Integer |
| suppressAlertClear | Whether alert clear notifications are suppressed for the Collector | Boolean |
| escalatingChainId | The Id of the escalation chain associated with this Collector | Integer |
| nextRecipient | The Id of the next recipient to which alert notifications will be sent | Integer |
| onetimeUpgradeInfo | The details of the Collector’s one time upgrade, if one has been scheduled | Integer |
| automaticUpgradeInfo | The details of the Collector’s automatic upgrade schedule, if one exists | Integer |
| collectorGroupId | The Id of the group the Collector is in | Integer |
| collectorGroupName | The name of the group the Collector is in | String |
| userPermission | The permission level of the user that made the API request to get Collector information | String |
| enableFailOverOnCollectorDevice | Whether or not the device the Collector is installed on is enabled for fail over | Boolean |