Ir al contenido

API

API REST de Pingio

Todo lo que hace el panel de control está disponible por HTTPS, así que la monitorización puede vivir en el mismo repositorio que tu infraestructura.

URL base y versionado

Todos los endpoints cuelgan de un prefijo con versión. Los cambios que rompen la compatibilidad salen como una versión nueva; los cambios aditivos se aplican sobre la misma.

https://pingio.io/api/v1

Autenticación

Las peticiones se autentican con un token de portador emitido para tu equipo. Guarda el token en el servidor y rótalo si alguna vez queda expuesto.

curl https://pingio.io/api/v1/monitors \
  -H "Authorization: Bearer $PINGIO_TOKEN"

Crear un monitor

Envía un cuerpo JSON que describa el objetivo y las aserciones. La respuesta contiene el monitor creado, incluido el identificador que usarás en las siguientes peticiones.

curl -X POST https://pingio.io/api/v1/monitors \
  -H "Authorization: Bearer $PINGIO_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Production API",
    "type": "http",
    "target": "https://api.example.com/health",
    "intervalSeconds": 60
  }'

Límites de uso y errores

La API permite un ritmo de peticiones generoso por equipo y devuelve códigos de estado HTTP estándar. Los errores incluyen un código legible por máquina y un mensaje legible por personas.

Una respuesta 429 incluye la cabecera Retry-After. Trátala como una señal para reducir el ritmo, no para reintentar de inmediato.