Skip to Content
Uptimeify Docs

Fehlerantwort

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

{
  "statusCode": 400,
  "statusMessage": "Invalid request body",
  "data": {
    "code": "invalidRequestBody",
    "issues": [{ "path": "url", "message": "Invalid input: expected string, received undefined" }],
    "requestId": "3f2b6c1e-8a4d-4f0e-9b7a-2c5d1e6f7a8b"
  }
}
  • data.code benennt den Fehler. Verzweige darauf, nie auf den Text; die Codes stehen in der Fehlerliste.
  • data.issues (nur bei invalidRequestBody) nennt jedes abgewiesene Feld mit path (mit Punkt verbunden) und message.
  • data.requestId kennzeichnet genau diesen Aufruf. Nenne sie, wenn du den Support kontaktierst.
  • statusMessage ist englisch und sagt, was zu ändern ist: welche Rolle, welches Token oder welcher Scope fehlt, oder welches Feld falsch ist. Der Text kann sich ändern; werte ihn nie aus.
  • data.requiredScope (nur bei apiTokenScopeForbidden) nennt den Scope, der dem Token fehlt; data.reason (nur bei agentTokenReadOnly) sagt, welche Regel für Agent-Tokens den Aufruf abgewiesen hat.
  • Welche Rolle und welches Token ein Endpunkt braucht: Berechtigungen je Endpunkt.

Request-ID

Jede API-Antwort trägt den Header X-Request-ID. Schickst du selbst eine X-Request-ID mit (1 bis 128 Zeichen aus A-Z, a-z, 0-9, ., _, :, -), etwa die Nummer deines CI-Laufs, gibt die API sie zurück und nutzt sie in data.requestId; sonst erzeugt sie eine UUID. Ein Wert außerhalb dieses Formats wird ersetzt, nicht abgewiesen.

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

Auf dieser Seite