API

OBSIDIUM expone una API interna utilizada por los agentes para enviar métricas al servidor central. Esta API no está disponible públicamente y solo es accesible a través de la red privada (VPN).

Visión general

• Tipo: REST
• Formato: JSON
• Acceso: Red privada (VPN)
• Autenticación: Token

Endpoint principal

POST /api/metrics

Este endpoint recibe las métricas enviadas por los agentes instalados en los nodos cliente.

Headers

Content-Type: application/json
Authorization: Bearer API_KEY

Body (ejemplo)

{
  "hostname": "server-01",
  "cpu": 35.5,
  "memory": 62.3,
  "disk": 80.1,
  "services": {
    "nginx": "running",
    "mysql": "running"
  },
  "timestamp": "2026-04-13T10:00:00Z"
}

Campos

• hostname: Identificador del nodo
• cpu: Uso de CPU (%)
• memory: Uso de memoria (%)
• disk: Uso de disco (%)
• services: Estado de servicios monitorizados
• timestamp: Fecha y hora de la métrica

Respuesta del servidor

{
  "status": "success",
  "message": "Métricas recibidas correctamente"
}

Códigos de estado

• 200 OK: Datos recibidos correctamente
• 400 Bad Request: Datos inválidos
• 401 Unauthorized: Token inválido o ausente
• 500 Internal Server Error: Error en el servidor

Seguridad

• Acceso restringido a la VPN.
• Validación de token en cada petición.
• Filtrado de datos recibidos.

Flujo de comunicación

1. El agente recoge métricas.
2. Construye un JSON con los datos.
3. Envía una petición POST al servidor.
4. El servidor valida y almacena la información.

Notas

Esta API está diseñada exclusivamente para comunicación interna entre agentes y servidor, por lo que no se recomienda su exposición a internet.