L'API UptimeLock vous permet de provisionner automatiquement vos moniteurs HTTP, vos agents Linux/Windows, vos serveurs de jeux et vos pages de statut directement depuis Terraform, Ansible, GitHub Actions ou votre espace client hébergeur.
URL de Base Officielle
https://dash.uptimelock.com/api
Toutes les dates sont exprimées au format ISO / UTC.
Authentification
Chaque requête adressée à l'API doit inclure votre clé secrète dans l'en-tête HTTP Authorization selon le schéma standard Bearer Token. Vous pouvez générer ou régénérer votre clé à tout moment sur dash.uptimelock.com/account-api.
En-tête HTTP requis
Authorization: Bearer {votre_cle_api}
Codes de statut HTTP & Erreurs
L'API utilise les codes de réponse HTTP standards. En cas d'erreur, un objet JSON contenant le tableau errors décrit précisément la raison du rejet.
200 / 201
Succès
La requête a réussi et les données JSON sont retournées dans `data`.
400 Bad Request
Paramètre invalide
Un champ requis manque ou son format est incorrect.
401 Unauthorized
Clé API invalide
En-tête `Authorization: Bearer` absent ou clé révoquée.
404 Not Found
Ressource introuvable
L'identifiant du moniteur ou de la page n'existe pas sur ce compte.
429 Too Many Requests
Rate-Limit atteint
Trop de requêtes envoyées par minute. Patientez avant de relancer.
500 Server Error
Erreur interne
Incident exceptionnel côté serveur (nos sondes sont déjà alertées).
Pagination & Filtres universels
Tous les endpoints de liste (GET /monitors, GET /incidents, etc.) acceptent les paramètres de requête suivants dans l'URL :
Listez, créez, modifiez ou supprimez vos sondes web, API JSON, Ping ICMP et ports TCP/UDP.
GET/monitors
Lister tous les moniteurs
Retourne la liste paginée de vos moniteurs avec leur pourcentage d'uptime en direct (`uptime`) et leur temps de réponse moyen (`average_response_time`).
typestringOptionnel
Filtrer par type : `website`, `ping` ou `port`.
is_enabledbooleanOptionnel
Filtrer uniquement les sondes actives (`1`) ou en pause (`0`).
Idéal pour les hébergeurs GSP (Pterodactyl / Pelican) et réseaux communautaires : créez une sonde gaming dès la livraison d'un serveur client et affichez les joueurs connectés sur votre site.
Gérez vos écouteurs passifs de tâches Cron (/heartbeats) pour vérifier que vos sauvegardes et workers s'exécutent à l'heure prévue.
POST/heartbeats
Créer un écouteur Heartbeat
namestringRequis
Nom de la tâche planifiée (ex: `"Backup Nocturne S3"`).
run_interval & run_interval_typeRequis
Fréquence attendue (ex: `1` + `days`, `hours` ou `minutes`) avec délai de grâce `run_interval_grace`.
Domaines WHOIS & Moniteurs DNS
Surveillez l'expiration WHOIS de vos noms de domaine (/domain-names) ainsi que l'intégrité des enregistrements A, AAAA, MX, CNAME, NS et TXT (/dns-monitors).
GET/dns-monitors
Lister les audits DNS actifs
Également disponible en création (POST /dns-monitors, POST /domain-names) et suppression (DELETE).
Pages de Statut & Statistiques
Créez des pages de statut publiques ou privées par client (/status-pages), liez-y vos moniteurs et interrogez leurs statistiques de visites (/statistics/{status_page_id}).
GET/status-pages
Récupérer vos pages de statut
Retourne l'URL publique, le domaine personnalisé attaché (`domain_id`), le thème et la liste des moniteurs affichés.
Historique d'Incidents
Interrogez la liste chronologique des incidents détectés, leur durée exacte, la cause d'échec et annotez un incident en équipe.
GET/incidents
Lister les incidents enregistrés
Filtrez par `start_datetime`, `end_datetime` ou ajoutez un commentaire d'équipe via POST /incidents/{incident_id}.
Canaux d'Alertes (Notification Handlers)
Programmez vos connecteurs Discord, Slack, Telegram, Microsoft Teams, SMS, Email ou Webhooks JSON via /notification-handlers pour les attacher ensuite à vos moniteurs.