REST API Developer's Guide

Update a Collector

With LogicMonitor's REST API you can programmatically update the Collectors in your account.

As with all of our API resources, authentication is required.

 

HTTP Method: PUT

**Consistent with REST standards, any properties not specified in a PUT request will revert back to their default values.

URI:/setting/collectors/{id}

Request Parameters:

You can include the following parameters in your PUT request:

Property

Description

Type

description The Collector's description String
backupAgentId The Id of the failover Collector configured for this 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
collectorGroupId The Id of the group the Collector is in Integer
collectorGroupName The name of the group the Collector is in String
enableFailOverOnCollectorDevice Whether or not the device the Collector is installed on is enabled for fail over Boolean

 

Example

The following Python script updates Collector 223:

#!/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 ='PUT'
resourcePath = '/setting/collectors/223'
queryParams = ''
data = '{"description":"prodCollector1","escalatingChainId":20,"collectorGroupId":4,"backupAgentId":85}'

#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
signature = base64.b64encode(hmac.new(AccessKey,msg=requestVars,digestmod=hashlib.sha256).hexdigest())

#Construct headers
auth = 'LMv1 ' + AccessId + ':' + signature + ':' + epoch
headers = {'Content-Type':'application/json','Authorization':auth}

#Make request
response = requests.put(url, data=data, headers=headers)

#Print status and body of response
print 'Response Status:',response.status_code
print 'Response Body:',response.content