Referencia de Endpoints

Listado completo de endpoints REST de la API de MonitorNOC para gestionar monitores, incidentes y páginas de estado.

Esta es la referencia de endpoints de la API de MonitorNOC. Todas las respuestas se entregan en formato JSON y requieren cabecera Bearer Token de autorización.


1. Monitores (Targets)

Obtener listado de monitores

GET /targets
  • Respuesta (200 OK):
    [
      {
        "id": 42,
        "name": "Servidor Web",
        "host": "web.empresa.com",
        "checks_active": ["http", "ssl"],
        "status": "UP"
      }
    ]

Crear un nuevo monitor

POST /targets
  • Body (JSON):
    {
      "name": "API Pasarela",
      "host": "api.empresa.com",
      "checks": ["http", "ssl", "dns"],
      "alert_telegram": true
    }
  • Respuesta (201 Created): Devuelve el objeto del monitor creado con su ID correspondiente.

2. Incidentes (Incidents)

Listar incidentes recientes

GET /incidents?status=active
  • Parámetros de consulta (opcional):
    • status: Filtro por estado (active, resolved).
    • limit: Cantidad máxima de registros a retornar (por defecto 20).

Actualizar controles de un incidente

POST /incidents/:id/status
  • Body (JSON):
    {
      "status": "resolved",
      "severity": "critical",
      "impact_scope": "total"
    }
  • Respuesta (200 OK): Devuelve un mensaje de éxito auditando el cambio de estado.

3. Páginas de Estado (Status Pages)

Obtener listado de status pages

GET /status-pages
  • Respuesta (200 OK): Lista de páginas configuradas por tu organización con sus slugs y visibilidades correspondientes.