Ayuda y guíasAPI e integraciones › Resumen endpoints API

Resumen endpoints API

5 min de lectura · API e integraciones

Resumen de todos los endpoints de la API disponibles (las distintas URL de la API REST a las que se llama). URL base: https://epulz.io/api/v1

Autorización: envíe la cabecera Authorization: Bearer epulzio_.... El límite de solicitudes (rate limit) es de 60 solicitudes por minuto por token. El token se genera en Ajustes -> Tokens de API.

Gestión de tokens de API para el acceso a la API REST
El token para las llamadas a la API lo crea y gestiona en la sección Tokens de API.

Estado / comprobación del token

  • GET /status - verifica el token, devuelve el correo electrónico, el plan, el número de monitores y el número de incidentes abiertos.

Monitores

  • GET /monitors - lista de todos sus monitores (incluida la disponibilidad de las últimas 24 h).
  • GET /monitors/{id} - detalle de un único monitor.
  • POST /monitors - crea un nuevo monitor. En el cuerpo de la solicitud (JSON) envíe los campos name, type, target, interval_minutes, expected_status, expected_keyword, forbidden_keyword.
  • POST /monitors/bulk - importación masiva (como máximo 200 monitores en una sola solicitud).
  • PATCH /monitors/{id} - modificación de un monitor existente (envíe solo los campos que desee cambiar).
  • POST /monitors/{id}/check - ejecuta una comprobación inmediata fuera del intervalo programado; devuelve el monitor actualizado.
  • GET /monitors/{id}/uptime?days=30 - disponibilidad en % durante los últimos N días (1-365, predeterminado 30); las ventanas de mantenimiento quedan excluidas.
  • DELETE /monitors/{id} - elimina el monitor (junto con el historial de comprobaciones e incidentes).

Comprobaciones (historial)

  • GET /monitors/{id}/checks?limit=100 - las últimas N comprobaciones de un monitor (estado, tiempo de respuesta, HTTP status code, posible error, región). El parámetro limit puede ser de 1 a 500, predeterminado 50.

Incidentes

  • GET /incidents - lista de incidentes. Filtros opcionales: monitor_id, resolved (true/false), limit (1-500, predeterminado 50).

Códigos de error

  • 401 - token ausente o no válido.
  • 403 - límite de monitores de su plan superado (al crear).
  • 404 - el monitor no le pertenece o no existe.
  • 429 - límite de solicitudes superado (60 por minuto por token).

Documentación legible por máquina

La especificación completa en el estándar OpenAPI está disponible en /api/openapi.json. La documentación interactiva, donde puede probar los endpoints directamente (Swagger UI), se encuentra en /api/docs. Ambas requieren inicio de sesión o un token válido.

¿Te ha resultado útil esta guía?