Stop Monitoring

Overview

Use this endpoint when an existing monitoring request no longer needs to be monitored.

Stopping monitoring prevents future scheduled monitoring activity for the specified monitoring request.

When Should I Stop Monitoring?

Typical scenarios include:

  • The entity no longer needs to be monitored.
  • Monitoring was configured for a temporary requirement.
  • The customer no longer requires monitoring.
  • The monitoring configuration is no longer applicable.

Important

Use the monitoring_id of the monitoring request that should be stopped.

Stopping monitoring should be treated differently from a monitoring attempt failure. A failed attempt represents an issue with an individual monitoring execution, whereas stopping monitoring indicates that future monitoring is no longer required.

Active Monitoring
       ↓
DELETE /api/v1/monitoring/{monitoring_id}/
       ↓
Monitoring Stopped
       ↓
No future scheduled monitoring attempts

Before Stopping Monitoring

If your integration requires historical information, retrieve the required monitoring details, timeline, versions, or snapshots as appropriate.

Related APIs

  • Get Monitoring Requests — locate monitoring requests.
  • Get SOS Monitoring Details — retrieve the current monitoring record.
  • Monitoring Timeline — review previous monitoring attempts.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Responses

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