Update a Datasource Instance
Last updated on 24 February, 2021You can use LogicMonitor’s REST API to programmatically update instances for datasources that don’t have Active Discovery enabled.
Notes:
- As with all of our API calls, authentication is required.
- Consistent with HTTP standards, fields omitted from a PUT request will revert back to their default values.
HTTP Method: PUT
URI: /device/devices/{deviceId}/devicedatasources/{deviceDatasourceId}/instances/{instanceId}
Where:
- {deviceId} is the device id, which you can get from a GET request to the devices resource
- {deviceDatasourceId} is the device datasource id, which you can get from a GET request to the device datasources resource
- {instanceId} is the instance id
Request Parameters: You can include the following parameters in your POST request:
Property |
Description |
Required? |
Type |
groupId | The id of the instance group associated with the datasource instance | Yes | Integer |
displayName | The instance alias. This is the descriptive name of the instance, and should be unique for the device/datasource combination. | Yes | String |
description | The description of the datasource instance | No | String |
wildValue | The variable part of the instance, used to query data from a device. For example, variable part of the SNMP OID tree. This value must be unique for the device/datasource combination, unless two-dimensional active discovery is used. | Yes | String |
wildValue2 | Only used for two dimensional active discovery. When used, during Active Discovery runs, the token ##WILDVALUE## is replaces with the value of ALIAS and the token ##WILDVALUE2## is replaced with the value of the second part alias. This value must be unique for the device/datasource/WILDVALUE combination. | No | String |
disableAlerting | Whether or not alerting is disabled for the instance | No. Defaults to false. | Boolean |
stopMonitoring | Whether or not monitoring is disabled for the instance | No. Defaults to false. | Boolean |
Example
The following Python script updates instance 144279093 & disables alerting:
#!/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 = '/device/devices/56/devicedatasources/3294/instances/144279093'
queryParams =''
data = '{"groupId":10354,"wildValue":"www.google.com","displayName":"apiInstancess","disableAlerting":true}'
#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()
signature = base64.b64encode(hmac1.encode())
#Construct headers
auth = 'LMv1 ' + AccessId + ':' + signature.decode() + ':' + 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)