Incidents
Referencia de la API para Incidents: cada handler con sus campos y un ejemplo.
Última actualización:
incident: detail
Obtener incidencia
Devuelve una incidencia por su ID, con estado, gravedad, inicio, hora de resolución y campos personalizados.
- Scope necesario:
incidents: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:incident:detail",
"payload": {
"id": "00000000-0000-4000-8000-000000000001"
}
}'
incident: list
Listar incidencias
Devuelve una lista filtrada y paginada de incidencias, también las resueltas, con estado, gravedad e inicio.
- Scope necesario:
incidents: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:incident:list",
"payload": {}
}'
Respuesta de ejemplo
Estado: 200
{
"data": {
"rows": [
{
"id": "00000000-0000-4000-8000-000000000001",
"tenantId": "00000000-0000-4000-8000-000000000002",
"version": 3,
"insertedAt": "2026-01-15T09:30:00.000Z",
"modifiedAt": null,
"insertedById": "00000000-0000-4000-8000-000000000003",
"modifiedById": null,
"title": "Elevated API errors",
"status": "investigating",
"severity": "major",
"startedAt": "2026-01-15T09:30:00.000Z",
"resolvedAt": null,
"sourceMonitorId": null,
"customFields": {}
}
],
"nextCursor": null
}
}
incident: updates
Listar actualizaciones de una incidencia
Devuelve la cronología de las actualizaciones de una incidencia, cada una con el nombre visible de su autor.
- Scope necesario:
incidents:read - Endpoint:
POST /api/query
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
incidentId |
string (uuid) | sí | Incidencia |
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:incident:updates",
"payload": {
"incidentId": "00000000-0000-4000-8000-000000000001"
}
}'
incident: open
Abrir incidencia
Abre una incidencia nueva en la página de estado, la vincula a los componentes afectados y registra la primera actualización en su cronología.
- Scope necesario:
incidents:write - Endpoint:
POST /api/write
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
title |
string | sí | Título |
body |
string | sí | Descripción |
severity |
“minor” | “major” | “critical” | no | Gravedad |
componentIds |
array of string (uuid) | no | Componentes afectados |
startedAt |
string (date-time) | no | Inicio |
sourceMonitorId |
string (uuid) | no |
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:incident:open",
"payload": {
"title": "Elevated API errors",
"body": "We are investigating elevated error rates.",
"severity": "major",
"componentIds": [
"00000000-0000-4000-8000-000000000001"
]
}
}'
Respuesta de ejemplo
Estado: 200
{
"isSuccess": true,
"data": {
"id": "00000000-0000-4000-8000-000000000002"
}
}
incident: post-update
Publicar actualización de una incidencia
Añade una actualización a una incidencia abierta y, si se desea, cambia su estado en la misma llamada.
- Scope necesario:
incidents:write - Endpoint:
POST /api/write
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
incidentId |
string (uuid) | sí | Incidencia |
body |
string | sí | Descripción |
newStatus |
“investigating” | “identified” | “monitoring” | “resolved” | no | Estado nuevo |
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:incident:post-update",
"payload": {
"incidentId": "00000000-0000-4000-8000-000000000001",
"body": "text",
"newStatus": "investigating"
}
}'
incident: resolve
Resolver incidencia
Marca una incidencia abierta como resuelta, registra la hora de resolución y añade una actualización final a la cronología.
- Scope necesario:
incidents:write - Endpoint:
POST /api/write
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
incidentId |
string (uuid) | sí | Incidencia |
body |
string | sí | Descripción |
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:incident:resolve",
"payload": {
"incidentId": "00000000-0000-4000-8000-000000000001",
"body": "text"
}
}'
incident: update
Modificar incidencia
Modifica el título, la gravedad, el inicio y los campos personalizados de una incidencia sin tocar su estado. El estado solo lo cambian las llamadas para abrir, actualizar y resolver.
- Scope necesario:
incidents:write - Endpoint:
POST /api/write
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
id |
string (uuid) | sí | |
version |
number | sí | |
changes |
object | sí | |
changes.title |
string | no | Título |
changes.status |
“investigating” | “identified” | “monitoring” | “resolved” | no | Estado |
changes.severity |
“minor” | “major” | “critical” | no | Gravedad |
changes.startedAt |
string (date-time) | no | Inicio |
changes.resolvedAt |
string (date-time) | null | no | Resuelta |
changes.sourceMonitorId |
string | null | no | |
changes.customFields |
object | no |
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:incident:update",
"payload": {
"id": "00000000-0000-4000-8000-000000000001",
"version": 1,
"changes": {
"title": "text",
"status": "investigating",
"severity": "minor",
"startedAt": "2026-01-15T09:30:00.000Z",
"resolvedAt": "2026-01-15T09:30:00.000Z",
"sourceMonitorId": "text",
"customFields": {}
}
}
}'