Update Websites

You can use LogicMonitor’s REST API to programmatically update websites in your LogicMonitor account.

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

There are two ways to update a website:

• PUT: A PUT request enables you to replace an entire website definition (and update fields in the process).  You should use PUT to update a website if you want to provide an updated JSON definition for the website.  Note that consistent with REST standards, any properties not specified in a PUT request will revert back to their default values.
• PATCH: A PATCH request enables you to replace only certain fields for a website.  You should use PATCH if you don’t have the JSON definition for the website and you only want to update a few fields.

PUT

HTTP Method:PUT

URI: /service/services/{id}

Request Parameters:

For a ping service you can specify the following additional properties in your PUT request:

For new Web Services the following additional properties apply:

The JSON object “steps” comprises one or more steps, where each step has the following properties:

For examples of these Website resource properties, see this page.

Example PUT: Update a website

The following Python request updates service 104:

#!/bin/env python

import requests
import json
import hashlib
import base64
import time
import hmac

#Account Info
AccessId ='ACCESS_ID'
AccessKey ='ACCESS_KEY'
Company = 'COMPANY_NAME'

#Request Info
httpVerb ='PUT'
resourcePath = '/service/services/104'
queryParams = ''
data='{"serviceFolderId":"1","type":"webservice","testLocation":"{\\"smgIds\\":[2, 3, 4]}","name":"ProdWebCheck","disableAlerting":true,"pollingInterval":5,"steps":[{"HTTPHeaders":"Content-Type:application/json","followRedirection":false,"keyword":"breaking","schema":"http","url":"www.google.com/#q=news","timeout":120},{"keyword":"california","url":"www.google.com/#q=states","invertMatch":true}]}'

#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
hmac1 = hmac.new(AccessKey.encode(),msg=requestVars.encode(),digestmod=hashlib.sha256).hexdigest()
signature = base64.b64encode(hmac1.encode())

#Construct headers
auth = 'LMv1 ' + AccessId + ':' + signature.decode() + ':' + epoch
headers = {'Content-Type':'application/json','Authorization':auth}

#Make request
response = requests.put(url, data=data, headers=headers)

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

PATCH

HTTP Method: PATCH

URI: /service/services/{id}

Request Parameters:

With every PATCH request you must include a query parameter patchFields that indicates which fields should be updated, where multiple fields should be comma separated.  If a field is identified in the patchFields parameter and included in the payload of the request, its value will be updated.  All other field values will remain the same.  E.g. to update a website’s name, the URI + query parameter would be /santaba/rest/service/services/{id}?patchFields=name.  The name field would also need to be included in the request payload.

Fields that can be updated by PATCH are:

• name
• description
• serviceFolderId
• stopMonitoring
• disableAlerting
• individualSmAlertEnable
• individualAlertLevel
• overallAlertLevel
• pollingInterval
• transition
• globalSmAlertCond
• testLocation
• serviceProperties

Note that to add or update just one or a few service properties in the serviceProperties object, but not all of them, you’ll need to additionally use the opType query parameter. The opType query parameter can be set to add or replace. opType=add indicates that the properties included in the payload will be added, but all existing properties will remain the same. opType=replace indicates that the properties included in the request payload will be added if they don’t already exist, or updated if they do already exist, but all other existing properties will remain the same.

Example PATCH: Update a website

The following Python script updates website 11 via PATCH, and only adds one property.  All other fields will remain the same:

#!/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 ='PATCH'
resourcePath = '/service/services/11'
queryParams ='?patchFields=serviceProperties&opType=add'
data = '{"serviceProperties":[{"name":"project","value":"demo"}]}'

#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
hmac1 = hmac.new(AccessKey.encode(),msg=requestVars.encode(),digestmod=hashlib.sha256).hexdigest()
signature = base64.b64encode(hmac1.encode())

#Construct headers
auth = 'LMv1 ' + AccessId + ':' + signature.decode() + ':' + epoch
headers = {'Content-Type':'application/json','Authorization':auth}

#Make request
response = requests.patch(url, data=data, headers=headers)

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