Uptimeify Docs

Paket-Konfigurationen auflisten

Gibt alle Paket-Konfigurationen der Organisation aus deiner authentifizierten Session zurück. Jede Konfiguration enthält zusätzlich usedByCustomerCount.

GET /api/package-configs

Query-Parameter

ParameterTypStandardBeschreibung
summarystring-Auf 1 gesetzt ergänzt jede Konfiguration um ein summary-Objekt mit Nutzungszahlen. Jeder andere Wert (oder das Weglassen) liefert die schlichte Liste.

Beispiel (cURL)

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

curl -X GET "$BASE_URL/api/package-configs" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Accept: application/json"

Hinweise:

  • Die Organisation wird automatisch aus deiner authentifizierten Session bzw. deinem API-Token abgeleitet.
  • Die Legacy-Route GET /api/organizations/:organizationPublicId/package-configs bleibt aus Kompatibilitätsgründen weiterhin verfügbar.
  • Global Admins brauchen für die org-lose Route einen aktiven Organisationskontext in der Session.
  • usedByCustomerCount zählt die Kunden, die dieser Konfiguration tatsächlich zugeordnet sind, nicht die Kunden, deren packageType-String zufällig ihrem Namen entspricht.

Antwort (Response)

[
  {
    "id": 10,
    "packageType": "pro",
    "maxUrls": 100,
    "dataRetentionMonths": 12,
    "checkIntervalMinutes": 1,
    "checkLocations": 3,
    "notificationDelayMinutes": 0,
    "reminderDelayMinutes": 10,
    "alertConsecutiveChecks": 3,
    "alertLocationThreshold": "majority",
    "alertLocationThresholdCount": 2,
    "alertReminderInterval": 60,
    "enableSslCheck": true,
    "enableHttpsCheck": true,
    "enableStatusCheck": true,
    "enableSizeCheck": true,
    "enableResponseTimeCheck": true,
    "enableKeywordCheck": false,
    "enableEmailAlerts": true,
    "enableSmsAlerts": true,
    "enableWebhookAlerts": true,
    "enableIntegrationAlerts": true,
    "enablePostRequestEscalation": false,
    "enableMaintenanceWindows": true,
    "enablePdfReports": true,
    "notes": null,
    "createdAt": "2026-02-26T12:00:00.000Z",
    "updatedAt": "2026-02-26T12:00:00.000Z",
    "usedByCustomerCount": 4
  }
]

Antwort mit summary=1

curl -X GET "$BASE_URL/api/package-configs?summary=1" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Accept: application/json"

Jeder Eintrag trägt dieselben Felder wie oben, dazu ein summary-Objekt:

[
  {
    "id": 10,
    "packageType": "pro",
    "maxUrls": 100,
    "usedByCustomerCount": 4,
    "summary": {
      "customers": 4,
      "monitorsActive": 37,
      "capacity": 400
    }
  }
]
  • customers: die dieser Konfiguration zugeordneten Kunden; identisch mit usedByCustomerCount.
  • monitorsActive: alle nicht deaktivierten Monitore dieser Kunden, jeder Typ zählt (Website, DNS, Domain, ICMP, SMTP, SSH, FTP, IMAP/POP); dieselbe Zahl, gegen die das Paketlimit geprüft wird.
  • capacity: customers × maxUrls. Hat die Konfiguration kein eigenes maxUrls, gilt der Standard ihres Pakettyps; 0 heißt, dass beides unbekannt ist.

Häufige Fehler

  • 400 Organization ID is required in the authenticated session wenn aus Session/Token keine Organisation abgeleitet werden kann
  • 401 Unauthorized wenn du nicht angemeldet bist
  • 403 Forbidden wenn du keinen Zugriff auf die Organisation hast

Auf dieser Seite