Monitors
API reference for Monitors: every handler with its fields and an example.
Last updated:
monitor: detail
Get monitor
Returns a single monitor row by id, including its target URL, linked component, and probe interval, for the monitor edit screen.
- Required scope:
monitors:read - Endpoint:
POST /api/query
| Field | Type | Required | Description |
|---|---|---|---|
id |
string (uuid) | yes |
Example request
curl -X POST https://status.example.com/api/query \
-H "Authorization: Bearer $API_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"type": "publicstatus:query:monitor:detail",
"payload": {
"id": "00000000-0000-4000-8000-000000000001"
}
}'
monitor: list
List monitors
Returns a filtered, paginated set of monitor rows, including target URL, probe interval, and enabled state, for the admin monitor list.
- Required scope:
monitors:read - Endpoint:
POST /api/query
| Field | Type | Required | Description |
|---|---|---|---|
cursor |
string | no | Position from nextCursor of the previous page. |
limit |
integer | no | Rows per page, 50 by default, at most 200. |
search |
string | no | Full-text search across the searchable fields. |
sort |
string | no | Field to sort by. |
sortDirection |
“asc” | “desc” | no | asc or desc. |
offset |
integer | no | Number of rows to skip. Prefer cursor for paging. |
totalCount |
boolean | no | Set true to also get total, the number of matching rows. |
includeDeleted |
boolean | no | Set true to include deleted rows. Only for entities with soft delete. |
onlyDeleted |
boolean | no | Set true to return only deleted rows. Only for entities with soft delete, not together with includeDeleted. |
filter |
object | no | One field filter with field, op and value. op is one of eq, ne, lt, gt, lte, gte, in. |
filter.field |
string | yes | |
filter.op |
“eq” | “ne” | “lt” | “gt” | “lte” | “gte” | “in” | yes | |
filter.value |
any | yes | |
filters |
array of object | no | Several field filters, each with field, op and value. op is one of eq, ne, lt, gt, lte, gte, in. |
namedFilter |
string | no | Name of a predefined filter of the entity, for example a work queue. |
aggregate |
object | no | Returns aggregated values instead of rows. |
aggregate.groupBy |
string | no | |
aggregate.measures |
array of object | no |
Example request
curl -X POST https://status.example.com/api/query \
-H "Authorization: Bearer $API_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"type": "publicstatus:query:monitor:list",
"payload": {}
}'
Example response
Status: 200
{
"data": {
"rows": [
{
"id": "00000000-0000-4000-8000-000000000001",
"tenantId": "00000000-0000-4000-8000-000000000002",
"version": 1,
"insertedAt": "2026-01-15T09:30:00.000Z",
"modifiedAt": null,
"insertedById": "00000000-0000-4000-8000-000000000003",
"modifiedById": null,
"name": "API health",
"kind": "http",
"url": "http://93.184.216.34/",
"keyword": null,
"keywordMode": "contains",
"host": null,
"port": null,
"sslWarnDays": 14,
"componentId": "00000000-0000-4000-8000-000000000004",
"intervalSeconds": "300",
"graceSeconds": 59,
"enabled": true,
"_refs": {
"componentId": {
"id": "00000000-0000-4000-8000-000000000004",
"tenantId": "00000000-0000-4000-8000-000000000002",
"version": 1,
"insertedAt": "2026-01-15T09:30:00.000Z",
"modifiedAt": null,
"insertedById": "00000000-0000-4000-8000-000000000003",
"modifiedById": null,
"name": "API",
"description": null,
"status": "operational",
"parentComponentId": null,
"displayOrder": 0,
"showOnPage": true,
"customFields": {}
}
}
}
],
"nextCursor": null
}
}
monitor: uptime-public
Get monitor uptime
Returns the public uptime and response-time history for one monitor, limited to monitors linked to a publicly shown component.
- Required scope:
monitors:read - Endpoint:
POST /api/query
| Field | Type | Required | Description |
|---|---|---|---|
monitorId |
string (uuid) | yes | |
range |
“24h” | “30d” | no |
Example request
curl -X POST https://status.example.com/api/query \
-H "Authorization: Bearer $API_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"type": "publicstatus:query:monitor:uptime-public",
"payload": {
"monitorId": "00000000-0000-4000-8000-000000000001",
"range": "24h"
}
}'
monitor: check-now
Run monitor check now
Immediately checks one monitor’s target and records the resulting up/down status and response time.
- Required scope:
monitors:write - Endpoint:
POST /api/write
| Field | Type | Required | Description |
|---|---|---|---|
monitorId |
string (uuid) | yes |
Example request
curl -X POST https://status.example.com/api/write \
-H "Authorization: Bearer $API_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"type": "publicstatus:write:monitor:check-now",
"payload": {
"monitorId": "00000000-0000-4000-8000-000000000001"
}
}'
monitor: create
Create monitor
Creates a new uptime monitor (HTTP, keyword, SSL expiry, TCP port or heartbeat) that periodically checks its target and records availability.
- Required scope:
monitors:write - Endpoint:
POST /api/write
| Field | Type | Required | Description |
|---|---|---|---|
name |
string | yes | Name |
kind |
“http” | “keyword” | “ssl-expiry” | “heartbeat” | “tcp-port” | no | Check type |
url |
string | no | URL |
keyword |
string | no | Keyword |
keywordMode |
“contains” | “not-contains” | no | Condition |
host |
string | no | Host |
port |
integer | no | Port |
sslWarnDays |
integer | no | Warn before expiry (days) |
componentId |
string (uuid) | no | Component |
intervalSeconds |
“60” | “300” | “600” | “1800” | “3600” | “21600” | “43200” | “86400” | “604800” | no | Check interval |
graceSeconds |
integer | no | Grace period (seconds) |
enabled |
boolean | no | Enabled |
Example request
curl -X POST https://status.example.com/api/write \
-H "Authorization: Bearer $API_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"type": "publicstatus:write:monitor:create",
"payload": {
"name": "API health",
"url": "http://93.184.216.34/",
"componentId": "00000000-0000-4000-8000-000000000001"
}
}'
Example response
Status: 200
{
"isSuccess": true,
"data": {
"kind": "save",
"id": "00000000-0000-4000-8000-000000000002",
"data": {
"id": "00000000-0000-4000-8000-000000000002",
"tenantId": "00000000-0000-4000-8000-000000000003",
"version": 1,
"insertedAt": "2026-01-15T09:30:00.000Z",
"modifiedAt": null,
"insertedById": "00000000-0000-4000-8000-000000000004",
"modifiedById": null,
"name": "API health",
"kind": "http",
"url": "http://93.184.216.34/",
"keyword": null,
"keywordMode": "contains",
"host": null,
"port": null,
"sslWarnDays": 14,
"componentId": "00000000-0000-4000-8000-000000000001",
"intervalSeconds": "300",
"graceSeconds": 59,
"enabled": true
},
"changes": {
"name": "API health",
"kind": "http",
"url": "http://93.184.216.34/",
"keywordMode": "contains",
"sslWarnDays": 14,
"componentId": "00000000-0000-4000-8000-000000000001",
"intervalSeconds": "300",
"graceSeconds": 59,
"enabled": true
},
"previous": {},
"isNew": true,
"entityName": "monitor"
}
}
monitor: delete
Delete monitor
Permanently deletes an uptime monitor and stops its periodic availability checks.
- Required scope:
monitors:write - Endpoint:
POST /api/write
| Field | Type | Required | Description |
|---|---|---|---|
id |
string (uuid) | yes |
Example request
curl -X POST https://status.example.com/api/write \
-H "Authorization: Bearer $API_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"type": "publicstatus:write:monitor:delete",
"payload": {
"id": "00000000-0000-4000-8000-000000000001"
}
}'
monitor: mint-heartbeat-token
Create heartbeat token
Generates a new ping token for a heartbeat monitor and returns its absolute ping URL once; a previous token stops working.
- Required scope:
monitors:write - Endpoint:
POST /api/write
| Field | Type | Required | Description |
|---|---|---|---|
monitorId |
string (uuid) | yes |
Example request
curl -X POST https://status.example.com/api/write \
-H "Authorization: Bearer $API_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"type": "publicstatus:write:monitor:mint-heartbeat-token",
"payload": {
"monitorId": "00000000-0000-4000-8000-000000000001"
}
}'
monitor: update
Update monitor
Updates an uptime monitor’s configuration, such as its target, check interval or the component it reports into.
- Required scope:
monitors:write - Endpoint:
POST /api/write
| Field | Type | Required | Description |
|---|---|---|---|
id |
string (uuid) | yes | |
version |
number | yes | |
changes |
object | yes | |
changes.name |
string | no | Name |
changes.kind |
“http” | “keyword” | “ssl-expiry” | “heartbeat” | “tcp-port” | no | Check type |
changes.url |
string | null | no | URL |
changes.keyword |
string | null | no | Keyword |
changes.keywordMode |
“contains” | “not-contains” | no | Condition |
changes.host |
string | null | no | Host |
changes.port |
integer | null | no | Port |
changes.sslWarnDays |
integer | no | Warn before expiry (days) |
changes.componentId |
string (uuid) | null | no | Component |
changes.intervalSeconds |
“60” | “300” | “600” | “1800” | “3600” | “21600” | “43200” | “86400” | “604800” | no | Check interval |
changes.graceSeconds |
integer | no | Grace period (seconds) |
changes.enabled |
boolean | no | Enabled |
Example request
curl -X POST https://status.example.com/api/write \
-H "Authorization: Bearer $API_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"type": "publicstatus:write:monitor:update",
"payload": {
"id": "00000000-0000-4000-8000-000000000001",
"version": 1,
"changes": {
"name": "text",
"kind": "http",
"url": "text",
"keyword": "text",
"keywordMode": "contains",
"host": "text",
"port": 1,
"sslWarnDays": 1,
"componentId": "00000000-0000-4000-8000-000000000001",
"intervalSeconds": "60",
"graceSeconds": 1,
"enabled": true
}
}
}'