Support Center Home


About the Collectors Resource

Overview

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:

Resource Information

URI: /setting/collectors

Resource Properties: Each Collector has the following properties.

Property Description Type
idThe id of the CollectorInteger
createdOnThe time that the Collector was created, in epoch formatInteger
updatedOnThe time that the Collector was last updated, in epoch formatInteger
upTimeThe time the Collector has been up, in secondsInteger
watchdogUpdatedOnThe time that the Watchdog Services was last updated, in epoch formatInteger
status0|1|2|3 – The registration status of the Collector. 0= unregistered, 1= registered, 2= stopped, 3= suspendedInteger
confVersionThe version of the agent.conf configuration file String
netscanVersionThe Netscan version associated with the CollectorString
buildThe Collector versionString
collectorConfThe Collector’s configuration fileString
lastSentNotificationOnThe time, in epoch format, that a notification was last sent for the CollectorInteger
platformThe OS of the Collector device (e.g. Linux, Windows)String
ackedtrue | false, whether or not the Collector is currently acknowledgedBoolean
ackedOnThe epoch at which the Collector was acknowledged (if it is in alert)Integer
ackedByThe user that acknowledged the Collector (if it is in alert)String
ackCommentThe comment associated with the Collector acknowledgement (if it is in alert and acknowledged)String
clearSentWhether or not an alert clear notifcation has been sent for this CollectorBoolean
isDownWhether or not the Collector is currently downBoolean
createdOnLocalThe time that the Collector was created, in local time formatString
updatedOnLocalThe time that the Collector was last updated, in local time formatString
watchdogUpdatedOnLocalThe time that the Collector Watchdog was last updated, in local time formatString
lastSentNotificationOnLocalThe time that a notification was last sent for this Collector, in local time formatString
ackedOnLocalThe time that the Collector was acknowledged (if it is in alert), in local time formatString
hostnameThe hostname of the device the Collector is installed onString
numberOfHostsThe number of devices monitored by the CollectorInteger
numberOfServicesThe number of services monitored by the CollectorInteger
userVisibleHostsNumThe number of devices monitored by the Collector and visible to the user that made the queryInteger
userVisibleServicesNumThe number of services monitored by the Collector and visible to the user that made the queryInteger
nextUpgradeInfoThe details of the Collector’s next upgrade, if one has been scheduledJSON object
descriptionThe Collector’s descriptionString
backupAgentIdThe Id of the backup Collector assigned to the CollectorInteger
enableFailBackWhether or not automatic failback is enabled for the CollectorBoolean
resendIvalThe interval, in minutes, after which alert notifications for the Collector will be resentInteger
suppressAlertClearWhether alert clear notifications are suppressed for the CollectorBoolean
escalatingChainIdThe Id of the escalation chain associated with this CollectorInteger
nextRecipientThe Id of the next recipient to which alert notifications will be sentInteger
onetimeUpgradeInfoThe details of the Collector’s one time upgrade, if one has been scheduledInteger
automaticUpgradeInfoThe details of the Collector’s automatic upgrade schedule, if one existsInteger
collectorGroupIdThe Id of the group the Collector is inInteger
collectorGroupNameThe name of the group the Collector is inString
userPermissionThe permission level of the user that made the API request to get Collector informationString
enableFailOverOnCollectorDeviceWhether or not the device the Collector is installed on is enabled for fail overBoolean

In This Article