Come join our live training webinar every other Wednesday at 11am PST and hear LogicMonitor experts explain best practices and answer common questions. We understand these are uncertain times, and we are here to help!
Note that LogicMonitor does have an available REST API equivalent for this API call.
LogicMonitor’s RPC API enables you to update devices using updateHost.
Note: As with all our API calls, authentication is required.
https://accountName.logicmonitor.com/santaba/rpc/updateHost?c=accountName&u=user&p=password&id=hostIdNum&hostName=hostName&displayedAs=displayName&hostGroupIds=hostGroupId1,hostGroupId2&agentId=agentIdNum&opType=add|replace|refresh&propName0=property0Name&propValue0=property0Value
Request Parameters: You can include the following as query parameters in an updateHost request:
To get a hostGroupId in the UI: navigate to the group, select the focus icon & the id is in the URL as dg-##.
true: Alerts will be enabled for the device. false: Alerts will be disabled for the device.
true: Netflow monitoring will be enabled for the device. false: Netflow monitoring will be disabled for the device.
add: Add a property with the given value to a device. If the property already exists, no action is taken (the existing value will not be changed).
replace: Add a property with the specified value if it does not exist, or update the property’s value if it does exist.
refresh: Replace all the properties of the device (including group membership) with the properties and values provided in the updateHost call. Any properties not present in the refresh call will be deleted. Inherited properties are not affected.
Note: The opType parameter dictates how host properties are changed. Add and Replace opType values refer only to the custom device properties set by the propName, propValue fields (e.g. snmp.community, esx.user, jdbc.mssql.pass). Device properties such as displayedAs, hostGroupIds, description, alertEnable, link, and enableNetflow must be specified in the request. If these are omitted they will be reset to a default or blank value.
All outputs will be in the format: { [status], [data], [errmsg] }, where status is the status of the response, errmsg is the error message associated with the response, and the data object includes the following:
If this value is true, the device has been updated in the past hour. If this value is false, the Host has not been updated in the past hour.
The following example updates device 10.0.1.36 in account apiAccount:
curl "https://apiAccount.logicmonitor.com/santaba/rpc/updateHost?c=apiAccount&u=apiUser&p=example&hostName=10.0.1.36&displayedAs=MyDevice&id=208&agentId=85&alertEnable=false"
Response:
{ "status": 200, "data": { "relatedDeviceId": -1, "netflowAgentId": 0, "displayedAs": "MyDevice", "link": "", "hgIds": "", "lastrawdatatime": 0, "agentId": 85, "scanConfigId": 0, "deletedOnMillis": 0, "groupd": true, "id": 208, "createdOn": 1447886410, "alertEnable": false, "isActive": false, "lastdatatime": 0, "toDeleteOnMillis": 0, "autoPropsUpdatedOn": 1447886531, "deviceType": 0, "description": "", "name": "MyDevice", "hostName": "10.0.1.36", "autoPropsAssignedOn": 1447886410, "updatedOn": 1447886410, "enableNetflow": false }, "errmsg": "OK" }
The following request adds the location property to device ip-172-31-37-162.us-west-2.compute.interal in account apiAccount.logicmonitor.com, and sets the value to 12 E. Carrillo, Santa Barbara, CA. All other devices properties are left alone.
curl "https://apiAccount.logicmonitor.com/santaba/rpc/updateHost?c=apiAccount&u=username&p=password&hostName=ip-172-31-37-162.us-west-2.compute.interal&displayedAs=ip-172-31-37-162.us-west-2.compute.interal&id=39&agentId=85&alertEnable=true&hostGroupIds=7&description=myDeviceDescription&opType=add&propName0=location&propValue0=12%20E.%20Carrillo,Santa%20Barbara,CA"
{ "status": 200, "data": { "relatedDeviceId": -1, "netflowAgentId": 0, "displayedAs": "ip-172-31-37-162.us-west-2.compute.interal", "link": "", "hgIds": "7", "lastrawdatatime": 0, "agentId": 85, "scanConfigId": 0, "deletedOnMillis": 0, "groupd": true, "id": 39, "createdOn": 1431975317, "alertEnable": true, "isActive": false, "lastdatatime": 0, "toDeleteOnMillis": 0, "autoPropsUpdatedOn": 1462327761, "deviceType": 0, "description": "myDeviceDescription", "name": "ip-172-31-37-162.us-west-2.compute.interal", "hostName": "ip-172-31-37-162.us-west-2.compute.interal", "autoPropsAssignedOn": 1462327761, "updatedOn": 1462395313, "enableNetflow": false }, "errmsg": "OK" }
The following request updates the value of the location property for device ip-172-31-37-162.us-west-2.compute.interal in account apiAccount.logicmonitor.com to 1002 Anacapa, Santa Barbara, CA. All other devices properties are left alone.
curl "https://apiAccount.logicmonitor.com/santaba/rpc/updateHost?c=apiAccount&u=username&p=password&hostName=ip-172-31-37-162.us-west-2.compute.interal&displayedAs=ip-172-31-37-162.us-west-2.compute.interal&id=39&agentId=85&alertEnable=true&hostGroupIds=7&description=myDeviceDescription&opType=replace&propName0=location&propValue0=1002%20Anacapa,Santa%20Barbara,CA"
{ "status": 200, "data": { "relatedDeviceId": -1, "netflowAgentId": 0, "displayedAs": "ip-172-31-37-162.us-west-2.compute.interal", "link": "", "hgIds": "7", "lastrawdatatime": 0, "agentId": 85, "scanConfigId": 0, "deletedOnMillis": 0, "groupd": true, "id": 39, "createdOn": 1431975317, "alertEnable": true, "isActive": false, "lastdatatime": 0, "toDeleteOnMillis": 0, "autoPropsUpdatedOn": 1462313262, "deviceType": 0, "description": "myDeviceDescription", "name": "ip-172-31-37-162.us-west-2.compute.interal", "hostName": "ip-172-31-37-162.us-west-2.compute.interal", "autoPropsAssignedOn": 1462399662, "updatedOn": 1462395313, "enableNetflow": false }, "errmsg": "OK" }
In This Article