Uptimeify Docs

Paket-Konfiguration erstellen/aktualisieren

Erstellt eine neue Paket-Konfiguration (über :packageType) oder aktualisiert eine bestehende. packageType ist ein frei wählbarer Bezeichner der Organisation. Customer-Endpoints können später genau diesen Key verwenden.

PATCH /api/package-configs/:packageType

Hier werden u.a. Alerting-Defaults wie alertConsecutiveChecks sowie Feature-Flags wie enableEmailAlerts gepflegt.

Anfrage (Request Body)

Alle Felder sind optional.

Wenn du im UI einen lesbaren Namen anzeigen willst, kannst du zusätzlich displayName setzen und den technischen packageType stabil halten.

{
  "displayName": "Pro Care",
  "maxUrls": 100,
  "dataRetentionMonths": 12,
  "checkIntervalMinutes": 1,
  "checkLocations": 3,
  "notificationDelayMinutes": 0,
  "reminderDelayMinutes": 10,

  "alertConsecutiveChecks": 3,
  "alertLocationThreshold": "majority",
  "alertLocationThresholdCount": 2,
  "alertReminderInterval": 60,

  "enableEmailAlerts": true,
  "enableSmsAlerts": true,
  "enableWebhookAlerts": true,
  "enableIntegrationAlerts": true,
  "enableMaintenanceWindows": true,
  "enablePdfReports": true,

  "notes": "Default für PRO-Kunden"
}

Beispiel (cURL)

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

curl -X PATCH "$BASE_URL/api/package-configs/pro" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{
    "displayName":"Pro Care",
    "maxUrls":100,
    "dataRetentionMonths":12,
    "checkIntervalMinutes":1,
    "checkLocations":3,
    "notificationDelayMinutes":0,
    "reminderDelayMinutes":10,
    "alertConsecutiveChecks":3,
    "alertLocationThreshold":"majority",
    "alertLocationThresholdCount":2,
    "alertReminderInterval":60,
    "enableEmailAlerts":true,
    "enableSmsAlerts":true,
    "enableWebhookAlerts":true,
    "enableIntegrationAlerts":true,
    "enableMaintenanceWindows":true,
    "enablePdfReports":true,
    "notes":"Default für PRO-Kunden"
  }'

Antwort (Response)

Gibt die erstellte/aktualisierte Paket-Konfiguration zurück.

{
  "id": 10,
  "packageType": "pro",
  "displayName": "Pro Care",
  "maxUrls": 100,
  "dataRetentionMonths": 12,
  "checkIntervalMinutes": 1,
  "checkLocations": 3,
  "notificationDelayMinutes": 0,
  "reminderDelayMinutes": 10,
  "alertConsecutiveChecks": 3,
  "alertLocationThreshold": "majority",
  "alertLocationThresholdCount": 2,
  "alertReminderInterval": 60,
  "enableEmailAlerts": true,
  "enableSmsAlerts": true,
  "enableWebhookAlerts": true,
  "enableIntegrationAlerts": true,
  "enableMaintenanceWindows": true,
  "enablePdfReports": true,
  "notes": "Default für PRO-Kunden",
  "createdAt": "2026-02-26T12:00:00.000Z",
  "updatedAt": "2026-02-26T12:00:00.000Z"
}

Hinweise:

  • Die Organisation wird automatisch aus deiner authentifizierten Session bzw. deinem API-Token abgeleitet.
  • Die body-basierte Variante PATCH /api/package-configs wird ebenfalls unterstützt, wenn packageType im Request-Body mitgesendet wird.
  • Die Legacy-Route PATCH /api/organizations/:organizationPublicId/package-configs/:packageType bleibt aus Kompatibilitätsgründen weiterhin verfügbar.
  • Der plurale org-lose Alias PATCH /api/organizations/package-configs/:packageType wird ebenfalls unterstützt.
  • Global Admins brauchen für die org-lose Route einen aktiven Organisationskontext in der Session.

Häufige Fehler

  • 400 Package type is required wenn :packageType fehlt
  • 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

Hinweis zur Berechtigung:

  • Schreibzugriff ist erforderlich (Org-Admin oder Global-Admin).

Auf dieser Seite