API

Maintenance

Referencia de la API para Maintenance: cada handler con sus campos y un ejemplo.

Última actualización:

maintenance: detail

Obtener mantenimiento

Devuelve un mantenimiento por su ID, con estado, horas previstas y reales y texto del anuncio.

  • Scope necesario: maintenance: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:maintenance:detail",
  "payload": {
    "id": "00000000-0000-4000-8000-000000000001"
  }
}'

maintenance: list

Listar mantenimientos

Devuelve una lista filtrada y paginada de mantenimientos, también los pasados y cancelados, con estado y ventana prevista.

  • Scope necesario: maintenance: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:maintenance:list",
  "payload": {}
}'

Respuesta de ejemplo

Estado: 200

{
  "data": {
    "rows": [
      {
        "id": "00000000-0000-4000-8000-000000000001",
        "tenantId": "00000000-0000-4000-8000-000000000002",
        "version": 2,
        "insertedAt": "2026-01-15T09:30:00.000Z",
        "modifiedAt": null,
        "insertedById": "00000000-0000-4000-8000-000000000003",
        "modifiedById": null,
        "title": "Database upgrade",
        "body": "Short read-only period while we upgrade the database.",
        "status": "scheduled",
        "scheduledStart": "2026-01-15T09:30:00.000Z",
        "scheduledEnd": "2026-01-15T09:30:00.000Z",
        "startedAt": null,
        "completedAt": null,
        "cancelledAt": null
      }
    ],
    "nextCursor": null
  }
}

maintenance: cancel

Cancelar mantenimiento

Cancela un mantenimiento programado o en curso y registra la hora de la cancelación.

  • Scope necesario: maintenance:write
  • Endpoint: POST /api/write
Campo Tipo Obligatorio Descripción
id string (uuid) sí
version number 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:maintenance:cancel",
  "payload": {
    "id": "00000000-0000-4000-8000-000000000001",
    "version": 1
  }
}'

maintenance: complete

Completar mantenimiento

Marca un mantenimiento en curso como completado y registra su hora real de finalización.

  • Scope necesario: maintenance:write
  • Endpoint: POST /api/write
Campo Tipo Obligatorio Descripción
id string (uuid) sí
version number 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:maintenance:complete",
  "payload": {
    "id": "00000000-0000-4000-8000-000000000001",
    "version": 1
  }
}'

maintenance: schedule

Programar mantenimiento

Programa una nueva ventana de mantenimiento con título, descripción y periodo y, si se desea, la vincula a los componentes afectados.

  • Scope necesario: maintenance:write
  • Endpoint: POST /api/write
Campo Tipo Obligatorio Descripción
title string sí Título
body string sí Descripción
scheduledStart string (date-time) sí Inicio previsto
scheduledEnd string (date-time) sí Fin prevista
componentIds array of string (uuid) no Componentes afectados

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:maintenance:schedule",
  "payload": {
    "title": "Database upgrade",
    "body": "Short read-only period while we upgrade the database.",
    "scheduledStart": "2026-01-15T09:30:00.000Z",
    "scheduledEnd": "2026-01-15T09:30:00.000Z",
    "componentIds": [
      "00000000-0000-4000-8000-000000000001"
    ]
  }
}'

Respuesta de ejemplo

Estado: 200

{
  "isSuccess": true,
  "data": {
    "id": "00000000-0000-4000-8000-000000000002"
  }
}

maintenance: start

Iniciar mantenimiento

Pasa un mantenimiento programado a en curso y registra su hora real de inicio.

  • Scope necesario: maintenance:write
  • Endpoint: POST /api/write
Campo Tipo Obligatorio Descripción
id string (uuid) sí
version number 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:maintenance:start",
  "payload": {
    "id": "00000000-0000-4000-8000-000000000001",
    "version": 1
  }
}'