Vue d'ensemble de l'API
Cronitorex expose deux API, chacune avec sa propre clé API :
| API | URL de base | Préfixe de clé | Objectif |
|---|---|---|---|
| Ingest API | https://api.cronitorex.com | ck_ | Recevoir les événements de supervision (pings) depuis vos jobs et services |
| Management API | https://app.cronitorex.com/api/v1 | mk_ | Gérer les moniteurs sous forme de manifestes : lister, récupérer, créer, mettre à jour |
Authentification
Les deux API s’authentifient avec un jeton Bearer, mais chacune utilise sa propre clé :
Authorization: Bearer <api_key>- La clé Ingest API (
ck_...) authentifie uniquement les pings. - La clé Management API (
mk_...) authentifie uniquement/api/v1.
Générez les deux clés dans le panneau sous Paramètres → Clé API. L’Ingest API accepte en plus un paramètre de requête ?api_key= pour les pings GET ponctuels (voir GET /ping).
Type de contenu
Tous les corps de requête doivent être en application/json. Toutes les réponses sont en application/json.
Limites de débit
Chaque API a sa propre limite :
| API | Limite | En cas de dépassement |
|---|---|---|
| Ingest API | 10 requêtes/seconde, rafale de 20 | 429 Too Many Requests |
| Management API | 60 requêtes/minute par clé API | 429 + en-têtes X-RateLimit-Limit / X-RateLimit-Remaining |
Points de terminaison
Ingest API
| Méthode | Chemin | Description |
|---|---|---|
POST | /ping | Soumettre un événement de supervision, voir POST /ping |
GET | /ping/{monitor} | Soumettre un événement via des paramètres de requête, voir GET /ping |
GET | /health | Vérification de l’état de santé de l’API (aucune authentification requise) |
Vocabulaire des statuts et types d’événements : Types d’événements et statuts.
Management API
| Méthode | Chemin | Description |
|---|---|---|
GET | /api/v1/monitors | Lister les manifestes de moniteurs (filtrer avec ?kind=) |
GET | /api/v1/monitors/{uuid} | Récupérer un moniteur unique |
POST | /api/v1/monitors | Créer un moniteur à partir d’un manifeste |
PUT | /api/v1/monitors/{uuid} | Mettre à jour un moniteur (manifeste complet) |
DELETE | /api/v1/monitors/{uuid} | Non pris en charge, renvoie 403 ; la suppression se fait uniquement via le panneau, par conception |
Référence complète avec le format du manifeste : Management API.
Outils interactifs
- Swagger UI : essayez les deux API directement dans le navigateur
- Collection Postman : requêtes prêtes à l’emploi pour tous les points de terminaison