Skip to main content

List Collectors

get collector list.

Parameters

ParameterDescription
FieldsA comma delimited list of fields. Filters the response to only include the listed fields for each object.
FilterFilters the response according to the operator and value specified. Note that you can use * to match on more than one character.
You can use the ‘.’ character to filter values within an object (e.g. custom properties), and multiple filters can be separated by a comma.

Operators include:
Greater than or equals: >:
Less than or equals: <:
Greater than: >
Less than: <
Does not equal: !:
Equals: :
Includes: ~
Does not include: !~

For example, filter=id>100 will return the results where the resource id is greater than 100.
OffsetThe number of results to offset the displayed results by.
SizeThe number of results to display. Max is 1000.

Example Output

{
"total": 0,
"searchId": "string",
"items": [
{
"userChangeOn": 0,
"confVersion": "string",
"updatedOnLocal": "string",
"hostname": "string",
"numberOfInstances": 0,
"id": 0,
"ea": true,
"watchdogUpdatedOnLocal": "string",
"hasFailOverDevice": true,
"collectorGroupName": "string",
"netscanVersion": "string",
"inSDT": true,
"updatedOn": 0,
"automaticUpgradeInfo": {
"dayOfWeek": "MON",
"hour": 15,
"createdBy": "string",
"level": "string",
"timezone": "Americas/Los Angeles",
"description": "regular MGD updates",
"occurrence": "Any",
"type": "string",
"version": "MGD",
"minute": 0
},
"numberOfHosts": 0,
"collectorConf": "string",
"sbproxyConf": "string",
"agentConfFields": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"lastSentNotificationOnLocal": "string",
"customProperties": [
{
"name": "addr",
"value": "127.0.0.1"
}
],
"predefinedConfig": {},
"onetimeUpgradeInfo": {
"createdBy": "string",
"level": "string",
"timezone": "string",
"endEpoch": 0,
"description": "regular MGD updates",
"type": "string",
"majorVersion": 27,
"minorVersion": 1,
"startEpoch": 1534888740
},
"wrapperConf": "string",
"clearSent": true,
"status": 0,
"backupAgentId": 75,
"specifiedCollectorDeviceGroupId": 0,
"escalatingChainId": 80,
"collectorSize": "string",
"ackedOnLocal": "string",
"watchdogConf": "string",
"description": "Linux Collector",
"createdOn": 0,
"platform": "string",
"isDown": true,
"userVisibleHostsNum": 0,
"canDowngrade": true,
"ackComment": "string",
"nextUpgradeInfo": {
"upgradeTime": "string",
"stable": true,
"majorVersion": 0,
"minorVersion": 0,
"mandatory": true,
"upgradeTimeEpoch": 0
},
"suppressAlertClear": true,
"nextRecipient": 0,
"ackedOn": 0,
"userChangeOnLocal": "string",
"collectorDeviceId": 0,
"ackedBy": "string",
"userPermission": "string",
"needAutoCreateCollectorDevice": true,
"watchdogUpdatedOn": 0,
"canDowngradeReason": "string",
"lastSentNotificationOn": 0,
"syntheticsEnabled": true,
"acked": true,
"onetimeDowngradeInfo": {
"createdBy": "string",
"level": "string",
"timezone": "string",
"endEpoch": 0,
"description": "regular MGD updates",
"type": "string",
"majorVersion": 27,
"minorVersion": 1,
"startEpoch": 1534888740
},
"upTime": 0,
"build": "string",
"previousVersion": "string",
"collectorGroupId": 10,
"createdOnLocal": "string",
"enableFailBack": true,
"resendIval": 15,
"arch": "string",
"enableFailOverOnCollectorDevice": true
}
]
}

Workflow Library Example

List Collectors with Logicmonitor and Send Results Via Email

Workflow LibraryPreview this Workflow on desktop