POST · Logs & monitoring
List, create, delete a website monitor, or read one monitor's up/down events
List, create, delete a website monitor, or read one monitor's up/down events
/api/v1/monitors
Description
action=list returns every monitor (data[] + deprecated); create needs a domain (and optional frequency/notifyOnOnline); delete and events need a monitorId. Monitoring is deprecated toward inleed.io. create/delete require write:hosting.
Body
Send as application/json.
| Name | Type | Description |
|---|---|---|
action
required
|
enum |
list all monitors, create one (needs domain), delete one (needs monitorId), or read one monitor's up/down events (needs monitorId). create/delete require write:hosting. One of list, create, delete, events.
|
domain
|
string |
The domain to monitor for action=create, e.g. example.com.
|
frequency
|
enum |
How often to check, in minutes (5, 10, 15 or 30) for action=create. Defaults to 5. One of 5, 10, 15, 30.
|
notify_on_online
|
boolean |
For action=create: also notify when the site recovers (comes back online), not only when it goes down. Defaults to false.
|
monitor_id
|
integer |
The monitor id for action=delete or events. Get it from action=list → data[].id.
|
limit
|
integer |
For action=events: how many status changes to return, newest first (1–100). Defaults to 50.
|
Responses
The specification does not describe this response body; the note in the rail says what to expect.
Every non-2xx response is an RFC 7807 problem with a stable
code.
Commonly returned errors
The codes this operation reaches on its own path: the auth stack, its own validation and
ownership checks, and the transport. Not a closed set — a shared code from the
full registry can still surface. Each links to the code’s own page,
the same URL its type dereferences to.