REST API Developer's Guide

Get Device Groups

You can use LogicMonitor's REST API to programmatically get information about your LogicMonitor device groups. You can either get a list of device groups or you can get details for a particular device group.

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

 

Get a list of device groups

Returns a list of device groups

HTTP Method: GET

URI: /device/groups

Request Parameters: By default, a list of 50 device groups 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. Note that query parameters are not considered part of the resource path, and should not be included the calculation of the LMv1 authentication signature.

Property

Syntax

Description

Example URI

sort sort={+ or -}property Sorts the response by the property specified in either increasing (+) or decreasing (-) order /device/groups?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:
  • Greater than or equals: >:
  • Less than or equals: <:
  • Greater than: >
  • Less than: <
  • Does not equal: !:
  • Equals: :
  • Includes: ~
  • Does not include: !~
/device/groups?filter=fullPath~AWS/*
fields fields={list of properties separated by commas} Filters the response to only include the following fields for each object /device/groups?fields=name,id
size size=integer The number of results to display. Max is 1000 /device/groups?size=5
offset offset=integer The number of results to offset the displayed results by /device/groups?offset=2

 

Get information about a particular device group

Returns details for a particular device group

HTTP Method:GET

URI: device/groups/{id}

Request Parameters: You can include a filter parameter that controls which fields are displayed in the response:

Property

Syntax

Description

Example URI

fields fields={list of properties separated by commas} Filters the response to only include the following fields for each object /device/groups/{id}?fields=name,id,subGroups

 

Example

The following Python script returns the custom properties, name, id & number of devices for the device group(s) with 'prodServers' in the name:

#!/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 = '/device/groups'
queryParams = '?filter=name~prodServers&fields=customProperties,id,name,numOfHosts'
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
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.get(url, data=data, headers=headers)

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