monitoring

Cancel a monitor

Changed on

Sets the monitor's status to canceled. Evaluation stops now, the monitor is not charged on any invoice prepared after the cancel, and it and its alerts stay readable.

delete/v1/monitors/{monitorId}

Request

  • Base URL: https://api.offendersearch.app
  • URL: https://api.offendersearch.app/v1/monitors/{monitorId}
  • Auth: API key in header X-API-Key

Path parameters

monitorIdstring required

The monitor id (mon_…).

Response

The monitor was canceled.

status'canceled'
idstring

The canceled monitor's id.

notestring

When monitoring and billing stop, as a sentence.

Changes