API

Components

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

Última actualización:

component: detail

Obtener componente

Devuelve un componente por su ID, con estado, componente superior, orden y campos personalizados.

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

component: list

Listar componentes

Devuelve una lista filtrada y paginada de componentes, también los ocultos, con su estado y agrupación.

  • Scope necesario: components: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:component: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",
        "description": null,
        "status": "operational",
        "parentComponentId": null,
        "displayOrder": 0,
        "showOnPage": true,
        "customFields": {}
      }
    ],
    "nextCursor": null
  }
}

component: create

Crear componente

Crea un componente nuevo de la página de estado, que se muestra con su propio estado operativo.

  • Scope necesario: components:write
  • Endpoint: POST /api/write
Campo Tipo Obligatorio Descripción
name string sí Nombre
description string no Descripción
status “operational” | “degraded-performance” | “partial-outage” | “major-outage” | “under-maintenance” no Estado
parentComponentId string no Componente superior
displayOrder integer no Orden
showOnPage boolean no Público
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:component:create",
  "payload": {
    "name": "API"
  }
}'

Respuesta de ejemplo

Estado: 200

{
  "isSuccess": true,
  "data": {
    "kind": "save",
    "id": "00000000-0000-4000-8000-000000000001",
    "data": {
      "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",
      "description": null,
      "status": "operational",
      "parentComponentId": null,
      "displayOrder": 0,
      "showOnPage": true,
      "customFields": {}
    },
    "changes": {
      "name": "API",
      "status": "operational",
      "displayOrder": 0,
      "showOnPage": true
    },
    "previous": {},
    "isNew": true,
    "entityName": "component"
  }
}

component: delete

Eliminar componente

Elimina un componente de forma permanente. Los vínculos de incidencias y mantenimientos anteriores apuntan entonces a un componente que ya no existe.

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

component: update

Modificar componente

Modifica los campos de un componente, incluido el estado operativo que ven los visitantes.

  • Scope necesario: components: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.description string | null no Descripción
changes.status “operational” | “degraded-performance” | “partial-outage” | “major-outage” | “under-maintenance” no Estado
changes.parentComponentId string | null no Componente superior
changes.displayOrder integer no Orden
changes.showOnPage boolean no Público
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:component:update",
  "payload": {
    "id": "00000000-0000-4000-8000-000000000001",
    "version": 1,
    "changes": {
      "name": "text",
      "description": "text",
      "status": "operational",
      "parentComponentId": "text",
      "displayOrder": 1,
      "showOnPage": true,
      "customFields": {}
    }
  }
}'