monitor

Update a monitor

Pauses or resumes a monitor, or changes what it reports and who receives its daily email.

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

patch/v1/monitor/{monitor_id}

Request

  • Base URL: http://localhost:3030
  • URL: http://localhost:3030/v1/monitor/{monitor_id}
  • Auth: HTTP bearer

Path parameters

monitor_idstring required

The monitor's id, mon_....

Request body

activeboolean nullable

Whether the monitor produces events.

event_typestring[] nullable

The event types to report. Replaces the current set.

email_recipientstring[] nullable

Email addresses of members to send a daily summary to. Replaces the current set. [] sends none.

Response

The monitor.

object'monitor' required

The object's type. Always monitor.

idstring required

Unique identifier for the object.

liststring required

The id of the list watched.

activeboolean required

Whether the monitor produces events.

event_typestring[] required

The event types the monitor reports. Any of permit.created and case.created.

email_recipientstring[] required

Email addresses of the members who receive a daily summary of the monitor's events. Empty when no one does.

created_atstring date-time required

Time at which the object was created.

updated_atstring date-time required

Time at which the object was last updated.

hrefstring required

The object's path in the API.

Example response

{
  "id": "mon_01h455vb4pex5vsknk084sn02q",
  "list": "lst_01h455vb4pex5vsknk084sn02q",
  "email_recipient": [
    "jordan@example.com"
  ],
  "href": "/v1/monitor/mon_01h455vb4pex5vsknk084sn02q"
}

Changes

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