Monitors
Referencia de la API para Monitors: cada handler con sus campos y un ejemplo.
Última actualización:
monitor: detail
Obtener monitor
Devuelve un monitor por su ID, con URL de destino, componente vinculado e intervalo de comprobación.
- Scope necesario:
monitors:read - Endpoint:
POST /api/query
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
id |
string (uuid) | sí |
Petición de ejemplo
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
Listar monitores
Devuelve una lista filtrada y paginada de monitores, con URL de destino, intervalo de comprobación y estado activo.
- Scope necesario:
monitors:read - Endpoint:
POST /api/query
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
cursor |
string | no | Posición de nextCursor de la página anterior. |
limit |
integer | no | Filas por página, 50 por defecto, como máximo 200. |
search |
string | no | Búsqueda de texto completo en los campos con búsqueda. |
sort |
string | no | Campo por el que ordenar. |
sortDirection |
“asc” | “desc” | no | asc o desc. |
offset |
integer | no | Número de filas que se omiten. Para paginar es mejor cursor. |
totalCount |
boolean | no | Con true recibes además total, el número de filas que coinciden. |
includeDeleted |
boolean | no | Con true se incluyen las filas eliminadas. Solo para entidades con borrado lógico. |
onlyDeleted |
boolean | no | Con true solo se devuelven las filas eliminadas. Solo para entidades con borrado lógico, no junto con includeDeleted. |
filter |
object | no | Un filtro de campo con field, op y value. op es uno de eq, ne, lt, gt, lte, gte, in. |
filter.field |
string | sí | |
filter.op |
“eq” | “ne” | “lt” | “gt” | “lte” | “gte” | “in” | sí | |
filter.value |
any | sí | |
filters |
array of object | no | Varios filtros de campo, cada uno con field, op y value. op es uno de eq, ne, lt, gt, lte, gte, in. |
namedFilter |
string | no | Nombre de un filtro predefinido de la entidad, por ejemplo una cola de trabajo. |
aggregate |
object | no | Devuelve valores agregados en lugar de filas. |
aggregate.groupBy |
string | no | |
aggregate.measures |
array of object | no |
Petición de ejemplo
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": {}
}'
Respuesta de ejemplo
Estado: 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
Obtener disponibilidad de un monitor
Devuelve el historial público de disponibilidad y tiempo de respuesta de un monitor, limitado a los monitores vinculados a un componente que se muestra públicamente.
- Scope necesario:
monitors:read - Endpoint:
POST /api/query
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
monitorId |
string (uuid) | sí | |
range |
“24h” | “30d” | no |
Petición de ejemplo
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
Ejecutar la comprobación de un monitor ahora
Comprueba de inmediato el destino de un monitor y registra si está activo o caído y su tiempo de respuesta.
- Scope necesario:
monitors:write - Endpoint:
POST /api/write
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
monitorId |
string (uuid) | sí |
Petición de ejemplo
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
Crear monitor
Crea un monitor nuevo (HTTP, palabra clave, caducidad SSL, puerto TCP o heartbeat) que comprueba su destino periódicamente y registra la disponibilidad.
- Scope necesario:
monitors:write - Endpoint:
POST /api/write
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
name |
string | sí | Nombre |
kind |
“http” | “keyword” | “ssl-expiry” | “heartbeat” | “tcp-port” | no | Tipo de comprobación |
url |
string | no | URL |
keyword |
string | no | Palabra clave |
keywordMode |
“contains” | “not-contains” | no | Condición |
host |
string | no | Host |
port |
integer | no | Puerto |
sslWarnDays |
integer | no | Aviso antes del vencimiento (días) |
componentId |
string (uuid) | no | Componente |
intervalSeconds |
“60” | “300” | “600” | “1800” | “3600” | “21600” | “43200” | “86400” | “604800” | no | Intervalo de comprobación |
graceSeconds |
integer | no | Periodo de gracia (segundos) |
enabled |
boolean | no | Activo |
Petición de ejemplo
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"
}
}'
Respuesta de ejemplo
Estado: 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
Eliminar monitor
Elimina un monitor de forma permanente y detiene sus comprobaciones periódicas.
- Scope necesario:
monitors:write - Endpoint:
POST /api/write
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
id |
string (uuid) | sí |
Petición de ejemplo
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
Crear token de heartbeat
Genera un token de ping nuevo para un monitor heartbeat y devuelve una vez la URL de ping completa. El token anterior deja de funcionar.
- Scope necesario:
monitors:write - Endpoint:
POST /api/write
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
monitorId |
string (uuid) | sí |
Petición de ejemplo
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
Modificar monitor
Modifica la configuración de un monitor, como su destino, el intervalo de comprobación o el componente al que informa.
- Scope necesario:
monitors:write - Endpoint:
POST /api/write
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
id |
string (uuid) | sí | |
version |
number | sí | |
changes |
object | sí | |
changes.name |
string | no | Nombre |
changes.kind |
“http” | “keyword” | “ssl-expiry” | “heartbeat” | “tcp-port” | no | Tipo de comprobación |
changes.url |
string | null | no | URL |
changes.keyword |
string | null | no | Palabra clave |
changes.keywordMode |
“contains” | “not-contains” | no | Condición |
changes.host |
string | null | no | Host |
changes.port |
integer | null | no | Puerto |
changes.sslWarnDays |
integer | no | Aviso antes del vencimiento (días) |
changes.componentId |
string (uuid) | null | no | Componente |
changes.intervalSeconds |
“60” | “300” | “600” | “1800” | “3600” | “21600” | “43200” | “86400” | “604800” | no | Intervalo de comprobación |
changes.graceSeconds |
integer | no | Periodo de gracia (segundos) |
changes.enabled |
boolean | no | Activo |
Petición de ejemplo
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
}
}
}'