REST API - Services "Properties"

Question

Trying to get "serviceProperties" to populate when pulled via the REST API.

I add a Properties entry on a Web Service Check: &nbsp;Name - [account_name], &nbsp;Value - [TheoretDevelopment] but the results always come back empty. &nbsp;Tried various options.

Does the REST API actually support this field? &nbsp;Any assistance would be much appreciated.

Thank you!

&nbsp;

serviceProperties

The properties associated with the Service

JSON Object

"serviceProperties" : [ {"name" : "billing","value" : "website"}, {"name" : "team","value" : "TechOps"}, {"name" : "production","value" : "true"} ]

&nbsp;

&nbsp;{
	&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; "type": &nbsp;"webservice",
	&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; "id": &nbsp;177,
	&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; "name": &nbsp;"careers.zzz.org",
	&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; "description": &nbsp;"If this site goes down, follow standard critical alert procedures per the client policy",
	&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; "serviceFolderId": &nbsp;247,
	&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; "stopMonitoring": &nbsp;false,
	&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; "stopMonitoringByFolder": &nbsp;false,
	&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; "disableAlerting": &nbsp;false,
	&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; "individualSmAlertEnable": &nbsp;false,
	&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; "individualAlertLevel": &nbsp;"warn",
	&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; "overallAlertLevel": &nbsp;"critical",
	&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; "alertStatus": &nbsp;"none",
	&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; "alertStatusPriority": &nbsp;100000,
	&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; "sdtStatus": &nbsp;"none-none-none",
	&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; "alertDisableStatus": &nbsp;"none-none-none",
	&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; "pollingInterval": &nbsp;1,
	&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; "transition": &nbsp;9,
	&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; "testLocation": &nbsp;"{\"all\":false,\"smgIds\":[1,2]}",
	&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; "globalSmAlertCond": &nbsp;0,
	&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; "useDefaultLocationSetting": &nbsp;false,
	&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; "useDefaultAlertSetting": &nbsp;false,
	&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; "userPermission": &nbsp;"write",
	&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; "checkpoints": &nbsp;" &nbsp;",
	&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; "serviceProperties": &nbsp;"",
	&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; "serviceStatus": &nbsp;"alive",
	&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; "isInternal": &nbsp;false,
	&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; "collectors": &nbsp;"",
	&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; "script": &nbsp;"",
	&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; "method": &nbsp;"tabledriven",
	&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; "ignoreSSL": &nbsp;true,
	&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; "pageLoadAlertTimeInMS": &nbsp;30000,
	&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; "steps": &nbsp;""
	&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; },

&nbsp;

sarah_terry · Answer

Hi Todd - The REST API does indeed support the serviceProperties field. &nbsp;I'm unable to replicate the issue you're seeing, but it appears the response is also missing the value for the 'checkpoints' object. &nbsp;Are you using a script to make the request?

todd_theoret · Answer

3 hours ago, Sarah Terry said:

Hi Todd - The REST API does indeed support the serviceProperties field. &nbsp;I'm unable to replicate the issue you're seeing, but it appears the response is also missing the value for the 'checkpoints' object. &nbsp;Are you using a script to make the request?

Thanks for the reply Sarah. &nbsp;Yes, I am utilizing a PowerShell script. Almost identical to the example at:&nbsp;https://www.logicmonitor.com/support/rest-api-developers-guide/overview/using-logicmonitors-rest-api/&nbsp;except I added:&nbsp;$queryParams = '?size=900'

&lt;# account info #&gt; $accessId = 'unique' $accessKey = 'unique' $company = 'cwps' &lt;# request details #&gt; $httpVerb = 'GET' $resourcePath = '/service/services'
	$queryParams = '?size=900'

&lt;# Construct URL #&gt;
$url = 'https://' + $company + '.logicmonitor.com/santaba/rest' + $resourcePath + $queryParams

&lt;# Get current time in milliseconds #&gt;
$epoch = [Math]::Round((New-TimeSpan -start (Get-Date -Date "1/1/1970") -end (Get-Date).ToUniversalTime()).TotalMilliseconds)

&lt;# Concatenate Request Details #&gt;
$requestVars = $httpVerb + $epoch + $resourcePath + $queryParams

&lt;# Construct Signature #&gt;
$hmac = New-Object System.Security.Cryptography.HMACSHA256
$hmac.Key = [Text.Encoding]::UTF8.GetBytes($accessKey)
$signatureBytes = $hmac.ComputeHash([Text.Encoding]::UTF8.GetBytes($requestVars))
$signatureHex = [System.BitConverter]::ToString($signatureBytes) -replace '-'
$signature = [System.Convert]::ToBase64String([System.Text.Encoding]::UTF8.GetBytes($signatureHex.ToLower()))

&lt;# Construct Headers #&gt;
$auth = 'LMv1 ' + $accessId + ':' + $signature + ':' + $epoch
$headers = New-Object "System.Collections.Generic.Dictionary[[String],[String]]"
$headers.Add("Authorization",$auth)
$headers.Add("Content-Type",'application/json')

&lt;# Make Request #&gt;
$response = Invoke-RestMethod -Uri $url -Method Get -Header $headers

&lt;# Print status and body of response #&gt;
$status = $response.status
$body = $response.data| ConvertTo-Json

Write-Host "Status:$status"
Write-Host "Response:$body"

sarah_terry · Answer

Got it - I think found the issue:&nbsp; When the script converts the response to JSON, it isn't catching those nested objects like checkpoints, serviceProperties, etc. &nbsp;If you add '-Depth 5' as an option when converting, such that the full line is '$body = $response.data | ConvertTo-Json -Depth 5', you'll see those nested JSON objects. &nbsp;I'll correct the example scripts - sorry for the confusion! &nbsp;Let me know if this doesn't fix your issue.&nbsp;

todd_theoret · Answer

Sarah, unfortunately the -Depth 5 did not pull the properties. &nbsp;I utilized the exact PowerShell example, with our creds of course.

&nbsp;

&nbsp; "checkpoints": &nbsp;[
	&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; {
	&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; "id": &nbsp;282,
	&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; "geoInfo": &nbsp;"Overall",
	&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; "smgId": &nbsp;0
	&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; },
	&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; {
	&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; "id": &nbsp;151899387,
	&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; "geoInfo": &nbsp;"US - Los Angeles",
	&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; "smgId": &nbsp;1
	&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; },
	&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; {
	&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; "id": &nbsp;281,
	&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; "geoInfo": &nbsp;"US - Washington DC",
	&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; "smgId": &nbsp;2
	&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; }
	&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; ],
	&nbsp; "serviceProperties": &nbsp;[

&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; ],

sarah_terry · Answer

Are the properties you're trying to pull set at the service level, or inherited from a group? &nbsp;The serviceProperties object will only display properties set for the service in question, and won't include any inherited properties (we'll be publishing a properties sub-resource&nbsp;in our next release that includes all service properties, including inherited properties, and labels them by type).

Forum Discussion

REST API - Services "Properties"

Related Content

REST API Device SLA Widget

Logic Monitor service now integration issue

pull csv report via rest api

Getting Graph Sharing Token via REST API

SQL Server Services Status

Recent Discussions

Dashboard Sharing – An Inline Framing Method

2021-12-15 US Office Hours

Live Training - Tuning Datapoints and Alerts - 15th JUNE 2022 - APAC

Live Training - Introduction to Dashboards - 18th MAY 2022 - APAC

2022-05-11- APAC Product Overview -Collectors, Resources/Groups, Dashboards