Comment publier une mise à jour de statut depuis un script ?
Envoyez POST /api/v1/services/{slug}/status avec votre clé de l’interface de programmation (API) et un corps en JavaScript Object Notation (JSON) contenant un status et un message.
Avant de commencer
- Vous avez une clé API pour le service.
Exemple
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."}'
Un appel réussi renvoie 201 et un corps contenant l’id, le status et le message de la nouvelle mise à jour.
Questions
Quels statuts puis-je envoyer ?
OK, DEGRADED, CRITICAL, MONITORING, MAINTENANCE et OFFLINE, quelle que soit la casse.
Comment publier pour un seul composant ?
Ajoutez "componentId": "<uuid>" au corps. Le composant doit appartenir au service.
À quoi ressemblent les erreurs ?
Un document de problème avec un code de statut : 404 pour un service ou un composant inconnu, 400 pour une saisie invalide ou une clé d’un autre service. Voir le tableau dans la référence de l’API.
Des emails sont-ils envoyés ?
Oui. La mise à jour déclenche les mêmes emails aux abonnés qu’une mise à jour publiée dans le back-office.