REST API Developer's Guide

Get Website Properties

You can use LogicMonitor's REST API to get all properties for a website.  Properties set directly for a website can be retrieved directly from the serviceProperties returned in the services resource, but in order to get inherited properties (properties set at the group level) you'll need to query the properties sub-resource for a specific website.

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

 

Get all website properties

HTTP Method: GET

Resource URI: /service/services/{ID}/properties

Where ID is the ID of the website for which you'd like to get properties. You can get this ID from the services resource.

Resource Properties:

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