Documentación de PulseAPI
PulseAPI monitorea tus endpoints de API y te alerta cuando algo falla. Esta documentación cubre configuración, la API REST y conceptos clave.
Conceptos clave
URLs que deseas monitorear. Cada endpoint se verifica en un intervalo configurable (1 min a 1 hora) mediante HTTP.
Sondas de monitoreo individuales. Cada check registra código de estado, tiempo de respuesta y resultados opcionales de aserciones.
Se activan automáticamente tras 2+ fallos consecutivos. Las alertas de recuperación se envían cuando el endpoint vuelve. Las alertas de respuesta lenta están limitadas a 1/hora.
Páginas públicas que muestran el estado de los endpoints, barras de disponibilidad e incidentes. Soportan dominios personalizados y branding.
Rastrea interrupciones con actualizaciones de línea de tiempo, niveles de severidad y postmortems. Los suscriptores son notificados automáticamente.
URL base
Todos los endpoints de la API son relativos a esta URL base.
Ejemplo rápido
# Create an API key in Dashboard > Settings > API Keys, then:
# List your endpoints
curl -H "Authorization: pk_live_abc123..." \
https://api.pulseapi.tech/endpoints
# Create a new endpoint
curl -X POST https://api.pulseapi.tech/endpoints \
-H "Authorization: pk_live_abc123..." \
-H "Content-Type: application/json" \
-d '{"name":"My API","url":"https://api.example.com/health","method":"GET","checkInterval":300,"timeout":10}'
# Check uptime stats
curl -H "Authorization: pk_live_abc123..." \
"https://api.pulseapi.tech/endpoints/ENDPOINT_ID/stats?period=24h"¿Listo para empezar? Lee la Primeros pasos o salta a la Referencia de API.