LIVCK Cloud

API-Übersicht Ab Team-Plan

Die LIVCK Cloud API gibt dir programmatischen Zugriff auf dein Monitoring -- steuere Services, Incidents und Statuspages per Code aus deinen eigenen Tools und Skripten.

Was du mit der API tun kannst

  • Services -- anlegen, bearbeiten, pausieren, fortsetzen oder löschen
  • Service-Metriken -- Uptime, Antwortzeiten und weitere Kennzahlen abrufen
  • Incidents -- erstellen, aktualisieren, Verlaufseinträge posten und auflösen
  • Wartungen -- Wartungsfenster erstellen, starten, abschließen und abbrechen
  • Statuspages -- Informationen abrufen (nur lesend)

Typische Anwendungsfälle

AnwendungsfallBeschreibung
AutomatisierungErstelle Services automatisch, wenn du einen neuen Server aufsetzt
Eigene DashboardsZeige Monitoring-Daten in deinem internen Dashboard an
CI/CD-IntegrationPausiere die Überwachung automatisch während eines Deployments
ChatbotsLass deinen Slack-Bot den aktuellen Status abfragen
ReportingErstelle eigene Berichte aus deinen Monitoring-Daten

Wie die API funktioniert

Basis-URL

Alle API-Anfragen gehen an:

https://api.livck.cloud/v1

Authentifizierung

Jede Anfrage braucht einen gültigen API-Token im Header. LIVCK-Tokens beginnen immer mit dem Präfix lvk_:

Authorization: Bearer lvk_dein-api-token

API-Tokens sind organisationsweite Dienstkonten -- sie gehören der Organisation, nicht einer einzelnen Person, und können von allen Mitgliedern mit den entsprechenden Rechten genutzt werden. Token erstellen: API-Tokens.

Antwortformat

Die API antwortet im JSON-Format. Listen-Endpunkte sind paginiert und liefern data, links und meta:

{
  "data": [
    {
      "id": "abc123",
      "name": "Meine Website",
      "status": "up"
    }
  ],
  "links": { "first": "...", "last": "...", "prev": null, "next": "..." },
  "meta": {
    "current_page": 1,
    "per_page": 15,
    "total": 42
  }
}

Fehlerformat

Tritt ein Fehler auf, enthält die Antwort immer ein message-Feld. Bei Validierungsfehlern (422) kommt zusätzlich ein errors-Objekt mit feldbezogenen Details hinzu:

{
  "message": "Die Validierung der Daten ist fehlgeschlagen.",
  "errors": {
    "name": ["Der Name ist erforderlich."]
  }
}

Ratenbegrenzung

Pro Token sind 120 Anfragen pro Minute erlaubt. Jede Antwort liefert die Header X-RateLimit-Limit und X-RateLimit-Remaining mit. Erreichst du das Limit, antwortet die API mit Statuscode 429 -- warte dann kurz und versuche es erneut.

Gut zu wissen

Alle Endpunkte, Fehlercodes und Details zur Paginierung findest du in der Endpunkte-Übersicht.

So startest du

  1. Token erstellen -- in den Einstellungen einen API-Token anlegen
  2. Erste Anfrage senden:
    curl -H "Authorization: Bearer dein-token" \
     https://api.livck.cloud/v1/services
  3. Ergebnis prüfen -- du erhältst eine JSON-Antwort mit deinen Services

Tipp

Starte mit einer einfachen Leseanfrage (z.B. Services auflisten), um zu prüfen, ob dein Token funktioniert.

Interaktive Referenz

Die vollständige, interaktive API-Referenz mit allen Parametern, Feldbeschreibungen und einer "Try it"-Funktion zum direkten Ausprobieren findest du unter api.livck.cloud. Sie wird automatisch aus der API generiert und ist damit immer aktuell.

Welche Pläne haben API-Zugang?

Ab dem Team-Plan:

PlanAPI-Zugang
Free--
Solo--
Ab Team-Plan TeamJa
Ab Business-Plan BusinessJa

Details zu allen Plänen findest du unter Pläne & Preise.

Weiterführende Themen