UptimeLock Developers
API REST v1 • JSON • TLS 1.3 obligatoire

Pilotez votre monitoring
par le code.

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 :

pageintegerOptionnel (défaut: 1)
Numéro de la page de résultats à récupérer.
results_per_pageintegerOptionnel (10, 25, 50, 100, 250)
Nombre d'éléments retournés par page (défaut : `25`).
search & search_bystringOptionnel
Recherche textuelle sur le nom (`name`) ou la cible (`target`).
order_typestringOptionnel (`ASC` ou `DESC`)
Sens de tri des résultats retournés.

Profil Utilisateur

Récupérez les informations du compte associé à votre clé API, son fuseau horaire ainsi que les quotas actifs de son abonnement.

GET /user

Lire le profil du compte

Aucun paramètre requis. Idéal pour tester la validité de votre clé d'authentification (`ping` API) lors de l'initialisation d'une intégration.


              
Réponse 200 OK (JSON)
{
  "data": {
    "id": 42,
    "name": "Alexandre Martin",
    "email": "alexandre@entreprise.fr",
    "timezone": "Europe/Paris",
    "status": true,
    "plan_id": "pro",
    "plan_expiration_date": "2027-11-16 12:00:00"
  }
}

Moniteurs HTTP(s), Ping & Ports

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`).

              
Réponse 200 OK
{
  "data": [
    {
      "id": 108,
      "name": "API Production",
      "type": "website",
      "target": "https://api.votresite.fr/health",
      "is_ok": 1,
      "uptime": 99.998,
      "average_response_time": 24.3,
      "is_enabled": 1
    }
  ]
}
POST /monitors

Créer un nouveau moniteur

Provisionnez une nouvelle sonde HTTP(s), Ping ou Port en envoyant les champs `multipart/form-data` suivants :

namestringRequis
Nom lisible du moniteur (ex: `"API Paiement EU"`).
targetstringRequis
URL complète (`https://...`) pour `website`, ou IP/hôte pour `ping` et `port`.
typestringOptionnel
Valeurs acceptées : `website` (défaut), `ping`, `port`.
check_interval_secondsintegerOptionnel
Intervalle en secondes (`30`, `60`, `180`, `300`… selon votre plan).
request_method & response_status_code
Méthode HTTP (`GET`, `POST`, `HEAD`, `PUT`, `PATCH`) et code attendu (ex: `200`).

              
Réponse 201 Created
{
  "data": {
    "id": 109
  }
}
GET POST DELETE /monitors/{monitor_id}
Lire un moniteur précis, mettre à jour ses paramètres ou le supprimer définitivement.

Agents Serveurs (CPU, RAM, Disque)

Consultez la télémétrie matérielle remontée par vos agents systèmes ou enregistrez une nouvelle machine à superviser.

GET /server-monitors

Lister les serveurs supervisés

agent_statusstringOptionnel
Valeurs : `online`, `offline`, `stale`, `pending` ou `paused`.
Création via POST /server-monitors et suppression via DELETE /server-monitors/{server_monitor_id}.

              
Réponse 200 OK
{
  "data": [
    {
      "id": 14,
      "name": "prod-eu-paris-01",
      "target": "51.210.10.42",
      "os_name": "Ubuntu 24.04 LTS",
      "cpu_usage": 19.4,
      "ram_usage": 58.1,
      "disk_usage": 41.8,
      "agent_status": "online"
    }
  ]
}

Game Servers (90+ Protocoles Query)

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.

POST /game-servers

Ajouter un serveur de jeu

namestringRequis
Nom du serveur (ex: `"Survie #1 EU"`).
typestringRequis
Identifiant du moteur : `minecraft`, `cs2`, `fivem`, `rust`, `arksa`, `gmod`, `valheim`, `arma3`…
target & portRequis
Hôte / IP et port Query du serveur de jeu.

              
Lecture GET /game-servers/{id}
{
  "data": {
    "id": 31,
    "name": "Survie Minecraft #1",
    "type": "minecraft",
    "is_ok": 1,
    "players_online": 184,
    "players_max": 250,
    "response_time": 18
  }
}

Cron Jobs & Heartbeats

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.

POST /notification-handlers

Créer un connecteur Webhook / Discord

Types supportés (`type`) : `email`, `webhook`, `discord`, `slack`, `telegram`, `microsoft_teams`, `twilio`, `twilio_call`, `whatsapp`, `google_chat`, `ntfy`.


            

Répertoire intégral des 19 ressources REST

Toutes les routes ci-dessous sont préfixées par https://dash.uptimelock.com/api :

Ressource Route REST Méthodes supportées
Profil Utilisateur/userGET
Moniteurs HTTP / Ping / Port/monitorsGET POST DELETE
Agents Serveurs (Linux/Win/Mac)/server-monitorsGET POST DELETE
Serveurs de Jeux (90+)/game-serversGET POST DELETE
Cron Jobs & Heartbeats/heartbeatsGET POST DELETE
Moniteurs DNS/dns-monitorsGET POST DELETE
Noms de domaine WHOIS/domain-namesGET POST DELETE
Pages de Statut/status-pagesGET POST DELETE
Statistiques Pages de Statut/statistics/{status_page_id}GET
Incidents/incidentsGET POST DELETE
Canaux de Notification/notification-handlersGET POST DELETE
Projets (Groupement)/projectsGET POST DELETE
Domaines Personnalisés (CNAME)/domainsGET POST DELETE
Équipes (Teams)/teamsGET POST DELETE
Membres d'Équipe Invités/team-membersGET POST DELETE
Accès Équipes Déléguées/teams-memberGET DELETE
Journaux d'Audit Compte/users-logsGET
Historique de Paiements/paymentsGET