REST API Developer's Guide

Support > REST API Developer's... > REST API v1 > Managing Device Grou... > Get Device Group Properties

Get Device Group Properties

You can use LogicMonitor's REST API to get all properties for a device, whether they are custom or system, inherited or not.  There are two ways to get property information:

  1. Get all properties for a device
  2. Get information about a particular device property

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

 

Get all device group properties

HTTP Method: GET

Resource URI: /device/groups/{groupID}/properties

Where groupID is the ID of the group whose property you'd like to get, which you can get from the groups resource.

Resource Properties:

Request Parameters: By default, a list of 50 device group properties 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/12/properties?sort=-type
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: !:
  • Includes: ~
  • Does not include: !~
 /device/groups/45/properties?filter=name~QA*
fields fields={list of properties separated by commas} Filters the response to only include the following fields for each object /device/groups/89/properties?fields=name,id
size size=integer The number of results to display. Max is 1000. /device/groups/65/properties?size=5
offset offset=integer The number of results to offset the displayed results by /device/groups/76/properties?offset=2

 

Get information about a particular device property

HTTP Method: GET

Resource URI: /device/groups/{groupID}/properties/{propertyName}

Where groupID is the ID of the group whose property you'd like to get, which you can get from the groups resource. propertyName is the name of the property you'd like to gert information for, which you can get from getting all device group properties.

 

Example 1

The following Python script gets all properties for group 34:

#!/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/34/properties'
queryParams =''
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

 

Example 2

The following Python script gets information about the property with the name 'proddc':

#!/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/34/properties/proddc'
queryParams =''
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