Monitors

Update, pause or resume a monitor

Changing query recompiles the plan; passing plan replaces the targets. Either starts a new baseline run.

patch/v1/monitors/{id}

Request

  • Base URL: https://api.ploid.com
  • URL: https://api.ploid.com/v1/monitors/{id}
  • Auth: one of:
    • HTTP bearer
    • API key in header x-api-key

Path parameters

idstring required

Request body

namestring
status'active' | 'paused'
querystring
webhook_urlstring uri nullable
max_items_per_runinteger

Response

Updated monitor

metaobject required

Changes

No recorded changes to this operation across all 1 revision of this API.