Get Collectors
Last updated on 06 December, 2020Overview
You can use LogicMonitor’s REST API to get information about the Collectors in your account. Specifically, you can get a list of Collectors or information on a specific Collector.
As with all of our API calls, authentication is required.
Get a List of All Collectors
HTTP Method: GET
URI: /setting/collectors
Request Parameters: By default, a list of 50 Collectors will be returned. You can include sort, filter, fields, size, and offset parameters in your request to control what data is included in the response and how it is formatted.
| Property | Syntax | Description | Example URI |
| sort | sort={+ or -}property | Sorts the response by the property specified in either increasing (+) or decreasing (-) order | /setting/collectors?sort=-id |
| filter | filter=property{operator}value | Filters 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:
| /setting/collectors?filter=description~QA* |
| fields | fields={list of properties separated by commas} | Filters the response to only include the following fields for each object | /setting/collectors?fields=id,upTime |
| size | size=integer | The number of results to display | /setting/collectors?size=5 |
| offset | offset=integer | The number of results to offset the displayed results by | /setting/collectors?offset=2 |
Example
The following Python script returns the description, hostname and id for all collectors in the account api.logicmonitor.com.
#!/bin/env python
import requests
import json
import hashlib
import base64
import time
import hmac
#Account Info
AccessId ='48v2wRzfK94y53sq5EuF'
AccessKey ='H_D9i(f5~B^U36^K6i42=^nS~e75gy382Bf6{)P+'
Company = 'api'
#Request Info
httpVerb ='GET'
resourcePath = '/setting/collectors'
queryParams = '?fields=id,description,hostname'
data = ''
#Construct URL
url = 'https://'+ Company +'.logicmonitor.com/santaba/rest' + resourcePath +queryParams
#Get current time in milliseconds
epoch = str(int(time.time() * 1000))
#Concatenate Request details
requestVars = httpVerb + epoch + data + resourcePath
# Construct signature
hmac1 = hmac.new(AccessKey.encode(),msg=requestVars.encode(),digestmod=hashlib.sha256).hexdigest()
# Construct headers
auth = 'LMv1 ' + AccessId + ':' + signature.decode() + ':' + epoch
headers = {'Content-Type':'application/json','Authorization':auth}
#Make request
response = requests.get(url, data=data, headers=headers)
# Print status and body of response
print('Response Status:',response.status_code)
print('Response Body:',response.content)Python 3
Get Information About a Particular Collector
HTTP Method: GET
URI: /setting/collectors/<id>