Documentation menu

← Lists and monitors

API reference

Update a monitor

PATCH/v1/monitor/{monitor_id}

Pauses or resumes a monitor. A paused monitor produces no events, and nothing that happened while it was paused is sent when it resumes.

Parameters

path

monitor_idrequiredstring
The monitor's id, mon_....

Request body

activeboolean | null
Whether the monitor produces events.

Responses

200
monitor object
The monitor.
401
ProblemDetail
credential_missing, credential_invalid or credential_expired. The request has no valid credential.
403
ProblemDetail
scope_missing, person_required, api_key_not_accepted or entitlement_missing. The credential or plan does not allow this request. detail names the reason.
404
ProblemDetail
no_such_resource. No object has that id.
422
ProblemDetail
parameter_invalid, id_malformed or a cursor code. A parameter is missing or invalid. errors lists each one.
429
ProblemDetail
rate_limited. Too many requests. Retry after the Retry-After interval. Nothing is charged.

Example request

curl -X PATCH 'https://api.placestack.com/v1/monitor/018f4b75-6f79-7c6a-8c80-000000000001' \
  -H "Authorization: Bearer $PLACESTACK_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{
  "active": true
}'

Example response

{
  "object": "monitor",
  "id": "mon_01h455vb4pex5vsknk084sn02q",
  "list": "lst_01h455vb4pex5vsknk084sn02q",
  "active": true,
  "created_at": "2026-09-13T12:00:00Z",
  "updated_at": "2026-09-13T12:00:00Z",
  "href": "/v1/monitor/mon_01h455vb4pex5vsknk084sn02q"
}

Next steps

DELETE /monitor/{monitor_id}

Delete a monitor

Continue