RPC API Developer's Guide

Get Device Group Properties

Note that LogicMonitor does have an available REST API equivalent for this API call.

Device groups are LogicMonitors way of visually and logically organizing your monitored infrastructure.  LogicMonitor's RPC API enables you to programmatically view device group properties with getHostGroupProperties.

Note: As with all our API calls, authentication is required.

 

getHostGroupProperties

URL:
https://accountName.logicmonitor.com/santaba/rpc/getHostGroupProperties?hostGroupId=175&finalResult=trueOrFalse

 

Request Parameters: You can include the following as query parameters in a getHostGroupProperties request:

Parameter

Type

Description

hostGroupId Integer Required. The Id of the host group.
finalResult Boolean Optional. true | false (default) true: All of the host group properties (including inherited properties) will be returned. false: Inherited host group properties will not be returned.

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 incldues a list of properties, where name and value are displayed for each property.

Example

Request:
curl "https://apiAccount.logicmonitor.com/santaba/rpc/getHostGroupProperties?c=apiAccount&u=apiUser&p=example&hostGroupId=53&finalResult=true" 
Response:
{
  "status": 200,
  "data": [
    {
      "name": "system.categories",
      "value": ""
    },
    {
      "name": "snmp.community",
      "value": "********"
    },
    {
      "name": "netapp.ssl",
      "value": "true"
    }
  ],
  "errmsg": "OK"
}