Update SOS Monitoring

Overview

Use this endpoint to modify the configuration of an existing SOS monitoring request.

You do not need to create a new monitoring request when monitoring requirements change. The existing monitoring_id continues to represent the monitoring lifecycle.

What Can Be Updated?

Use this endpoint to update supported monitoring configuration such as:

  • Monitoring frequency
  • webhook_urls

For example, a business that is currently monitored monthly can be changed to weekly.

Partial Update

This endpoint uses PATCH, so only include the fields that need to be changed.

Fields that are not supplied should retain their existing values.

Important

Updating the monitoring configuration does not create a new monitoring request or change its monitoring_id.

The update applies to the existing monitoring configuration and its future monitoring activity.

Typical Flow

Existing Monitoring
        ↓
Retrieve monitoring_id
        ↓
PATCH monitoring configuration
        ↓
Configuration updated
        ↓
Future monitoring follows updated configuration

Related APIs

Use Get SOS Monitoring Details to retrieve the current configuration before or after making an update.

Use Monitoring Timeline to review monitoring attempts performed for the monitoring request.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Body Params
string
enum
Allowed:
webhook_urls
array
webhook_urls
Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json