To update an existing SoapUI monitor, send a PATCH request to /monitors/api/{id}, where {id} is the monitor ID.
Request URL
PATCH https://api.alertsite.com/api/v3/monitors/api/{id}
Authentication
The request must include the Authorization header containing a user’s access token:
Authorization: Bearer ACCESS_TOKEN
See Authentication for more information.
Request body
The request body is a JSON object containing the monitor configuration fields you want to update.
For example, specify a password for the SoapUI project and show the details of the collected test logs:
{
"project_password":"petst0re",
"capture":{
"headers":true,
"images":true,
"level":"All Steps",
"mimetype":"image/jpeg",
"sources":true
}
}
Response body
On success, the operation returns the ID of the updated monitor.
{
"id": "123456"
}
Error responses have a non-200 status code and contain the errors list, such as:
{
"errors": [
{
"code": 400,
"message": "invalid_request - User authentication failed."
}
]
}
Try it out
Click here to test this operation in AlertSite’s interactive API console.
Code examples
This code updates the monitor with ID 123456 and specifies the details of the collected test logs to be shown.
cURL (Windows)
curl -X POST https://api.alertsite.com/api/v3/monitors/api/123456
-H "Authorization: Bearer ACCESS_TOKEN"
-H "Content-Type: application/json"
-d '{\"capture\": {\"headers\":true, \"images\":true, \"level\":\"All Steps\", \"mimetype\":\"image/jpeg\", \"sources\":true}'
Note: New lines are added for readability.
The actual command should be one continuous line.
cURL (bash)
curl -X POST https://api.alertsite.com/api/v3/monitors/api/123456 \
-H "Authorization: Bearer ACCESS_TOKEN" \
-H "Content-type: application/json" \
-d '{"capture": {"headers":true, "images":true, "level":"All Steps", "mimetype":"image/jpeg", "sources":true}'
Python
import requests # Requests library http://docs.python-requests.org
import json
baseUrl = 'https://api.alertsite.com/api/v3'
username = '[email protected]' # Replace with your AlertSite login email
password = 'pa55w0rd' # Replace with your AlertSite password
monitor_params = {
'capture': {
'headers': True,
'images': True,
'level': 'All Steps',
'mimetype': 'image/jpeg',
'sources': True
}
}
# Login
payload = {'username': username, 'password': password}
r = requests.post(baseUrl+'/access-tokens', data=json.dumps(payload), headers={'Content-Type': 'application/json'})
token = r.json()['access_token']
# Update the monitor
headers = {
'Authorization': 'Bearer ' + token,
'Content-Type': 'application/json'
}
r = requests.patch(baseUrl+'/monitors/api/123456', data=json.dumps(monitor_params), headers=headers)
result = r.json()
if r.status_code == requests.codes.ok:
monitor_id = result['id']
print('Successfully updated the monitor. ID:{}'.format(monitor_id))
else:
print('Could not update the monitor. The following error(s) occurred:', *result['errors'], sep='\n')