Uptimeify

Einführung

Willkommen in der Uptimeify API-Dokumentation. Mit dieser REST API kannst du deine Monitoring-Infrastruktur programmatisch verwalten – z. B. Organisationen, Kunden, Websites und Alerts.

Willkommen in der Uptimeify API-Dokumentation. Mit dieser REST API kannst du deine Monitoring-Infrastruktur programmatisch verwalten – z. B. Organisationen, Kunden, Websites und Alerts.

Basis-URL

Alle API-Anfragen sollten an die folgende Basis-URL gesendet werden:

https://uptimeify.io/api

Authentifizierung

Die API unterstützt Bearer-Token Authentifizierung für Integrationen.

API-Token erstellen

  1. Logge dich im Uptimeify-Dashboard ein.
  2. Öffne im Dashboard Einstellungen > API.
  3. Klicke auf Token erstellen, gib einen Namen an und kopiere das erzeugte Secret.

Füge das Token im Authorization-Header deiner Anfragen hinzu:

Authorization: Bearer <dein_api_token>

Token Scopes (Organization vs Customer)

API-Tokens können optional mit einem Customer Scope erstellt werden:

  • Organisation-weites Token: kann Ressourcen über alle Kunden der Organisation hinweg lesen/ändern.
  • Customer-Scoped Token: kann nur Ressourcen (Websites, Wartungsfenster usw.) innerhalb dieses einen Kunden lesen/ändern.

Customer-Scoped Tokens sind für Agenturen und externe Integrationen empfehlenswert. Requests außerhalb des Scopes liefern 403 Forbidden.

Hinweis: Session-basierte Authentifizierung (Cookies) wird für die Web-Oberfläche verwendet, ist für Integrationen aber nicht empfohlen.

Antwortformat

Alle Antworten werden im JSON-Format zurückgegeben.

Erfolgsantwort

{
  "id": 123,
  "name": "Beispiel-Ressource",
  "createdAt": "2023-01-01T12:00:00Z"
}

Fehlerantwort

Fehler werden mit einem passenden HTTP-Statuscode und einem JSON-Body mit Details zurückgegeben.

{
  "statusCode": 400,
  "statusMessage": "Bad Request",
  "message": "Validierung fehlgeschlagen: 'url' ist erforderlich."
}

Rate Limiting

Damit der Service stabil bleibt, ist die API rate-limitiert.

  • Limit: 600 Requests pro Minute pro IP
  • Header: X-RateLimit-Remaining zeigt dein verbleibendes Kontingent
  • Überschreitung: 429 Too Many Requests

Endpunkte