Uptimeify Docs

Komponenten auflisten

Gibt alle Komponenten einer Status-Seite zurück, sortiert nach sort.

GET /api/status-pages/{id}/components

Eine Komponente ist eine Zeile auf der Status-Seite: ein Monitor (sourceKind: monitor), ein Drittanbieter aus unserer Abhängigkeits-Überwachung (sourceKind: dependency) oder ein Eintrag, den du von Hand pflegst (sourceKind: manual). Komponenten können in einer Gruppe stehen. Die Liste enthält alle Komponenten der Seite auf einer einzigen Ergebnisseite, sortiert nach sort, dann id. Eine Seite hat höchstens 100 Komponenten.

Die Monitore, die die Seite über includeCustomerMonitors automatisch einschließt, sind keine Komponenten und stehen nicht in dieser Liste.

Zugriff

Organisations-admin, editor und readonly. Ein kundengebundener Nutzer oder API-Token erreicht nur Seiten eines Kunden in seinem Bereich; eine Seite ohne Kunde (customerId: null) beantwortet ihm 403 (forbidden). Eine Seite einer anderen Organisation antwortet 404 (statusPageNotFound). :id nimmt die numerische ID oder die publicId der Status-Seite.

Beispiel (cURL)

BASE_URL="https://uptimeify.io"
TOKEN="<dein-api-token>"

curl -X GET "$BASE_URL/api/status-pages/1/components" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Accept: application/json"

Antwort

200 OK

{
  "items": [
    {
      "id": 7,
      "publicId": "0b6f3c1e-8d2a-4f5b-9c7e-1a2b3c4d5e6f",
      "statusPageId": 1,
      "groupId": 3,
      "sort": 0,
      "name": "Main Site",
      "description": null,
      "showUptime": true,
      "sourceKind": "monitor",
      "monitorType": "http",
      "monitorId": 101,
      "manualStatus": null,
      "dependencySlug": null,
      "createdAt": "2026-10-27T09:00:00.000Z",
      "updatedAt": "2026-10-27T09:00:00.000Z"
    },
    {
      "id": 8,
      "publicId": "5d4c3b2a-1f0e-4d9c-8b7a-6f5e4d3c2b1a",
      "statusPageId": 1,
      "groupId": null,
      "sort": 1,
      "name": "Payment provider",
      "description": "Card payments at checkout",
      "showUptime": true,
      "sourceKind": "manual",
      "monitorType": null,
      "monitorId": null,
      "manualStatus": "operational",
      "dependencySlug": null,
      "createdAt": "2026-10-27T09:05:00.000Z",
      "updatedAt": "2026-10-27T09:05:00.000Z"
    }
  ],
  "total": 2,
  "page": 1,
  "perPage": 2
}
FeldBeschreibung
groupIdNumerische ID der Gruppe, oder null, wenn die Komponente in keiner Gruppe steht.
sourceKindmonitor, dependency oder manual.
monitorType, monitorIdDer Monitor einer Monitor-Komponente; null bei einer manuellen. monitorType ist eins von http, dns, icmp, smtp, ssh, tcp, ftp, imap_pop.
manualStatusZustand einer manuellen Komponente: operational, degraded, partial_outage, major_outage oder maintenance; null bei den anderen Arten.
dependencySlugAnbieter-Slug einer dependency-Komponente (GET /api/public/dependencies); null bei den anderen Arten.
showUptimeOb die Komponente auf der Seite ihren Verfügbarkeitsbalken zeigt.

Häufige Fehler

  • 400 Bad Request (invalidIdentifier), wenn eine ID im Pfad weder Zahl noch UUID ist
  • 401 Unauthorized, wenn du nicht angemeldet bist
  • 403 Forbidden (forbidden), wenn deine Rolle das nicht darf, oder für einen kundengebundenen Aufrufer auf einer Seite ohne Kunde oder eines anderen Kunden
  • 403 Forbidden (statusPagesModuleDisabled), wenn das Statusseiten-Modul nicht aktiviert ist
  • 404 Not Found (statusPageNotFound), wenn die Status-Seite nicht existiert oder zu einer anderen Organisation gehört

Auf dieser Seite