Uptimeify Docs

Maintenance Windows auflisten

Gibt alle Wartungsfenster zurück, die für den authentifizierten Benutzer sichtbar sind, gefiltert nach Organisation und optionalem Kunden-Filter.

GET /api/maintenance-windows

Query-Parameter

  • customerId (optional): Fenster nach Kunden-ID filtern.
  • organizationId (optional): Standardmäßig die Organisation der Sitzung.

Beispiel (cURL)

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

curl -X GET "$BASE_URL/api/maintenance-windows?customerId=1" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Accept: application/json"

Antwort (Response)

[
  {
    "id": 42,
    "publicId": "aaaaaaaa-aaaa-4aaa-8aaa-aaaaaaaaaaaa",
    "organizationId": 10,
    "customerId": 1,
    "name": "Wöchentliches Deployment",
    "description": "Rollierendes Update jeden Montag",
    "startTime": "2026-07-07T02:00:00.000Z",
    "endTime": "2026-07-07T04:00:00.000Z",
    "isRecurring": true,
    "recurrencePattern": {
      "frequency": "weekly",
      "interval": 1,
      "daysOfWeek": [1]
    },
    "isActive": true,
    "timezone": "UTC",
    "targets": [
      { "type": "website", "id": 101 },
      { "type": "icmp", "id": 5 }
    ],
    "tags": [
      { "id": 7, "publicId": "0b0e4c3e-9a1f-4d3e-8a2b-1c2d3e4f5a6b", "name": "Production", "color": "red" }
    ],
    "websiteId": null,
    "icmpMonitorId": null,
    "smtpMonitorId": null,
    "sshMonitorId": null,
    "ftpMonitorId": null,
    "imapPopMonitorId": null,
    "dnsMonitorId": null,
    "customerIpId": null,
    "customerDomainId": null,
    "createdAt": "2026-06-01T09:00:00.000Z",
    "updatedAt": "2026-06-01T09:00:00.000Z"
  }
]

Jedes Fenster enthält:

  • targets: Array von { type, id }-Objekten für alle explizit ausgewählten Monitore (type ist eines von website | dns | icmp | smtp | ssh | ftp | imap_pop).
  • tags: Array von Tag-Objekten { id, publicId, name, color } für tag-basierte Abdeckung; ein leeres Array, wenn das Fenster keine Tag-Auswahl verwendet. Der Besitzer des Tags (createdBy) ist nicht Teil dieser Antwort.
  • Legacy-Felder für einzelne Ziele (websiteId, icmpMonitorId usw.) bleiben aus Gründen der Abwärtskompatibilität vorhanden; sie sind null, wenn eine Multi-Target- oder Tag-Auswahl verwendet wird.

Sichtbarkeit

Welche Fenster zurückkommen, hängt davon ab, wer liest, nicht allein von den Query-Parametern:

  • Ein uneingeschränkter Leser (Organisations-Admin, globaler Admin sowie ein organisationsgebundenes Agent-Token) erhält jedes Fenster der Organisation: die kundengebundenen und die organisationsweiten (customerId: null).
  • Ein kundengebundener Leser (ein readonly-Benutzer, der einem oder mehreren Kunden zugewiesen ist, und das für ihn ausgestellte Agent-Token) erhält die Fenster seiner eigenen Kunden plus die organisationsweiten. Fenster eines anderen Kunden kommen nie zurück.
  • Ein kundengebundenes API-Token ist auf den Kunden festgelegt, für den es ausgestellt wurde, und erhält ausschließlich dessen Fenster.

Ein explizites customerId verengt das Ergebnis zusätzlich. Ein readonly-Benutzer darf nur einen Kunden nennen, dem er zugewiesen ist; jeder andere Kunde antwortet mit 403 Forbidden.

Häufige Fehler

  • 401 Unauthorized wenn du nicht angemeldet bist
  • 403 Forbidden wenn du keinen Zugriff auf die Organisation hast

Auf dieser Seite