¿Cómo publico una actualización de estado desde un script?
Envía POST /api/v1/services/{slug}/status con tu clave de la interfaz de programación de aplicaciones (API) y un cuerpo en JavaScript Object Notation (JSON) que tenga un status y un message.
Antes de empezar
- Tienes una clave de API para el servicio.
Ejemplo
curl -X POST https://statusraptor.com/api/v1/services/acme-cloud/status \
-H "Authorization: Bearer $STATUS_RAPTOR_KEY" \
-H "Content-Type: application/json" \
-d '{"status": "DEGRADED", "message": "API latency is elevated."}'
Una llamada correcta devuelve 201 y un cuerpo con el id, el status y el message de la nueva actualización.
Preguntas
¿Qué estados puedo enviar?
OK, DEGRADED, CRITICAL, MONITORING, MAINTENANCE y OFFLINE, con cualquier combinación de mayúsculas y minúsculas.
¿Cómo publico para un solo componente?
Añade "componentId": "<uuid>" al cuerpo. El componente debe pertenecer al servicio.
¿Cómo son los errores?
Un documento de problema con un código de estado: 404 para un servicio o componente desconocido, 400 para una entrada no válida o una clave de otro servicio. Consulta la tabla en la referencia de la API.
¿Se envían correos?
Sí. La actualización desencadena los mismos correos a suscriptores que una publicada en el panel de gestión.