Aperçu des endpoints API

Aperçu de tous les points de terminaison (endpoints) de l'API disponibles (les différentes URL de l'API REST que vous appelez). URL de base : https://epulz.io/api/v1

Autorisation : envoyez l'en-tête Authorization: Bearer epulzio_.... La limite de requêtes (rate limit) est de 60 requêtes par minute et par token. Vous générez un token dans Paramètres -> Tokens API.

Statut / vérification du token

• GET /status - vérifie le token, renvoie l'e-mail, le forfait, le nombre de moniteurs et le nombre d'incidents ouverts.

Moniteurs

• GET /monitors - liste de tous vos moniteurs (y compris la disponibilité des dernières 24 h).
• GET /monitors/{id} - détail d'un seul moniteur.
• POST /monitors - crée un nouveau moniteur. Dans le corps de la requête (JSON), envoyez les champs name, type, target, interval_minutes, expected_status, expected_keyword, forbidden_keyword.
• POST /monitors/bulk - import en masse (au maximum 200 moniteurs en une seule requête).
• PATCH /monitors/{id} - modification d'un moniteur existant (n'envoyez que les champs que vous souhaitez modifier).
• POST /monitors/{id}/check - lance une vérification immédiate en dehors de l'intervalle planifié ; renvoie le moniteur mis à jour.
• GET /monitors/{id}/uptime?days=30 - disponibilité en % sur les N derniers jours (1-365, par défaut 30) ; les fenêtres de maintenance sont exclues.
• DELETE /monitors/{id} - supprime le moniteur (avec l'historique des vérifications et des incidents).

Vérifications (historique)

• GET /monitors/{id}/checks?limit=100 - les N dernières vérifications d'un moniteur (état, temps de réponse, HTTP status code, erreur éventuelle, région). Le paramètre limit peut être de 1 à 500, par défaut 50.

Incidents

• GET /incidents - liste des incidents. Filtres facultatifs : monitor_id, resolved (true/false), limit (1-500, par défaut 50).

Codes d'erreur

• 401 - token manquant ou invalide.
• 403 - limite de moniteurs de votre forfait dépassée (lors de la création).
• 404 - le moniteur ne vous appartient pas ou n'existe pas.
• 429 - limite de requêtes dépassée (60 par minute et par token).

Documentation lisible par machine

La spécification complète au standard OpenAPI est disponible sur /api/openapi.json. La documentation interactive, où vous pouvez essayer directement les endpoints (Swagger UI), se trouve sur /api/docs. Les deux nécessitent une connexion ou un token valide.