LIVCK Cloud

API-Endpunkte Ab Team-Plan

Überblick über die verfügbaren API-Endpunkte -- keine vollständige Referenz, sondern eine Orientierungshilfe zum Aufbau der API.

Endpunkte nach Bereich

Services

AktionMethodeEndpunkt
Alle Services auflistenGET/v1/services
Service-Details abrufenGET/v1/services/{id}
Service erstellenPOST/v1/services
Service bearbeitenPUT / PATCH/v1/services/{id}
Service löschenDELETE/v1/services/{id}
Service pausierenPOST/v1/services/{id}/pause
Service fortsetzenPOST/v1/services/{id}/resume

Service-Metriken (nur lesend)

AktionMethodeEndpunkt
Metriken abrufenGET/v1/services/{id}/metrics
Uptime abrufenGET/v1/services/{id}/uptime
Antwortzeiten abrufenGET/v1/services/{id}/response-times

Parameter:

ParameterEndpunktWerteStandard
rangemetrics, response-times1h, 6h, 24h, 7d, 30d24h
daysuptimeAnzahl Tage30

Incidents

AktionMethodeEndpunkt
Alle Incidents auflistenGET/v1/incidents
Incident-Details abrufenGET/v1/incidents/{id}
Incident erstellenPOST/v1/incidents
Incident aktualisierenPUT / PATCH/v1/incidents/{id}
Incident löschenDELETE/v1/incidents/{id}
Verlaufseintrag postenPOST/v1/incidents/{id}/updates
Incident auflösenPOST/v1/incidents/{id}/resolve

Über POST /v1/incidents/{id}/updates postest du einen Eintrag in den Zeitverlauf des Incidents und kannst dabei den Status ändern.

Wartungen

AktionMethodeEndpunkt
Alle Wartungen auflistenGET/v1/maintenances
Wartung-Details abrufenGET/v1/maintenances/{id}
Wartung erstellenPOST/v1/maintenances
Wartung aktualisierenPUT / PATCH/v1/maintenances/{id}
Wartung löschenDELETE/v1/maintenances/{id}
Wartung startenPOST/v1/maintenances/{id}/start
Wartung abschließenPOST/v1/maintenances/{id}/complete
Wartung abbrechenPOST/v1/maintenances/{id}/cancel

Lebenszyklus von Wartungen

Die Übergänge start, complete und cancel sind nur in einem passenden Zustand möglich. Befindet sich die Wartung nicht im richtigen Status, antwortet die API mit 409 Conflict.

Statuspages (nur lesend)

AktionMethodeEndpunkt
Alle Statuspages auflistenGET/v1/statuspages
Statuspage-Details abrufenGET/v1/statuspages/{id}

Statuspages lassen sich über die API nur lesen, nicht verändern.

Beispiel-Anfrage

So listest du alle deine Services auf:

curl -X GET https://api.livck.cloud/v1/services \
  -H "Authorization: Bearer dein-api-token" \
  -H "Accept: application/json"

Antwort:

{
  "data": [
    {
      "id": "abc123",
      "name": "Unternehmens-Website",
      "status": "up",
      "check_type": "http",
      "target": "https://example.com"
    }
  ],
  "meta": { "current_page": 1, "last_page": 3, "total": 42 }
}

Paginierung

Endpunkte mit Listen sind paginiert:

ParameterBeschreibungStandardMaximum
pageWelche Seite abgerufen wird1--
per_pageEinträge pro Seite15100

Beispiel: GET /v1/services?page=2&per_page=25. Die Antwort enthält neben data die Objekte links (erste/letzte/vorherige/nächste Seite) und meta (aktuelle Seite, Gesamtanzahl, letzte Seite).

Fehlerbehandlung

Die API nutzt Standard-HTTP-Statuscodes:

StatuscodeBedeutungWas du tun kannst
200ErfolgreichAlles in Ordnung
201ErstelltRessource wurde erfolgreich angelegt
400Ungültige AnfragePrüfe deine gesendeten Daten
401Nicht autorisiertPrüfe deinen API-Token
403Keine BerechtigungDein Token hat nicht die nötigen Rechte
404Nicht gefundenDie angeforderte Ressource existiert nicht
409KonfliktÜbergang nicht möglich (z.B. Wartung im falschen Status)
422ValidierungsfehlerPrüfe die Felder im errors-Objekt der Antwort
429Zu viele AnfragenWarte kurz und versuche es erneut
500ServerfehlerVersuche es später erneut oder kontaktiere den Support

Bei Fehlern enthält die Antwort immer ein message-Feld:

{
  "message": "The requested resource was not found."
}

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. Die aktuellen Limits liefert jeder Response als Header mit:

HeaderBedeutung
X-RateLimit-LimitMaximale Anfragen pro Minute (120)
X-RateLimit-RemainingVerbleibende Anfragen in diesem Zeitfenster

Bei Statuscode 429

Wenn du das Limit überschreitest, antwortet die API mit 429 Too Many Requests. Warte kurz, bis sich das Zeitfenster zurücksetzt, bevor du weitere Anfragen sendest.

Vollständige API-Referenz

Interaktive Dokumentation

Diese Seite gibt dir einen Überblick. Die vollständige, interaktive API-Referenz mit allen Parametern, Feldbeschreibungen, Beispielen und einer "Try it"-Funktion findest du unter api.livck.cloud. Sie wird automatisch aus der API generiert und ist damit stets aktuell.

Weiterführende Themen