Buscar en la documentación

Sistema

Salud, eventos, acciones del Super admin y el propio contrato.

10 endpointsGET · 5PATCH · 1POST · 2DELETE · 1PUT · 1
GET/system/healthPanel de salud
Permiso
system.health.view

Cabeceras de la petición

CabeceraValorPara qué
AuthorizationBearer trazo_…Token de sesión que entrega el ingreso
Acceptapplication/jsonLa API siempre responde JSON (o un archivo, en la exportación)

Respuesta 200

CampoTipo
dataobjeto
data.checked_attexto
data.statustexto
data.componentslista de objeto
data.maintenanceobjeto | null
data.maintenance.sincetexto
data.maintenance.enabled_bytexto
data.appobjeto
data.app.environmenttexto
data.app.laraveltexto
data.app.phptexto
{
  "data": {
    "checked_at": "2026-11-01T14:30:00Z",
    "status": "in_progress",
    "components": [
      "texto"
    ],
    "maintenance": {
      "since": "2026-11-01T14:30:00Z",
      "enabled_by": "texto"
    },
    "app": {
      "environment": "texto",
      "laravel": "texto",
      "php": "texto"
    }
  }
}
Cabecera de la respuestaPara qué
X-Request-IdIdentificador de la petición; es el trace_id de los errores

Errores posibles

  • 401Sin sesión o la sesión expiró (UNAUTHENTICATED)

Todos llegan en formato RFC 9457 con su code y trace_id: ver Errores de la API.

Ver el módulo en la biblioteca
GET/system/eventsEventos por cursor, con filtros
Permiso
system.logs.view

Cabeceras de la petición

CabeceraValorPara qué
AuthorizationBearer trazo_…Token de sesión que entrega el ingreso
Acceptapplication/jsonLa API siempre responde JSON (o un archivo, en la exportación)

Parámetros

NombreDóndeTipoObligatorio
per_pageConsultaentero · ≥ 1 · ≤ 100No
cursorConsultatexto · máx. 100No
filter[status][]Consultalista de objetoNo
filter[severity][]Consulta"info" | "warning" | "critical"No
filter[type][]Consultalista de textoNo

Respuesta 200

CampoTipo
datalista de objeto
metaobjeto
meta.next_cursortexto | null
{
  "data": [
    "texto"
  ],
  "meta": {
    "next_cursor": "texto"
  }
}
Cabecera de la respuestaPara qué
X-Request-IdIdentificador de la petición; es el trace_id de los errores

Errores posibles

  • 401Sin sesión o la sesión expiró (UNAUTHENTICATED)
  • 403Sin permiso para esta acción
  • 422Algún dato no es válido (VALIDATION_FAILED, con el detalle por campo)

Todos llegan en formato RFC 9457 con su code y trace_id: ver Errores de la API.

Ver el módulo en la biblioteca
GET/system/events/typesCatálogo de tipos, para el filtro
Permiso
system.logs.view

Cabeceras de la petición

CabeceraValorPara qué
AuthorizationBearer trazo_…Token de sesión que entrega el ingreso
Acceptapplication/jsonLa API siempre responde JSON (o un archivo, en la exportación)

Respuesta 200

CampoTipo
datalista de objeto
{
  "data": [
    "texto"
  ]
}
Cabecera de la respuestaPara qué
X-Request-IdIdentificador de la petición; es el trace_id de los errores

Errores posibles

  • 401Sin sesión o la sesión expiró (UNAUTHENTICATED)

Todos llegan en formato RFC 9457 con su code y trace_id: ver Errores de la API.

Ver el módulo en la biblioteca
PATCH/system/events/{event}Cambiar el estado (status)
Permiso
system.logs.view

Cabeceras de la petición

CabeceraValorPara qué
AuthorizationBearer trazo_…Token de sesión que entrega el ingreso
Acceptapplication/jsonLa API siempre responde JSON (o un archivo, en la exportación)
Content-Typeapplication/jsonCuerpo en JSON
X-Socket-IDopcionalPara no recibir en tiempo real el aviso de tu propio cambio

Parámetros

NombreDóndeTipoObligatorio
eventRutaenteroSí

Cuerpo

CampoTipoObligatorio
status"open" | "acknowledged" | "resolved"Sí
{
  "status": "open"
}

Respuesta 200

CampoTipo
dataobjeto
data.identero
data.typeobjeto
data.type.codetexto
data.type.nametexto
data.type.categorytexto
data.type.severitytexto
data.messagetexto
data.contextobjeto | null
data.occurrencesentero
data.first_seen_attexto
data.last_seen_attexto
data.trace_idtexto | null
data.statustexto
data.status_changed_bytexto | null
data.status_changed_attexto | null
{
  "data": {
    "id": 1,
    "type": {
      "code": "in_progress",
      "name": "Andrés Castro",
      "category": "texto",
      "severity": "texto"
    },
    "message": "El correo no llega desde esta mañana.",
    "context": {},
    "occurrences": 12,
    "first_seen_at": "2026-11-01T14:30:00Z",
    "last_seen_at": "2026-11-01T14:30:00Z",
    "trace_id": "01jbzk8m3q9w2e5r7t1y4u6i0p",
    "status": "in_progress",
    "status_changed_by": "in_progress",
    "status_changed_at": "2026-11-01T14:30:00Z"
  }
}
Cabecera de la respuestaPara qué
X-Request-IdIdentificador de la petición; es el trace_id de los errores

Errores posibles

  • 401Sin sesión o la sesión expiró (UNAUTHENTICATED)
  • 403Sin permiso para esta acción
  • 404No existe o quien pregunta no puede verlo
  • 422Algún dato no es válido (VALIDATION_FAILED, con el detalle por campo)

Todos llegan en formato RFC 9457 con su code y trace_id: ver Errores de la API.

Ver el módulo en la biblioteca
GET/system/failed-jobsLos 50 jobs fallidos más recientes y el total
Permiso
system.health.view

Cabeceras de la petición

CabeceraValorPara qué
AuthorizationBearer trazo_…Token de sesión que entrega el ingreso
Acceptapplication/jsonLa API siempre responde JSON (o un archivo, en la exportación)

Respuesta 200

CampoTipo
datalista de objeto
metaobjeto
meta.totalentero
{
  "data": [
    "texto"
  ],
  "meta": {
    "total": 12
  }
}
Cabecera de la respuestaPara qué
X-Request-IdIdentificador de la petición; es el trace_id de los errores

Errores posibles

  • 401Sin sesión o la sesión expiró (UNAUTHENTICATED)

Todos llegan en formato RFC 9457 con su code y trace_id: ver Errores de la API.

Ver el módulo en la biblioteca
POST/system/failed-jobs/retryReintentar ids o all: true
Permiso
Acción

Cabeceras de la petición

CabeceraValorPara qué
AuthorizationBearer trazo_…Token de sesión que entrega el ingreso
Acceptapplication/jsonLa API siempre responde JSON (o un archivo, en la exportación)
Content-Typeapplication/jsonCuerpo en JSON
X-Socket-IDopcionalPara no recibir en tiempo real el aviso de tu propio cambio

Cuerpo

CampoTipoObligatorio
mfa_codetexto | null · máx. 20No
allsí/noNo
idslista de textoNo
{
  "mfa_code": "482913",
  "all": true,
  "ids": [
    "01jbzk8m3q9w2e5r7t1y4u6i0p"
  ]
}

Respuesta 200

CampoTipo
dataobjeto
data.retriedentero
{
  "data": {
    "retried": 1
  }
}
Cabecera de la respuestaPara qué
X-Request-IdIdentificador de la petición; es el trace_id de los errores

Errores posibles

  • 401Sin sesión o la sesión expiró (UNAUTHENTICATED)
  • 403Sin permiso para esta acción
  • 422Algún dato no es válido (VALIDATION_FAILED, con el detalle por campo)

Todos llegan en formato RFC 9457 con su code y trace_id: ver Errores de la API.

Ver el módulo en la biblioteca
DELETE/system/failed-jobs/{job}Descartar uno
Permiso
Acción

Cabeceras de la petición

CabeceraValorPara qué
AuthorizationBearer trazo_…Token de sesión que entrega el ingreso
Acceptapplication/jsonLa API siempre responde JSON (o un archivo, en la exportación)
X-Socket-IDopcionalPara no recibir en tiempo real el aviso de tu propio cambio

Parámetros

NombreDóndeTipoObligatorio
jobRutatextoSí
mfa_codeConsultatexto | null · máx. 20No

Respuesta 204

Sin cuerpo: la operación salió bien.

Cabecera de la respuestaPara qué
X-Request-IdIdentificador de la petición; es el trace_id de los errores

Errores posibles

  • 401Sin sesión o la sesión expiró (UNAUTHENTICATED)
  • 403Sin permiso para esta acción
  • 404No existe o quien pregunta no puede verlo
  • 422Algún dato no es válido (VALIDATION_FAILED, con el detalle por campo)

Todos llegan en formato RFC 9457 con su code y trace_id: ver Errores de la API.

Ver el módulo en la biblioteca
POST/system/actions/{action}restart-workers, restart-realtime o clear-cache
Permiso
Acción

Cabeceras de la petición

CabeceraValorPara qué
AuthorizationBearer trazo_…Token de sesión que entrega el ingreso
Acceptapplication/jsonLa API siempre responde JSON (o un archivo, en la exportación)
Content-Typeapplication/jsonCuerpo en JSON
X-Socket-IDopcionalPara no recibir en tiempo real el aviso de tu propio cambio

Parámetros

NombreDóndeTipoObligatorio
actionRutatextoSí

Cuerpo

CampoTipoObligatorio
mfa_codetexto | null · máx. 20No
{
  "mfa_code": "482913"
}

Respuesta 204

Sin cuerpo: la operación salió bien.

Cabecera de la respuestaPara qué
X-Request-IdIdentificador de la petición; es el trace_id de los errores

Errores posibles

  • 401Sin sesión o la sesión expiró (UNAUTHENTICATED)
  • 403Sin permiso para esta acción
  • 404No existe o quien pregunta no puede verlo
  • 422Algún dato no es válido (VALIDATION_FAILED, con el detalle por campo)

Todos llegan en formato RFC 9457 con su code y trace_id: ver Errores de la API.

Ver el módulo en la biblioteca
PUT/system/maintenanceActivar o desactivar (enabled)
Permiso
Acción

Cabeceras de la petición

CabeceraValorPara qué
AuthorizationBearer trazo_…Token de sesión que entrega el ingreso
Acceptapplication/jsonLa API siempre responde JSON (o un archivo, en la exportación)
Content-Typeapplication/jsonCuerpo en JSON
X-Socket-IDopcionalPara no recibir en tiempo real el aviso de tu propio cambio

Cuerpo

CampoTipoObligatorio
mfa_codetexto | null · máx. 20No
enabledsí/noSí
{
  "mfa_code": "482913",
  "enabled": true
}

Respuesta 204

Sin cuerpo: la operación salió bien.

Cabecera de la respuestaPara qué
X-Request-IdIdentificador de la petición; es el trace_id de los errores

Errores posibles

  • 401Sin sesión o la sesión expiró (UNAUTHENTICATED)
  • 403Sin permiso para esta acción
  • 422Algún dato no es válido (VALIDATION_FAILED, con el detalle por campo)

Todos llegan en formato RFC 9457 con su code y trace_id: ver Errores de la API.

Ver el módulo en la biblioteca
GET/docsContrato OpenAPI en JSON (API)
Permiso
system.health.view

Cabeceras de la petición

CabeceraValorPara qué
AuthorizationBearer trazo_…Token de sesión que entrega el ingreso
Acceptapplication/jsonLa API siempre responde JSON (o un archivo, en la exportación)

Respuesta 200

Cabecera de la respuestaPara qué
X-Request-IdIdentificador de la petición; es el trace_id de los errores

Errores posibles

  • 401Sin sesión o la sesión expiró (UNAUTHENTICATED)

Todos llegan en formato RFC 9457 con su code y trace_id: ver Errores de la API.

Ver el módulo en la biblioteca