# Website Monitoring API Vollreferenz
> Erweiterter LLM-orientierter Export der kanonischen REST-API-Dokumentation fuer Customer-, Organization- und administrative Workflows.

Kanonische Doku-Basis: https://uptimeify.io/de/docs/api
Kompaktindex: https://uptimeify.io/de/llms.txt
API-Basis-URL: https://uptimeify.io/api
Authentifizierung: Bearer-Tokens aus dem Dashboard. In der API-Referenz dokumentierte Tokens beginnen in der Regel mit wsm_.
Nutze diese Datei, wenn du mehr Kontext als in llms.txt brauchst, aber weiterhin eine textbasierte Darstellung der aktuellen API-Dokumentation willst.

## Postman-Collection-Snapshot
Abgeglichen mit der gebuendelten Postman-Collection "Uptimeify API Collection" (162 Requests in 16 Gruppen).
Beschreibung: Postman collection for the Uptimeify monitoring platform. Set {{baseUrl}} to your Uptimeify instance and provide {{apiToken}} for authenticated requests.

### Auth & Session
Requests: 1
Beispiel-Endpunkte: GET /api/auth/get-session

### Configurations
Requests: 8
Beispiel-Endpunkte: POST /api/maintenance-windows/check/batch | GET /api/maintenance-windows/check/:websiteId | POST /api/maintenance-windows

### Customer Management
Requests: 10
Beispiel-Endpunkte: POST /api/customers/:customerPublicId/cancel | PATCH /api/customers/:customerPublicId | POST /api/customers

### Monitoring Data & Reports
Requests: 8
Beispiel-Endpunkte: GET /api/websites/:websitePublicId/report.pdf | GET /api/websites/:websitePublicId/alert-history | GET /api/websites/:websitePublicId/check-history

### Monitors
Requests: 62
Beispiel-Endpunkte: POST /api/dns-monitors | DELETE /api/dns-monitors/:dnsMonitorPublicId | GET /api/dns-monitors/:dnsMonitorPublicId/check-history

### Organization & Billing
Requests: 15
Beispiel-Endpunkte: DELETE /api/organizations/:id/package-configs/:packageType | GET /api/organizations/:id/billing | GET /api/organizations/:organizationPublicId

### Users
Requests: 5
Beispiel-Endpunkte: POST /api/users | DELETE /api/users/:id | GET /api/users/:id

### Website Management
Requests: 8
Beispiel-Endpunkte: PATCH /api/websites/:websitePublicId | POST /api/websites | DELETE /api/websites/:websitePublicId

### Status Pages
Requests: 13
Beispiel-Endpunkte: GET /api/status-pages | POST /api/status-pages | GET /api/status-pages/1

### Notification Channels
Requests: 5
Beispiel-Endpunkte: GET /api/notification-channels | POST /api/notification-channels | PATCH /api/notification-channels/:id

### Escalation Config
Requests: 3
Beispiel-Endpunkte: GET /api/escalation-config/:id | PATCH /api/escalation-config/:id | POST /api/escalation-config/:id/test

### Custom Fields
Requests: 4
Beispiel-Endpunkte: GET /api/custom-fields | POST /api/custom-fields | PATCH /api/custom-fields/:id

### API Tokens
Requests: 6
Beispiel-Endpunkte: GET /api/customer/tokens | POST /api/customer/tokens | DELETE /api/customer/tokens/:id

### Whitelabel
Requests: 8
Beispiel-Endpunkte: GET /api/organization/whitelabel/branding | PATCH /api/organization/whitelabel/branding | POST /api/organization/whitelabel/branding/upload

### Organization SMTP
Requests: 4
Beispiel-Endpunkte: POST /api/organization/smtp/test | GET /api/organization/smtp/logs?limit=100 | GET /api/organization/smtp

### Monitoring Locations
Requests: 2
Beispiel-Endpunkte: GET /api/monitoring-locations/countries | GET /api/public/monitoring-locations

## Einstieg
Zentrale Einstiegsseiten zu Authentifizierung, Token-Scopes und durchgehenden Beispielen.

### API Dokumentation
URL: https://uptimeify.io/docs/api
Beschreibung: Übersicht über die REST API. Wähle links eine Ressource aus.
Wichtige Abschnitte: KI / LLM Text-Exporte | Base URL | Authentifizierung | UUID-Pfadparameter | Antworten und Fehler
Zusammenfassung: Übersicht über die REST API. Wähle links eine Ressource aus. KI / LLM Text-Exporte LLMS-Index für KI-Agenten LLMS-Vollreferenz für KI-Ingestion Deutscher LLMS-Index für KI-Agenten Deutsche LLMS-Vollreferenz für KI-Ingestion Base URL Alle Beispiele nutzen eine Platzhalter-Base-URL: BASE URL="https://uptimeify.io" Authentifizierung Die meisten Endpunkte benötigen Authentifizierung. TOKEN="wsm <dein-api-token " curl -H "Authorization: Bearer $TOKEN" "$BASE URL/api/websites" API-Tokens aus dem Dashboard starten immer mit wsm . Bitte den kompletten Token (inkl. Prefix) verwenden – sonst kommt 401 Unauthorized. UUID-Pfadparameter Bei migrierten Ressourcen verwenden die Docs und Beispiele die publicId-UUID im Pfad. Nutze UUIDs in Pfaden wie /api/websites/:websitePublicId, /api/customers/:customerPublicId, /api/organizations/:organizationPublicId, /api/incidents/:incidentPublicId,...

### Einführung
URL: https://uptimeify.io/docs/api/einfuehrung
Beschreibung: Willkommen in der Uptimeify API-Dokumentation. Mit dieser REST API kannst du deine Monitoring-Infrastruktur programmatisch verwalten – z. B. Organisationen, Kunden, Websites und Alerts.
Wichtige Abschnitte: Basis-URL | Authentifizierung | API-Token erstellen | Token Scopes (Organization vs Customer) | Antwortformat | Erfolgsantwort
Zusammenfassung: Willkommen in der Uptimeify API-Dokumentation. Mit dieser REST API kannst du deine Monitoring-Infrastruktur programmatisch verwalten – z. B. Organisationen, Kunden, Websites und Alerts. Basis-URL Alle API-Anfragen sollten an die folgende Basis-URL gesendet werden: https://uptimeify.io/api Authentifizierung Die API unterstützt Bearer-Token Authentifizierung für Integrationen. API-Token erstellen Logge dich im Uptimeify-Dashboard ein. Öffne im Dashboard Einstellungen API . Klicke auf Token erstellen , gib einen Namen an und kopiere das erzeugte Secret. Füge das Token im Authorization-Header deiner Anfragen hinzu: Authorization: Bearer <dein api token Token Scopes (Organization vs Customer) API-Tokens können optional mit einem Customer Scope erstellt werden: Organisation-weites Token : kann Ressourcen über alle Kunden der Organisation hinweg lesen/ändern. Customer-Scoped Token : kann nur...

#### API-Token erstellen
URL: https://uptimeify.io/docs/api/einfuehrung/api-token-generieren
Zusammenfassung: API-Token erstellen Logge dich im Uptimeify-Dashboard ein. Öffne im Dashboard Einstellungen API . Klicke auf Token erstellen , gib einen Namen an und kopiere das erzeugte Secret. Füge das Token im Authorization-Header deiner Anfragen hinzu: Authorization: Bearer <dein api token

#### Erfolgsantwort
URL: https://uptimeify.io/docs/api/einfuehrung/bestaetigungsmeldung
Beschreibung: Bei Erfolg liefert die API einen JSON-Body mit den angefragten Daten.
Zusammenfassung: Erfolgsantwort Bei Erfolg liefert die API einen JSON-Body mit den angefragten Daten. { "id": 123, "name": "Example Resource", "createdAt": "2023-01-01T12:00:00Z" }

#### Fehlerantwort
URL: https://uptimeify.io/docs/api/einfuehrung/fehlermeldungen
Beschreibung: Fehler werden mit einem passenden HTTP-Statuscode und einem JSON-Body mit Details zurückgegeben.
Zusammenfassung: Fehlerantwort Fehler werden mit einem passenden HTTP-Statuscode und einem JSON-Body mit Details zurückgegeben. { "statusCode": 400, "statusMessage": "Bad Request", "message": "Validation failed: 'url' is required." } 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

#### Token-Scopes (Organisation vs. Kunde)
URL: https://uptimeify.io/docs/api/einfuehrung/token-organisation-vs-kunde
Beschreibung: API-Tokens können optional mit einem Customer Scope erstellt werden:
Zusammenfassung: Token-Scopes (Organisation vs. Kunde) API-Tokens können optional mit einem Customer Scope erstellt werden: Organisation-weites Token : kann Ressourcen über alle Kunden der Organisation hinweg lesen/ändern. Customer-Scoped Token : kann nur Ressourcen (Websites, Wartungsfenster usw.) innerhalb dieses einen Kunden lesen/ändern. Customer-Scoped Tokens sind für Agenturen und externe Integrationen empfehlenswert. Requests außerhalb des Scopes liefern 403 Forbidden. Hinweis: Session-basierte Authentifizierung (Cookies) wird für die Web-Oberfläche verwendet, ist für Integrationen aber nicht empfohlen.

### Benutzer & Sitzung
URL: https://uptimeify.io/docs/api/auth
Beschreibung: Verwalte deine aktuelle Benutzersitzung und rufe Profilinformationen ab.
Wichtige Abschnitte: Endpunkte
Zusammenfassung: Verwalte deine aktuelle Benutzersitzung und rufe Profilinformationen ab. Endpunkte Aktuellen Benutzer abrufen

#### Aktuellen Benutzer abrufen
URL: https://uptimeify.io/docs/api/auth/aktuellen-nutzer-abfragen
Beschreibung: GET /api/auth/get-session
Endpunkte: GET /api/auth/get-session
Wichtige Abschnitte: Anfrage (Request) | Antwort (Response)
Zusammenfassung: Aktuellen Benutzer abrufen GET /api/auth/get-session Gibt eine reduzierte Sicht auf den aktuell authentifizierten Benutzer und seine Sitzung zurück. Anfrage (Request) GET /api/auth/get-session HTTP/1.1 Dieser Endpoint liefert ein öffentlich unkritisches Session-Payload. Für Integrationen nutze API-Tokens (Authorization: Bearer wsm ...) mit den REST-Endpunkten unter /api/ . Interne Felder wie email, role, language, isGlobalAdmin, isGlobalSupporter, emailVerified, image und der Platform-Admin-Customer-Context werden absichtlich nicht zurückgegeben. Antwort (Response) { "user": { "id": "user 12345", "name": "Max Mustermann", "firstName": "Max", "lastName": "Mustermann", "organizationId": 1, "organizationStatus": "active", "isActive": true, "createdAt": "2026-03-31T15:50:49.030Z", "updatedAt": "2026-03-31T15:50:49.030Z" }, "session": { "userId": "user 12345", "expiresAt":...

### Beispiele
URL: https://uptimeify.io/docs/api/examples
Beschreibung: Praxisnahe Beispiele für typische Workflows mit Kunden, Websites und Monitoren.
Zusammenfassung: Beispiele Hier findest du Schritt-für-Schritt Beispiele für häufige API-Workflows. Kunde + Website erstellen Kunde inkl. aller Websites löschen Kunde + alle Monitore anlegen Kunde + mehrere Monitore anlegen

#### Kunde + alle Monitore
URL: https://uptimeify.io/docs/api/examples/create-customer-and-all-monitors
Beschreibung: Beispiel-Automatisierung: Eine Website anlegen und danach je Monitor-Typ einen Monitor erstellen.
Wichtige Abschnitte: 1) Kunde + Website erstellen | 2) Monitore anlegen (je Typ einen) | Beispiel: DNS Monitor erstellen | Beispiel: ICMP Monitor erstellen | Hinweise
Zusammenfassung: Kunde + alle Monitore anlegen Dieses Beispiel ist praktisch, wenn du einen Kunden mit einem kompletten Monitoring-Baseline-Setup initialisieren möchtest. High-level Flow: Kunde erstellen Website erstellen Monitore anlegen (je Monitor-Typ einen) 1) Kunde + Website erstellen Nutze dafür: Kunde + Website erstellen 2) Monitore anlegen (je Typ einen) Die Monitor-APIs sind nach Typ organisiert. API-Referenz-Übersicht: Monitore API Typische Monitor-Typen: DNS Monitor ICMP Monitor SMTP Monitor SSH Monitor FTP Monitor IMAP/POP Monitor Die genauen Pflichtfelder findest du in der jeweiligen API-Doku pro Typ. Beispiel: DNS Monitor erstellen curl -X POST "$API BASE URL/api/dns-monitors" \ -H "Authorization: Bearer $TOKEN" \ -H "Content-Type: application/json" \ -d '{ "customerId": 123, "name": "DNS: acme.example", "hostname": "acme.example", "dnsConfig": { "rrtypes": ["A", "AAAA"], "matchMode":...

#### Kunde + mehrere Monitore
URL: https://uptimeify.io/docs/api/examples/create-customer-and-multiple-monitors
Beschreibung: Beispiel: Kunde erstellen und mehrere Monitore einrichten (gleicher Typ und gemischte Typen).
Wichtige Abschnitte: 1) Kunde + Website erstellen | 2) Mehrere Monitore anlegen | Option A: Mehrere Monitore vom selben Typ (DNS) | Option B: Gemischte Monitor-Typen | Tipps | Referenz
Zusammenfassung: Kunde + mehrere Monitore anlegen Dieses Beispiel zeigt, wie du für einen Kunden mehrere Monitore einrichtest, z.B.: Zwei unterschiedliche Hostnamen für DNS Monitoring Mehrere Server für ICMP Eine Mischung aus DNS + ICMP + SMTP 1) Kunde + Website erstellen Kunde + Website erstellen 2) Mehrere Monitore anlegen Option A: Mehrere Monitore vom selben Typ (DNS) DNS Monitor 1 curl -X POST "$API BASE URL/api/dns-monitors" \ -H "Authorization: Bearer $TOKEN" \ -H "Content-Type: application/json" \ -d '{ "customerId": 123, "name": "DNS: app.acme.example", "hostname": "app.acme.example", "dnsConfig": { "rrtypes": ["A"], "matchMode": "exact", "expectedValues": { "A": ["93.184.216.34"] } } }' DNS Monitor 2 curl -X POST "$API BASE URL/api/dns-monitors" \ -H "Authorization: Bearer $TOKEN" \ -H "Content-Type: application/json" \ -d '{ "customerId": 123, "name": "DNS: mail.acme.example", "hostname":...

#### Kunde + Website erstellen
URL: https://uptimeify.io/docs/api/examples/create-customer-and-website
Beschreibung: End-to-End Beispiel: Kunde anlegen und anschließend die erste Website erstellen.
Wichtige Abschnitte: Voräussetzungen | 1) Kunde erstellen | 2) Website für den Kunden erstellen | 3) Website prüfen | Nächste Schritte
Zusammenfassung: Kunde + Website erstellen Dieses Beispiel zeigt einen typischen Onboarding-Flow: Kunde anlegen Eine Website für diesen Kunden anlegen (Optional) Monitoring-Konfiguration ergänzen Wenn du lieber das UI nutzt: Kunden und Websites kannst du im Admin-Bereich anlegen. Die API ist ideal für Automatisierung und Bulk-Setups. Voräussetzungen API Token mit den benötigten Scopes Deine API Base URL (z.B. https://your-instance.tld) Siehe zuerst die API-Einführung: API Einführung 1) Kunde erstellen API Referenz: Kunden API Beispiel (Pseudo-Request): curl -X POST "$API BASE URL/api/customers" \ -H "Authorization: Bearer $TOKEN" \ -H "Content-Type: application/json" \ -d '{ "name": "Acme GmbH", "email": "ops@acme.example" }' Speichere die zurückgegebene customerId. 2) Website für den Kunden erstellen API Referenz: Websites API curl -X POST "$API BASE URL/api/websites" \ -H "Authorization: Bearer...

#### Kunde + Websites löschen
URL: https://uptimeify.io/docs/api/examples/delete-customer-and-all-websites
Beschreibung: Sicherer Lösch-Flow: erst Websites löschen, dann den Kunden.
Wichtige Abschnitte: Voräussetzungen | 1) Websites des Kunden auflisten | 2) Jede Website löschen | 3) Kunden löschen | Hinweise
Zusammenfassung: Kunde inkl. aller Websites löschen Dieses Beispiel beschreibt einen sicheren, expliziten Lösch-Flow . Je nach Konfiguration kann das Löschen eines Kunden Websites automatisch mitlöschen — oder auch nicht. Um Überraschungen zu vermeiden, empfehlen wir, Websites zuerst explizit zu löschen. Voräussetzungen API Token mit den benötigten Scopes 1) Websites des Kunden auflisten API Referenz: Websites auflisten Pseudo-Request: curl -X GET "$API BASE URL/api/websites?customerId=123" \ -H "Authorization: Bearer $TOKEN" Sammle alle Website-IDs. 2) Jede Website löschen API Referenz: Website löschen curl -X DELETE "$API BASE URL/api/websites/456" \ -H "Authorization: Bearer $TOKEN" Wiederhole das für alle Websites dieses Kunden. 3) Kunden löschen API Referenz: Kunden API curl -X DELETE "$API BASE URL/api/customers/123" \ -H "Authorization: Bearer $TOKEN" Hinweise Falls euer Backend Cascade Deletes...

## Customer API
Customer-sichere Ressourcen fuer Websites, Monitoring-Daten, Monitore und Website-Konfiguration.

### Website-Verwaltung
URL: https://uptimeify.io/docs/api/websites
Beschreibung: Verwalte die überwachten Websites.
Wichtige Abschnitte: Endpunkte
Zusammenfassung: Verwalte die überwachten Websites. Pfadbasierte Website-Endpunkte verwenden websitePublicId-UUIDs. Endpunkte Websites auflisten Website erstellen Website abrufen Website-Details abrufen Website aktualisieren Status ändern Website löschen

#### Website abrufen
URL: https://uptimeify.io/docs/api/websites/website-abfragen
Beschreibung: GET /api/websites/:websitePublicId
Endpunkte: GET /api/websites/:websitePublicId | GET /api/websites/:websitePublicId/details
Wichtige Abschnitte: Beispiel (cURL) | Antwort (Response) | Häufige Fehler
Zusammenfassung: Website abrufen GET /api/websites/:websitePublicId Gibt eine einzelne Website (basic/sanitized) zurück. Sensible Felder wie verschlüsselte Credentials werden entfernt. Wenn du die vollständigen “Mega”-Details (inkl. zusätzlicher Felder) brauchst, nutze: GET /api/websites/:websitePublicId/details Beispiel (cURL) BASE URL="https://uptimeify.io" TOKEN="<dein-api-token " curl -X GET "$BASE URL/api/websites/9a3d4d4d-7a4b-4f37-a9df-2a6f6d9d7a10" \ -H "Authorization: Bearer $TOKEN" \ -H "Accept: application/json" Antwort (Response) { "id": 101, "organizationId": 1, "customerId": 1, "name": "Haupt-Marketing-Seite", "url": "https://example.com", "status": "active", "monitoringType": "combined", "checkInterval": 1, "createdAt": "2026-02-26T12:00:00.000Z", "updatedAt": "2026-02-26T12:00:00.000Z" } Häufige Fehler 400 Website public ID (UUID) required wenn :websitePublicId fehlt/ungültig ist 401...

#### Website aktualisieren
URL: https://uptimeify.io/docs/api/websites/website-aktualisieren
Beschreibung: PATCH /api/websites/:websitePublicId oder PUT /api/websites/:websitePublicId
Endpunkte: PATCH /api/websites/:websitePublicId | PUT /api/websites/:websitePublicId
Wichtige Abschnitte: Anfrage (Request Body) | Beispiel (cURL) | Häufige Fehler
Zusammenfassung: Website aktualisieren PATCH /api/websites/:websitePublicId oder PUT /api/websites/:websitePublicId Aktualisiert die Konfiguration eines Website-Monitors. PATCH eignet sich für Teil-Updates (nur gesendete Felder werden geändert). PUT ist stärker validiert (Schema-Validierung) und eignet sich für umfangreichere Updates. Anfrage (Request Body) customerId optional für PATCH, aber erforderlich für Full-Update-Anfragen; akzeptiert Customer Public ID (bevorzugt) oder Legacy-Nummer { "name": "Aktualisierter Name", "url": "https://new-url.example.com", "checkInterval": 5, "timeoutSeconds": 10 } Beispiel (cURL) BASE URL="https://uptimeify.io" TOKEN="<dein-api-token " curl -X PATCH "$BASE URL/api/websites/9a3d4d4d-7a4b-4f37-a9df-2a6f6d9d7a10" \ -H "Authorization: Bearer $TOKEN" \ -H "Content-Type: application/json" \ -H "Accept: application/json" \ -d '{ "name": "Aktualisierter Name",...

#### Website-Details abrufen
URL: https://uptimeify.io/docs/api/websites/website-details-abfragen
Beschreibung: GET /api/websites/:websitePublicId/details
Endpunkte: GET /api/websites/:websitePublicId/details
Wichtige Abschnitte: Beispiel (cURL) | Query Parameter | Antwort (Response) | Häufige Fehler
Zusammenfassung: Website-Details abrufen GET /api/websites/:websitePublicId/details Gibt die Daten für die Website-Detailseite in einem Call zurück (Mega-Endpoint). Beispiel (cURL) BASE URL="https://uptimeify.io" TOKEN="<dein-api-token " curl -X GET "$BASE URL/api/websites/9a3d4d4d-7a4b-4f37-a9df-2a6f6d9d7a10/details?range=day" \ -H "Authorization: Bearer $TOKEN" \ -H "Accept: application/json" Query Parameter range (optional): day week month year (Standard: day) Antwort (Response) { "website": { "id": 101, "name": "Haupt-Marketing-Seite", "url": "https://example.com", "status": "active", "monitoringType": "combined", "customerId": 1 }, "uptimeStats": { "day": "100.00", "month": "99.95", "year": "99.90", "dayAvgResponse": 125, "monthAvgResponse": 118, "yearAvgResponse": 120 }, "monitoringData": { "responseTimeData": [], "statusData": [], "uptimePercentage": "99.95", "checkSuccessRatePercentage":...

#### Website erstellen
URL: https://uptimeify.io/docs/api/websites/website-erstellen
Beschreibung: POST /api/websites
Endpunkte: POST /api/websites
Wichtige Abschnitte: Anfrage (Request Body) | Antwort (Response) | Häufige Fehler
Zusammenfassung: Website erstellen POST /api/websites Erstellt einen neuen Website-Monitor für einen Kunden. Anfrage (Request Body) { "customerId": "059e1469-0f05-4c93-bd4d-89c45bb2afd9", "name": "Neue Landing Page", "url": "https://landing.example.com", "checkInterval": 60 // Optional, Standardwert aus Paket-Limit } customerId akzeptiert die Public ID des Kunden (bevorzugt) und weiterhin Legacy-Nummern. Antwort (Response) { "id": 103, "customerId": 1, "name": "Neue Landing Page", "url": "https://landing.example.com", "status": "active", "createdAt": "2023-10-27T10:05:00Z" } Häufige Fehler 401 Unauthorized wenn du nicht angemeldet bist 403 Forbidden wenn du keine Berechtigung für den Kunden oder die Organisation hast 404 Customer not found wenn customerId keinem existierenden Kunden zugeordnet werden kann

#### Website löschen
URL: https://uptimeify.io/docs/api/websites/website-loeschen
Beschreibung: DELETE /api/websites/:websitePublicId
Endpunkte: DELETE /api/websites/:websitePublicId
Zusammenfassung: Website löschen DELETE /api/websites/:websitePublicId Entfernt eine Website und ihren Monitoring-Verlauf unwiderruflich.

#### Status ändern
URL: https://uptimeify.io/docs/api/websites/website-status-wechseln
Beschreibung: PATCH /api/websites/:websitePublicId (status)
Endpunkte: PATCH /api/websites/:websitePublicId
Wichtige Abschnitte: Anfrage (Request Body) | Beispiel (cURL) | Häufige Fehler
Zusammenfassung: Status ändern PATCH /api/websites/:websitePublicId Ändert den Monitoring-Status einer Website. Es gibt keinen separaten .../status Endpoint — Status-Änderungen erfolgen über PATCH /api/websites/:websitePublicId. Anfrage (Request Body) { "status": "maintenance" } Erlaubte Werte: active inactive (du kannst auch paused senden, das wird zu inactive gemappt) maintenance Beispiel (cURL) BASE URL="https://uptimeify.io" TOKEN="<dein-api-token " curl -X PATCH "$BASE URL/api/websites/6bfec6f6-245a-47ce-843b-157d97d56f88" \ -H "Authorization: Bearer $TOKEN" \ -H "Content-Type: application/json" \ -H "Accept: application/json" \ -d '{ "status": "maintenance" }' Häufige Fehler 401 Unauthorized wenn du nicht angemeldet bist 403 Forbidden wenn du keine Schreibrechte hast (z.B. readonly/global supporter) 403 Active website limit reached... wenn ein Wechsel auf active das Limit überschreiten würde

#### Websites auflisten
URL: https://uptimeify.io/docs/api/websites/websites-auflisten
Beschreibung: GET /api/websites
Endpunkte: GET /api/websites
Wichtige Abschnitte: Query Parameter | Beispiel (cURL) | Antwort (Response) | Häufige Fehler
Zusammenfassung: Websites auflisten GET /api/websites Listet Websites innerhalb einer Organisation auf (paginiert). Die Ergebnisse sind durch deine Session/Permissions eingeschränkt. Query Parameter organizationId (optional): Standard ist deine Session-Organisation. customerId (optional): Filtert nach Kunde. search (optional): Suche nach Website-/Kundenfeldern. monitoringType (optional): combined http status ssl check playwright heartbeat dns excludeMonitoringType (optional): wie monitoringType page (optional, Standard: 1) perPage (optional, Standard: 50, max: 200) Beispiel (cURL) BASE URL="https://uptimeify.io" TOKEN="<dein-api-token " curl -X GET "$BASE URL/api/websites?organizationId=1&page=1&perPage=50" \ -H "Authorization: Bearer $TOKEN" \ -H "Accept: application/json" Antwort (Response) { "items": [ { "id": 101, "publicId": "11111111-1111-4111-8111-111111111111", "customerId": 1,...

### Monitoring-Daten & Berichte
URL: https://uptimeify.io/docs/api/monitoring
Endpunkte: GET /api/websites/:websitePublicId/uptime-stats | GET /api/websites/:websitePublicId/check-history | GET /api/websites/:websitePublicId/incident-history | GET /api/websites/:websitePublicId/alert-history | GET /api/websites/:websitePublicId/monitoring-data?range=day|week|month|year | GET /api/incidents/:incidentPublicId | GET /api/incidents?organizationId=:organizationId | GET /api/websites/:websitePublicId/report.pdf?period=last-week|last-month|last-quarter|last-year&startDate=YYYY-MM-DD&endDate=YYYY-MM-DD
Wichtige Abschnitte: Monitoring-Daten | Metriken abrufen | Letzte Checks abrufen | Ausfälle auflisten | Alert-Historie abrufen | Monitoring-Daten abrufen
Zusammenfassung: Monitoring-Daten Metriken abrufen GET /api/websites/:websitePublicId/uptime-stats Gibt Uptime-Prozentsätze und durchschnittliche Antwortzeiten (Tag/Monat/Jahr) zurück. Letzte Checks abrufen GET /api/websites/:websitePublicId/check-history Gibt die letzten Monitoring-Checks einer Website zurück. Ausfälle auflisten GET /api/websites/:websitePublicId/incident-history Gibt die Incident-Historie einer Website zurück. Alert-Historie abrufen GET /api/websites/:websitePublicId/alert-history Gibt die letzten Benachrichtigungs-/Eskalations-Versuche für Incidents einer Website zurück. Monitoring-Daten abrufen GET /api/websites/:websitePublicId/monitoring-data?range=day week month year Gibt aggregierte Timeseries-Daten zurück (Charts). Ausfall-Details abrufen GET /api/incidents/:incidentPublicId Gibt Details zu einem bestimmten Vorfall zurück. Ausfälle auflisten (Organisation) GET...

#### Ausfälle auflisten
URL: https://uptimeify.io/docs/api/monitoring/ausfaelle-auflisten
Beschreibung: GET /api/websites/:websitePublicId/incident-history
Endpunkte: GET /api/websites/:websitePublicId/incident-history
Wichtige Abschnitte: Authentifizierung | Parameter | Beispiel (cURL) | Antwort (Response) | Häufige Fehler
Zusammenfassung: Ausfälle auflisten GET /api/websites/:websitePublicId/incident-history Gibt die Incident-Historie einer Website zurück (letzte 100), inklusive berechneter Dauer. Authentifizierung Erfordert eine gültige Session. Header: Authorization: Bearer <token Parameter websitePublicId (Path, required): Öffentliche UUID der Website. Beispiel (cURL) BASE URL="https://uptimeify.io" TOKEN="<dein-api-token " curl -X GET "$BASE URL/api/websites/6bfec6f6-245a-47ce-843b-157d97d56f88/incident-history" \ -H "Authorization: Bearer $TOKEN" \ -H "Accept: application/json" Antwort (Response) { "incidents": [ { "id": 123, "type": "downtime", "status": "resolved", "startedAt": "Feb 26, 2026, 12:10:00", "endedAt": "Feb 26, 2026, 12:12:30", "duration": "2m 30s", "durationMs": 150000, "details": "HTTP/2 503 - Response time: 1.20s", "isOngoing": false } ], "total": 1 } Hinweis: startedAt und endedAt sind formatierte...

#### Ausfall-Details abrufen
URL: https://uptimeify.io/docs/api/monitoring/ausfall-details-abfragen
Beschreibung: GET /api/incidents/:incidentPublicId
Endpunkte: GET /api/incidents/:incidentPublicId
Wichtige Abschnitte: Authentifizierung | Parameter | Beispiel (cURL) | Antwort (Auszug) | Häufige Fehler
Zusammenfassung: Ausfall-Details abrufen GET /api/incidents/:incidentPublicId Gibt Details zu einem bestimmten Vorfall zurück. Enthält neben den Incident-Basisdaten auch eine Timeline (Checks/Alert-Events) sowie optional einen Evidence-Check. Authentifizierung Erfordert eine gültige Session. Header: Authorization: Bearer <token Parameter incidentPublicId (Path, required): Öffentliche UUID des Incidents. Beispiel (cURL) BASE URL="https://uptimeify.io" TOKEN="<dein-api-token " curl -X GET "$BASE URL/api/incidents/6bfec6f6-245a-47ce-843b-157d97d56f88" \ -H "Authorization: Bearer $TOKEN" \ -H "Accept: application/json" Hinweis: evidenceCheck kann null sein. screenshotUrl ist nur gesetzt, wenn hasScreenshot true ist. Antwort (Auszug) { "incident": { "id": 123, "websiteId": 101, "type": "downtime", "status": "open", "startedAt": "2026-02-26T12:10:00.000Z", "resolvedAt": null, "statusCode": null,...

#### Alert-Historie abrufen
URL: https://uptimeify.io/docs/api/monitoring/eskalation-logs-abfragen
Beschreibung: GET /api/websites/:websitePublicId/alert-history
Endpunkte: GET /api/websites/:websitePublicId/alert-history
Wichtige Abschnitte: Beispiel (cURL) | Antwort (Response) | Häufige Fehler
Zusammenfassung: Alert-Historie abrufen GET /api/websites/:websitePublicId/alert-history Gibt die letzten Benachrichtigungs-/Eskalations-Versuche (bis zu 50) für alle Incidents einer Website zurück. Beispiel (cURL) BASE URL="https://uptimeify.io" TOKEN="<dein-api-token " curl -X GET "$BASE URL/api/websites/6bfec6f6-245a-47ce-843b-157d97d56f88/alert-history" \ -H "Authorization: Bearer $TOKEN" \ -H "Accept: application/json" Antwort (Response) [ { "id": 9001, "incidentId": 501, "type": "webhook", "status": "success", "errorMessage": null, "sentAt": "2026-02-26T12:10:30.000Z", "channelName": "Slack", "channelType": "slack", "channelConfig": { "webhookUrl": "https://hooks.slack.com/..." } } ] Häufige Fehler 400 Website public ID (UUID) required wenn :websitePublicId fehlt 401 Unauthorized wenn du nicht angemeldet bist 403 Forbidden wenn du keinen Zugriff auf die Website hast 500 Failed to fetch alert...

#### Ausfälle auflisten (Organisation)
URL: https://uptimeify.io/docs/api/monitoring/incidents-auflisten
Beschreibung: GET /api/incidents?organizationId=:organizationId
Endpunkte: GET /api/incidents?organizationId=:organizationId
Wichtige Abschnitte: Authentifizierung | Query Parameter | Beispiel (cURL) | Antwort (Auszug) | Häufige Fehler
Zusammenfassung: Ausfälle auflisten (Organisation) GET /api/incidents?organizationId=:organizationId Listet Incidents für eine Organisation auf. Die Daten sind durch deine Session/Permissions eingeschränkt. Readonly-User sehen nur Incidents für Kunden, denen sie zugewiesen sind. Authentifizierung Erfordert eine gültige Session. Header: Authorization: Bearer <token Query Parameter organizationId (optional): Wenn nicht gesetzt, wird die organizationId aus deiner Session verwendet. limit (optional, Standard: 100, max: 500): Maximale Anzahl an Incidents. offset (optional, Standard: 0): Pagination-Offset. includeTotal (optional, Standard: 0): Wenn 1 (oder true), enthält die Response zusätzlich total, limit und offset. Beispiel (cURL) BASE URL="https://uptimeify.io" TOKEN="<dein-api-token " curl -X GET "$BASE URL/api/incidents?organizationId=1" \ -H "Authorization: Bearer $TOKEN" \ -H "Accept:...

#### Letzte Checks abrufen
URL: https://uptimeify.io/docs/api/monitoring/letzte-checks-abfragen
Beschreibung: GET /api/websites/:websitePublicId/check-history
Endpunkte: GET /api/websites/:websitePublicId/check-history
Wichtige Abschnitte: Query Parameter | Pfadparameter | Beispiel (cURL) | Antwort (Response) | Häufige Fehler
Zusammenfassung: Letzte Checks abrufen GET /api/websites/:websitePublicId/check-history Gibt die letzten Monitoring-Checks einer Website zurück. Query Parameter limit (optional, Standard: 50, max: 200) checkType (optional, erlaubt u.a. http status, ssl check, combined, playwright, heartbeat, dns sowie Legacy-Werte wie http oder ssl) Pfadparameter websitePublicId (empfohlen): Public-ID der Website als UUID Legacy-Kompatibilität: numerische Website-IDs werden weiterhin akzeptiert Beispiel (cURL) BASE URL="https://uptimeify.io" TOKEN="<dein-api-token " curl -X GET "$BASE URL/api/websites/6bfec6f6-245a-47ce-843b-157d97d56f88/check-history?limit=25&checkType=dns" \ -H "Authorization: Bearer $TOKEN" \ -H "Accept: application/json" Antwort (Response) { "data": [ { "id": "chk 01H...", "status": "success", "errorMessage": null, "warningMessage": null, "timingDns": 12, "diagnostics": null, "checkedAt":...

#### Metriken abrufen
URL: https://uptimeify.io/docs/api/monitoring/metriken-abfragen
Beschreibung: GET /api/websites/:websitePublicId/uptime-stats
Endpunkte: GET /api/websites/:websitePublicId/uptime-stats
Wichtige Abschnitte: Pfadparameter | Beispiel (cURL) | Antwort (Response) | Häufige Fehler
Zusammenfassung: Metriken abrufen GET /api/websites/:websitePublicId/uptime-stats Gibt Uptime-Prozentsätze und durchschnittliche Antwortzeiten für Tag/Monat/Jahr zurück. Pfadparameter websitePublicId (empfohlen): Public-ID der Website als UUID Legacy-Kompatibilität: numerische Website-IDs werden weiterhin akzeptiert Beispiel (cURL) BASE URL="https://uptimeify.io" TOKEN="<dein-api-token " curl -X GET "$BASE URL/api/websites/6bfec6f6-245a-47ce-843b-157d97d56f88/uptime-stats" \ -H "Authorization: Bearer $TOKEN" \ -H "Accept: application/json" Antwort (Response) { "day": "100.00", "month": "99.95", "year": "99.90", "dayAvgResponse": 125, "monthAvgResponse": 118, "yearAvgResponse": 120 } Häufige Fehler 400 Invalid Website identifier wenn :websitePublicId weder eine gültige UUID noch eine Legacy-ID ist 401 Unauthorized wenn du nicht angemeldet bist 403 Forbidden wenn du keinen Zugriff auf die Website hast

#### Monitoring-Daten abrufen
URL: https://uptimeify.io/docs/api/monitoring/report-generieren
Beschreibung: GET /api/websites/:websitePublicId/monitoring-data
Endpunkte: GET /api/websites/:websitePublicId/monitoring-data?range=day|week|month|year
Wichtige Abschnitte: Query Parameter | Beispiel (cURL) | Antwort (Response) | Häufige Fehler
Zusammenfassung: Monitoring-Daten abrufen GET /api/websites/:websitePublicId/monitoring-data?range=day week month year Gibt aggregierte Timeseries-Daten für Charts zurück (Antwortzeiten, Status-Tracker, Uptime-Prozent etc.). Query Parameter range (optional): day week month year (Standard: day) maxPoints (optional): begrenzt die Anzahl an Datenpunkten (Standard: 300, max: 2000). Hinweis: Die API kann Datenpunkte downsamplen, um die Response klein zu halten. Beispiel (cURL) BASE URL="https://uptimeify.io" TOKEN="<dein-api-token " curl -X GET "$BASE URL/api/websites/6bfec6f6-245a-47ce-843b-157d97d56f88/monitoring-data?range=week" \ -H "Authorization: Bearer $TOKEN" \ -H "Accept: application/json" Antwort (Response) { "responseTimeData": [ { "timestamp": "2026-02-26T12:00:00.000Z", "responseTime": 123, "status": "success", "success": true, "timingDns": 12, "timingTcp": 20, "timingTls": 30, "timingTtfb": 50,...

#### PDF-Bericht herunterladen
URL: https://uptimeify.io/docs/api/monitoring/reports-auflisten
Beschreibung: GET /api/websites/:websitePublicId/report.pdf
Endpunkte: GET /api/websites/:websitePublicId/report.pdf
Wichtige Abschnitte: Query Parameter | Beispiel (cURL) | Antwort (Response) | Häufige Fehler
Zusammenfassung: PDF-Bericht herunterladen GET /api/websites/:websitePublicId/report.pdf Lädt einen generierten PDF-Report für eine Website herunter. Du kannst entweder einen vordefinierten Zeitraum per period verwenden oder einen eigenen Zeitraum per startDate/endDate angeben. Query Parameter period (optional): last-week last-month last-quarter last-year (Standard: last-month) startDate (optional, nur zusammen mit endDate): YYYY-MM-DD endDate (optional, nur zusammen mit startDate): YYYY-MM-DD Beispiel (cURL) BASE URL="https://uptimeify.io" TOKEN="<dein-api-token " curl -L "$BASE URL/api/websites/6bfec6f6-245a-47ce-843b-157d97d56f88/report.pdf?period=last-month" \ -H "Authorization: Bearer $TOKEN" \ -o report.pdf Antwort (Response) Content-Type: application/pdf Body: PDF-Binary Häufige Fehler 400 Website public ID (UUID) required wenn :websitePublicId ungültig ist 401 Unauthorized wenn du nicht...

### Monitore
URL: https://uptimeify.io/docs/api/monitore
Beschreibung: Verwalte Protokoll-Monitore (ICMP, SMTP, SSH, FTP, IMAP/POP).
Wichtige Abschnitte: Ressourcen
Zusammenfassung: Verwalte Protokoll-Monitore (ICMP, SMTP, SSH, FTP, IMAP/POP). Detail-/Update-/Delete-/Check-Endpunkte für Protokoll-Monitore verwenden monitor-spezifische publicId-UUIDs im Pfad. Ressourcen ICMP Monitore SMTP Monitore SSH Monitore FTP Monitore IMAP/POP Monitore DNS Monitore DNSBL-Überwachung (Kunden-IPs) Domain-Ablauf-Überwachung (Kunden-Domains)

#### DNS Monitore
URL: https://uptimeify.io/docs/api/monitore/dns-monitore
Beschreibung: Verwalte DNS-Monitore.
Wichtige Abschnitte: Endpunkte
Zusammenfassung: Verwalte DNS-Monitore, die DNS-Auflösung/Records für einen Hostnamen prüfen. Pfadbasierte DNS-Monitor-Endpunkte verwenden dnsMonitorPublicId-UUIDs. Endpunkte DNS Monitore auflisten DNS Monitor erstellen DNS Monitor abrufen DNS Monitor aktualisieren DNS Monitor löschen DNS Check triggern DNS Monitor Check-Historie abrufen

#### DNS Monitor abrufen
URL: https://uptimeify.io/docs/api/monitore/dns-monitore/dns-monitor-abrufen
Beschreibung: GET /api/dns-monitors/:dnsMonitorPublicId
Endpunkte: GET /api/dns-monitors/:dnsMonitorPublicId
Wichtige Abschnitte: Beispiel-Response
Zusammenfassung: DNS Monitor abrufen GET /api/dns-monitors/:dnsMonitorPublicId Gibt einen einzelnen DNS-Monitor zurück. Die Response enthält nur den DNS-Monitor selbst und bettet keinen vollständigen Kunden-Datensatz ein. Beispiel-Response { "id": 1, "publicId": "3c741f27-7015-4202-93ea-0f97cc6bc769", "organizationId": 2, "customerId": 2, "customerName": "Zaskoku & Haupt GbR", "name": "haupt.design", "hostname": "haupt.design", "checkInterval": 30, "timeoutSeconds": 30, "dnsConfig": { "rrtypes": ["A"], "matchMode": "exact", "triggerOn": { "mismatch": true, "resolveError": true }, "expectedValues": { "A": ["76.76.21.21"] } }, "status": "active", "notificationPhoneNumber": null, "notificationEmail": null, "lastCheckedAt": "2026-04-03T14:55:00.005Z", "createdAt": "2026-02-23T20:24:54.731Z", "updatedAt": "2026-04-03T14:55:01.193Z" }

#### DNS Monitor aktualisieren
URL: https://uptimeify.io/docs/api/monitore/dns-monitore/dns-monitor-aktualisieren-status
Beschreibung: PATCH /api/dns-monitors/:dnsMonitorPublicId
Endpunkte: PATCH /api/dns-monitors/:dnsMonitorPublicId
Wichtige Abschnitte: Request Body (Beispiel) | Beispiel (cURL) | Häufige Fehler
Zusammenfassung: DNS Monitor aktualisieren PATCH /api/dns-monitors/:dnsMonitorPublicId Aktualisiert einen DNS-Monitor. Hinweise: Readonly-User dürfen nur status ändern. Global Supporter dürfen nicht mutieren. Wenn du customerId mitsendest, akzeptiert das Feld entweder die interne numerische ID oder die publicId-UUID des Kunden. Request Body (Beispiel) { "customerId": "6764e84f-f02a-43e6-a46d-cecaec556723", "status": "maintenance", "name": "Primary DNS Monitor", "hostname": "claas.sh", "checkInterval": 30, "timeoutSeconds": 30, "dnsConfig": { "rrtypes": ["A"], "matchMode": "exact", "expectedValues": { "A": ["76.76.21.21"] }, "triggerOn": { "resolveError": true, "mismatch": true } } } Wenn du dnsConfig mitsendest, muss es rrtypes, matchMode und für jeden RR-Type in rrtypes mindestens einen Eintrag in expectedValues enthalten. Beispiel (cURL) BASE URL="https://uptimeify.io" TOKEN="<dein-api-token " curl -X...

#### DNS Monitor Check-Historie abrufen
URL: https://uptimeify.io/docs/api/monitore/dns-monitore/dns-monitor-check-historie-abrufen
Beschreibung: GET /api/dns-monitors/:dnsMonitorPublicId/check-history
Endpunkte: GET /api/dns-monitors/:dnsMonitorPublicId/check-history
Zusammenfassung: DNS Monitor Check-Historie abrufen GET /api/dns-monitors/:dnsMonitorPublicId/check-history Gibt die letzten DNS-Check-Ergebnisse zurück.

#### DNS Check triggern
URL: https://uptimeify.io/docs/api/monitore/dns-monitore/dns-monitor-check-triggern
Beschreibung: POST /api/dns-monitors/:dnsMonitorPublicId/trigger-check
Endpunkte: POST /api/dns-monitors/:dnsMonitorPublicId/trigger-check
Zusammenfassung: DNS Check triggern POST /api/dns-monitors/:dnsMonitorPublicId/trigger-check Triggert einen sofortigen DNS-Check über alle eligible Monitoring-Locations.

#### DNS Monitor erstellen
URL: https://uptimeify.io/docs/api/monitore/dns-monitore/dns-monitor-erstellen
Beschreibung: POST /api/dns-monitors
Endpunkte: POST /api/dns-monitors
Wichtige Abschnitte: Anfrage (Request Body) | Beispiel (cURL) | Häufige Fehler
Zusammenfassung: DNS Monitor erstellen POST /api/dns-monitors Erstellt einen neuen DNS-Monitor für einen Kunden. Anfrage (Request Body) { "customerId": "6bfec6f6-245a-47ce-843b-157d97d56f88", "name": "Example DNS", "hostname": "example.com", "status": "active", "checkInterval": 30, "timeoutSeconds": 30, "dnsConfig": { "rrtypes": ["A", "AAAA"], "matchMode": "exact", "expectedValues": { "A": ["93.184.216.34"], "AAAA": ["2606:2800:220:1:248:1893:25c8:1946"] }, "triggerOn": { "resolveError": true, "mismatch": true } } } Hinweise: customerId, name, hostname, dnsConfig.rrtypes, dnsConfig.matchMode und dnsConfig.expectedValues sind erforderlich. customerId akzeptiert entweder die interne numerische ID oder die publicId-UUID des Kunden. Global Supporter und Readonly-User dürfen keine DNS-Monitore erstellen. hostname muss ein Hostname sein (kein Protokoll, kein Pfad). dnsConfig.expectedValues muss für jeden...

#### DNS Monitor löschen
URL: https://uptimeify.io/docs/api/monitore/dns-monitore/dns-monitor-loeschen
Beschreibung: DELETE /api/dns-monitors/:dnsMonitorPublicId
Endpunkte: DELETE /api/dns-monitors/:dnsMonitorPublicId
Zusammenfassung: DNS Monitor löschen DELETE /api/dns-monitors/:dnsMonitorPublicId Löscht einen DNS-Monitor.

#### DNS Monitore auflisten
URL: https://uptimeify.io/docs/api/monitore/dns-monitore/dns-monitore-auflisten
Beschreibung: GET /api/dns-monitors
Endpunkte: GET /api/dns-monitors
Wichtige Abschnitte: Query Parameter | Beispiel (cURL) | Beispiel-Antwort
Zusammenfassung: DNS Monitore auflisten GET /api/dns-monitors Listet DNS-Monitore einer Organisation (mit Pagination) auf. Jedes Item enthält nur den DNS-Monitor selbst und bettet keinen vollständigen Kunden-Datensatz ein. Query Parameter organizationId (optional): Standard ist deine Session-Organisation customerId (optional) search (optional) page (optional, Default 1) perPage (optional, Default 50, max 200) Beispiel (cURL) BASE URL="https://uptimeify.io" TOKEN="<dein-api-token " curl -X GET \ "$BASE URL/api/dns-monitors?organizationId=1&page=1&perPage=50" \ -H "Authorization: Bearer $TOKEN" \ -H "Accept: application/json" Beispiel-Antwort { "items": [ { "id": 5, "publicId": "79fbe9b0-f9c6-4026-86de-1dbebc84d9bb", "organizationId": 2, "customerId": 2, "customerName": "Zaskoku & Haupt GbR", "name": "Primary DNS Monitor", "hostname": "claas.sh", "checkInterval": 30, "timeoutSeconds": 30, "dnsConfig": {},...

#### DNSBL-Überwachung (Kunden-IPs)
URL: https://uptimeify.io/docs/api/monitore/dnsbl-ueberwachung
Beschreibung: Verwalte Kunden-IPs für DNSBL-Blacklist-Überwachung.
Wichtige Abschnitte: Endpunkte
Zusammenfassung: DNSBL-Überwachung wird über Kunden-IPs konfiguriert. Diese IPs werden periodisch gegen DNS-basierte Blacklists geprüft. Endpunkte Kunden-IPs (Organisation) auflisten Kunden-IP abrufen Kunden-IP aktualisieren Kunden-IP löschen Kunden-IPs (Kunde) auflisten Kunden-IP (für Kunde) erstellen

#### Kunden-IP abrufen
URL: https://uptimeify.io/docs/api/monitore/dnsbl-ueberwachung/kunden-ip-abrufen
Beschreibung: GET /api/customer-ips/:customerIpPublicId
Endpunkte: GET /api/customer-ips/:customerIpPublicId
Wichtige Abschnitte: Beispiel-Response | Pfadparameter | Beispiel (cURL) | Häufige Fehler
Zusammenfassung: Kunden-IP abrufen GET /api/customer-ips/:customerIpPublicId Gibt eine Kunden-IP inkl. DNSBL-Status zurück (falls vorhanden). Die Response enthält die Kunden-IP selbst und, falls vorhanden, ein dnsbl-Objekt. Ein vollständiger Kunden-Datensatz wird nicht eingebettet. Beispiel-Response { "id": 1, "publicId": "a19effb9-eb5f-459b-b5d6-2f615b574651", "customerId": 2, "customerName": "Zaskoku & Haupt GbR", "label": "Kurbelix Adminserver", "ipAddress": "77.75.254.185", "ipFamily": "v4", "status": "active", "createdAt": "2026-02-03T15:06:46.469Z", "updatedAt": "2026-02-03T15:06:46.469Z", "dnsbl": { "isListed": true, "listedCount": 1, "listings": [ { "name": "all.s5h.net", "reason": "Listed in all.s5h.net", "listKey": "all.s5h.net", "delistUrl": "http://s5h.net", "resultCode": "127.0.0.2" } ], "lastError": null, "lastCheckedAt": "2026-04-03T15:13:00.083Z", "lastChangedAt":...

#### Kunden-IP aktualisieren
URL: https://uptimeify.io/docs/api/monitore/dnsbl-ueberwachung/kunden-ip-aktualisieren
Beschreibung: PATCH /api/customer-ips/:customerIpPublicId
Endpunkte: PATCH /api/customer-ips/:customerIpPublicId
Wichtige Abschnitte: Anfrage (Request Body) | Beispiel (cURL) | Häufige Fehler
Zusammenfassung: Kunden-IP aktualisieren PATCH /api/customer-ips/:customerIpPublicId Aktualisiert eine Kunden-IP (z.B. Label oder Status). Hinweise: Readonly-User und Global Supporter dürfen nicht mutieren. Aktivieren kann wegen Quota-Limits abgelehnt werden. Anfrage (Request Body) { "label": "Mail Server", "status": "active" } Beispiel (cURL) BASE URL="https://uptimeify.io" TOKEN="<dein-api-token " curl -X PATCH "$BASE URL/api/customer-ips/11111111-1111-4111-8111-111111111111" \ -H "Authorization: Bearer $TOKEN" \ -H "Content-Type: application/json" \ -d '{"label":"Mail Server","status":"active"}' Häufige Fehler 400 Invalid IP identifier wenn :customerIpPublicId weder UUID noch Legacy-ID ist 400 Body-Validierungsfehler (z.B. ungültiger status) 401 Unauthorized wenn du nicht angemeldet bist 403 Forbidden für Readonly/Global-Supporter oder bei fehlendem Zugriff 403 Active IP limit reached... wenn...

#### Kunden Ip Fuer Kunden Erstellen
URL: https://uptimeify.io/docs/api/monitore/dnsbl-ueberwachung/kunden-ip-fuer-kunden-erstellen
Endpunkte: POST /api/customers/:customerPublicId/ips
Wichtige Abschnitte: Anfrage (Request Body) | Beispiel (cURL) | Häufige Fehler
Zusammenfassung: title: Kunden-IP (für Kunde) erstellen description: POST /api/customers/:customerPublicId/ips --- Kunden-IP (für Kunde) erstellen POST /api/customers/:customerPublicId/ips Erstellt eine neue Kunden-IP für DNSBL-Überwachung. Anfrage (Request Body) { "ipAddress": "203.0.113.10", "label": "Mail Server", "ipFamily": "v4", "status": "active" } Hinweise: customerPublicId sollte die Public-ID des Kunden als UUID sein. Legacy-numerische Kunden-IDs bleiben aus Kompatibilitätsgründen weiter unterstützt. ipFamily ist optional (wird sonst aus der IP abgeleitet). Wenn ipFamily gesetzt ist, muss es zur IP-Version passen. Das Erstellen einer active IP kann wegen Quota-Limits abgelehnt werden. Beispiel (cURL) BASE URL="https://uptimeify.io" TOKEN="<dein-api-token " curl -X POST "$BASE URL/api/customers/6bfec6f6-245a-47ce-843b-157d97d56f88/ips" \ -H "Authorization: Bearer $TOKEN" \ -H "Content-Type:...

#### Kunden-IP löschen
URL: https://uptimeify.io/docs/api/monitore/dnsbl-ueberwachung/kunden-ip-loeschen
Beschreibung: DELETE /api/customer-ips/:customerIpPublicId
Endpunkte: DELETE /api/customer-ips/:customerIpPublicId
Wichtige Abschnitte: Beispiel (cURL) | Beispiel-Antwort | Häufige Fehler
Zusammenfassung: Kunden-IP löschen DELETE /api/customer-ips/:customerIpPublicId Löscht eine Kunden-IP. Hinweis: Readonly-User und Global Supporter dürfen nicht löschen. Beispiel (cURL) BASE URL="https://uptimeify.io" TOKEN="<dein-api-token " curl -X DELETE "$BASE URL/api/customer-ips/11111111-1111-4111-8111-111111111111" \ -H "Authorization: Bearer $TOKEN" Beispiel-Antwort { "success": true } Häufige Fehler 400 Invalid IP identifier wenn :customerIpPublicId weder UUID noch Legacy-ID ist 401 Unauthorized wenn du nicht angemeldet bist 403 Forbidden für Readonly/Global-Supporter oder bei fehlendem Zugriff 404 IP not found wenn die IP nicht existiert

#### Kunden-IPs (Organisation) auflisten
URL: https://uptimeify.io/docs/api/monitore/dnsbl-ueberwachung/kunden-ips-auflisten
Beschreibung: GET /api/customer-ips
Endpunkte: GET /api/customer-ips
Wichtige Abschnitte: Query Parameter | Beispiel (cURL) | Beispiel-Antwort | Häufige Fehler
Zusammenfassung: Kunden-IPs (Organisation) auflisten GET /api/customer-ips Listet Kunden-IPs innerhalb einer Organisation auf (Pagination + Suche). Das ist die primäre Konfiguration für DNSBL-Überwachung. Query Parameter organizationId (optional): Standard ist deine Session-Organisation customerId (optional): akzeptiert die Public-ID des Kunden als UUID (empfohlen) oder eine Legacy-numerische Kunden-ID search (optional) page (optional, Default 1) perPage (optional, Default 50, max 200) Optional bedeutet hier: Parameter komplett weglassen, wenn du sie nicht nutzt. Sende keine leeren Strings wie page= oder perPage=. Beispiel (cURL) BASE URL="https://uptimeify.io" TOKEN="<dein-api-token " curl -X GET "$BASE URL/api/customer-ips?organizationId=1&page=1&perPage=50" \ -H "Authorization: Bearer $TOKEN" \ -H "Accept: application/json" Beispiel-Antwort { "items": [], "total": 0, "page": 1, "perPage": 50 }...

#### Kunden Ips Fuer Kunden Auflisten
URL: https://uptimeify.io/docs/api/monitore/dnsbl-ueberwachung/kunden-ips-fuer-kunden-auflisten
Endpunkte: GET /api/customers/:customerPublicId/ips
Wichtige Abschnitte: Pfadparameter | Beispiel (cURL) | Häufige Fehler
Zusammenfassung: title: Kunden-IPs (Kunde) auflisten description: GET /api/customers/:customerPublicId/ips --- Kunden-IPs (Kunde) auflisten GET /api/customers/:customerPublicId/ips Listet IPs eines Kunden inkl. DNSBL-Status auf. Pfadparameter customerPublicId (empfohlen): Public-ID des Kunden als UUID Legacy-Kompatibilität: numerische Kunden-IDs werden weiterhin akzeptiert Beispiel (cURL) BASE URL="https://uptimeify.io" TOKEN="<dein-api-token " curl -X GET "$BASE URL/api/customers/6bfec6f6-245a-47ce-843b-157d97d56f88/ips" \ -H "Authorization: Bearer $TOKEN" \ -H "Accept: application/json" Häufige Fehler 400 Invalid Customer identifier wenn :customerPublicId fehlt/ungültig ist 401 Unauthorized wenn du nicht angemeldet bist 403 Forbidden wenn du keinen Zugriff auf den Kunden hast 404 Customer not found wenn der Kunde nicht existiert

#### Domain-Ablauf-Überwachung (Kunden-Domains)
URL: https://uptimeify.io/docs/api/monitore/domain-ablauf-ueberwachung
Beschreibung: Verwalte Domains für die Domain-Ablauf-Überwachung.
Wichtige Abschnitte: Endpunkte
Zusammenfassung: Die Domain-Ablauf-Überwachung wird über Kunden-Domains konfiguriert. Endpunkte Kunden-Domain (für Kunde) erstellen Kunden-Domains (Organisation) auflisten Kunden-Domain abrufen Kunden-Domain aktualisieren Kunden-Domain löschen Domain-Ablauf (Websites) auflisten

#### Domain-Ablauf (Websites) auflisten
URL: https://uptimeify.io/docs/api/monitore/domain-ablauf-ueberwachung/domain-ablauf-websites-auflisten
Beschreibung: GET /api/domains
Endpunkte: GET /api/domains
Wichtige Abschnitte: Query Parameter | Beispiel (cURL) | Antwort | Feldnotizen | Häufige Fehler
Zusammenfassung: Domain-Ablauf (Websites) auflisten GET /api/domains Listet Websites mit den zuletzt bekannten Informationen zum Domain-Ablaufdatum auf. Query Parameter organizationId (optional): Standard ist deine Session-Organisation customerId (optional) search (optional) page (optional, Default 1) perPage (optional, Default 50, max 200) Beispiel (cURL) BASE URL="https://uptimeify.io" TOKEN="<dein-api-token " curl -X GET "$BASE URL/api/domains?organizationId=1&page=1&perPage=50" \ -H "Authorization: Bearer $TOKEN" \ -H "Accept: application/json" Antwort { "items": [ { "id": 101, "name": "Example Website", "url": "https://example.com", "status": "active", "customerId": 10, "customerName": "Example Customer", "checkDomainExpiryEnabled": true, "domainExpiryNoticeDays": 30, "domainExpiryErrorDays": 7, "domainExpiresAt": "2026-12-31T00:00:00.000Z", "domainRegistrar": "Example Registrar",...

#### Kunden-Domain abrufen
URL: https://uptimeify.io/docs/api/monitore/domain-ablauf-ueberwachung/kunden-domain-abrufen
Beschreibung: GET /api/customer-domains/:customerDomainPublicId
Endpunkte: GET /api/customer-domains/:customerDomainPublicId
Wichtige Abschnitte: Pfadparameter | Beispiel (cURL) | Beispiel-Response | Häufige Fehler
Zusammenfassung: Kunden-Domain abrufen GET /api/customer-domains/:customerDomainPublicId Gibt eine einzelne Kunden-Domain zurück. Die Response enthält die Kunden-Domain selbst und bettet keinen vollständigen Kunden-Datensatz ein. Pfadparameter customerDomainPublicId (empfohlen): Public-ID der Kunden-Domain als UUID Legacy-Kompatibilität: numerische IDs werden weiterhin akzeptiert Hinweise: Einige Registries/TLDs (z.B. .de) veröffentlichen kein Ablaufdatum via RDAP. In diesem Fall kann expiry.domainExpiresAt null sein und expiry.lastError enthält ggf. eine erklärende Fehlermeldung. Beispiel (cURL) BASE URL="https://uptimeify.io" TOKEN="<dein-api-token " curl -X GET "$BASE URL/api/customer-domains/22222222-2222-4222-8222-222222222222" \ -H "Authorization: Bearer $TOKEN" \ -H "Accept: application/json" Beispiel-Response { "id": 20, "publicId": "d70884d9-4cef-4fe5-9b15-341b7dd9e196", "customerId": 2,...

#### Kunden-Domain aktualisieren
URL: https://uptimeify.io/docs/api/monitore/domain-ablauf-ueberwachung/kunden-domain-aktualisieren
Beschreibung: PATCH /api/customer-domains/:customerDomainPublicId
Endpunkte: PATCH /api/customer-domains/:customerDomainPublicId
Wichtige Abschnitte: Request Body | Beispiel (cURL) | Antwort | Häufige Fehler
Zusammenfassung: Kunden-Domain aktualisieren PATCH /api/customer-domains/:customerDomainPublicId Aktualisiert eine Kunden-Domain (z.B. Label, Status, Ablauf-Schwellenwerte). Hinweise: Readonly-User und Global-Supporter können Kunden-Domains nicht aktualisieren. Das Aktivieren einer deaktivierten Domain kann abgelehnt werden, wenn Quota-Limits erreicht sind. Request Body { "label": "Main Domain", "status": "active", "expiryWarningDays": 30, "expiryErrorDays": 7 } Beispiel (cURL) BASE URL="https://uptimeify.io" TOKEN="<dein-api-token " curl -X PATCH "$BASE URL/api/customer-domains/22222222-2222-4222-8222-222222222222" \ -H "Authorization: Bearer $TOKEN" \ -H "Content-Type: application/json" \ -d '{"status":"active"}' Antwort Gibt den aktualisierten Kunden-Domain-Record zurück. Häufige Fehler 400 Body-Validierungsfehler (z.B. ungültige Thresholds) 400 Invalid Domain identifier wenn :customerDomainPublicId...

#### Kunden Domain Fuer Kunden Erstellen
URL: https://uptimeify.io/docs/api/monitore/domain-ablauf-ueberwachung/kunden-domain-fuer-kunden-erstellen
Endpunkte: POST /api/customers/:customerPublicId/domains
Wichtige Abschnitte: Request Body | Beispiel (cURL) | Antwort | Häufige Fehler
Zusammenfassung: title: Kunden-Domain erstellen (Kunde) description: POST /api/customers/:customerPublicId/domains --- Kunden-Domain erstellen (Kunde) POST /api/customers/:customerPublicId/domains Erstellt eine Kunden-Domain für die Ablauf-Überwachung. Request Body { "domainName": "example.com", "label": "Main Domain", "status": "active", "expiryWarningDays": 30, "expiryErrorDays": 7 } Hinweise: customerPublicId sollte die Public-ID des Kunden als UUID sein. Legacy-numerische Kunden-IDs bleiben aus Kompatibilitätsgründen weiter unterstützt. domainName muss eine gültige Domain wie example.com sein (kein Protokoll, kein Pfad). Das Erstellen einer active Domain kann durch Quota-Limits blockiert werden. Beispiel (cURL) BASE URL="https://uptimeify.io" TOKEN="<dein-api-token " curl -X POST "$BASE URL/api/customers/6bfec6f6-245a-47ce-843b-157d97d56f88/domains" \ -H "Authorization: Bearer $TOKEN" \ -H...

#### Kunden-Domain löschen
URL: https://uptimeify.io/docs/api/monitore/domain-ablauf-ueberwachung/kunden-domain-loeschen
Beschreibung: DELETE /api/customer-domains/:customerDomainPublicId
Endpunkte: DELETE /api/customer-domains/:customerDomainPublicId
Wichtige Abschnitte: Beispiel (cURL) | Beispiel-Antwort | Häufige Fehler
Zusammenfassung: Kunden-Domain löschen DELETE /api/customer-domains/:customerDomainPublicId Löscht eine Kunden-Domain. Hinweise: Readonly-User und Global-Supporter können Kunden-Domains nicht löschen. Beispiel (cURL) BASE URL="https://uptimeify.io" TOKEN="<dein-api-token " curl -X DELETE "$BASE URL/api/customer-domains/22222222-2222-4222-8222-222222222222" \ -H "Authorization: Bearer $TOKEN" Beispiel-Antwort { "success": true } Häufige Fehler 400 Invalid Domain identifier wenn :customerDomainPublicId weder UUID noch Legacy-ID ist 401 Unauthorized wenn du nicht angemeldet bist 403 Forbidden für Readonly/Global-Supporter-User, oder wenn du keinen Zugriff auf die Domain/den Kunden hast 404 Domain not found wenn die Domain nicht existiert

#### Kunden-Domains (Organisation) auflisten
URL: https://uptimeify.io/docs/api/monitore/domain-ablauf-ueberwachung/kunden-domains-auflisten
Beschreibung: GET /api/customer-domains
Endpunkte: GET /api/customer-domains
Wichtige Abschnitte: Query Parameter | Beispiel (cURL) | Antwort | Häufige Fehler
Zusammenfassung: Kunden-Domains (Organisation) auflisten GET /api/customer-domains Listet Kunden-Domains innerhalb einer Organisation auf (Pagination + Suche). Query Parameter organizationId (optional): Standard ist deine Session-Organisation customerId (optional): akzeptiert die Public-ID des Kunden als UUID (empfohlen) oder eine Legacy-numerische Kunden-ID search (optional) page (optional, Default 1) perPage (optional, Default 50, max 200) Optional bedeutet hier: Parameter komplett weglassen, wenn du sie nicht nutzt. Sende keine leeren Strings wie page= oder perPage=. Beispiel (cURL) BASE URL="https://uptimeify.io" TOKEN="<dein-api-token " curl -X GET "$BASE URL/api/customer-domains?organizationId=1&page=1&perPage=50" \ -H "Authorization: Bearer $TOKEN" \ -H "Accept: application/json" Antwort Gibt eine paginierte Antwort zurück: { "items": [ { "id": 1, "publicId":...

#### FTP Monitore
URL: https://uptimeify.io/docs/api/monitore/ftp-monitore
Beschreibung: Verwalte FTP Monitore.
Wichtige Abschnitte: Endpunkte
Zusammenfassung: Verwalte FTP Monitore. Pfadbasierte FTP-Monitor-Endpunkte verwenden ftpMonitorPublicId-UUIDs. Endpunkte FTP Monitore auflisten FTP Monitor erstellen FTP Monitor abrufen FTP Monitor Details abrufen FTP Monitor Check-Historie abrufen FTP Monitor aktualisieren (Status ändern) FTP Monitor löschen FTP Check triggern

#### FTP Monitor abrufen
URL: https://uptimeify.io/docs/api/monitore/ftp-monitore/ftp-monitor-abrufen
Beschreibung: GET /api/ftp-monitors/:ftpMonitorPublicId
Endpunkte: GET /api/ftp-monitors/:ftpMonitorPublicId
Wichtige Abschnitte: Authentifizierung | Parameter | Beispiel (cURL) | Response | Häufige Fehler
Zusammenfassung: FTP Monitor abrufen GET /api/ftp-monitors/:ftpMonitorPublicId Gibt Details zu einem FTP Monitor zurück. Die Response enthält nur den FTP-Monitor selbst und bettet keinen vollständigen Kunden-Datensatz ein. Authentifizierung Authorization: Bearer <token Parameter ftpMonitorPublicId (Pfad, erforderlich): Öffentliche UUID des FTP Monitors. Beispiel (cURL) BASE URL="https://uptimeify.io" TOKEN="<your-api-token " curl -X GET \ "$BASE URL/api/ftp-monitors/55555555-5555-4555-8555-555555555555" \ -H "Authorization: Bearer $TOKEN" Response { "id": 400, "organizationId": 1, "customerId": 10, "name": "Partner FTP", "hostname": "ftp.example.com", "port": 21, "status": "active", "checkInterval": 30, "timeoutSeconds": 30, "allowedCheckCountryCodes": null, "notificationPhoneNumber": null, "notificationEmail": null, "lastCheckedAt": null, "createdAt": "2026-02-25T10:00:00.000Z", "updatedAt":...

#### FTP Monitor aktualisieren (Status ändern)
URL: https://uptimeify.io/docs/api/monitore/ftp-monitore/ftp-monitor-aktualisieren-status
Beschreibung: PATCH /api/ftp-monitors/:ftpMonitorPublicId
Endpunkte: PATCH /api/ftp-monitors/:ftpMonitorPublicId
Wichtige Abschnitte: Authentifizierung | Parameter | Request Body | Beispiel (cURL) | Response | Häufige Fehler
Zusammenfassung: FTP Monitor aktualisieren (Status ändern) PATCH /api/ftp-monitors/:ftpMonitorPublicId Aktualisiert einen FTP Monitor und/oder ändert den Status. Authentifizierung Authorization: Bearer <token Parameter ftpMonitorPublicId (Pfad, erforderlich): Öffentliche UUID des FTP Monitors. Request Body status (optional): active, maintenance, disabled (akzeptiert auch inactive/paused und normalisiert zu disabled) customerId (optional, number): Muss zur selben Organisation gehören name (optional, string) hostname (optional, string): Muss ein Hostname sein (kein Protokoll, kein Pfad) port (optional, number null) checkInterval (optional, number) timeoutSeconds (optional, number) allowedCheckCountryCodes (optional, string[] null): ISO-3166-1 alpha-2, z.B. "DE", "US" ftpConfig (optional, object): Ersetzt die gespeicherte FTP-Config (JSON) config (optional, object): Alias von ftpConfig Hinweis: Read-only...

#### FTP Monitor Check-Historie abrufen
URL: https://uptimeify.io/docs/api/monitore/ftp-monitore/ftp-monitor-check-historie-abrufen
Beschreibung: GET /api/ftp-monitors/:ftpMonitorPublicId/check-history
Endpunkte: GET /api/ftp-monitors/:ftpMonitorPublicId/check-history
Wichtige Abschnitte: Authentifizierung | Parameter | Beispiel (cURL) | Beispiel Response | Häufige Fehler
Zusammenfassung: FTP Monitor Check-Historie abrufen GET /api/ftp-monitors/:ftpMonitorPublicId/check-history Gibt die letzten FTP-Check-Ergebnisse für einen Monitor zurück. Authentifizierung Authorization: Bearer <token Parameter ftpMonitorPublicId (Pfad, erforderlich): Öffentliche UUID des FTP Monitors. limit (Query, optional): Anzahl Ergebnisse (Default: 50, Max: 200) Beispiel (cURL) BASE URL="https://uptimeify.io" TOKEN="<your-api-token " curl -X GET \ "$BASE URL/api/ftp-monitors/55555555-5555-4555-8555-555555555555/check-history?limit=25" \ -H "Authorization: Bearer $TOKEN" Beispiel Response { "data": [ { "id": "2fd6d5ab-1e2a-4b4f-9c42-0f3a33a4a1d2", "status": "success", "errorMessage": null, "warningMessage": null, "timingFtp": 123, "diagnostics": { "message": "FTP connection successful" }, "checkedAt": "2026-02-25T10:05:00.000Z", "locationId": 1, "locationName": "Frankfurt", "locationCode": "DE" }...

#### FTP Check triggern
URL: https://uptimeify.io/docs/api/monitore/ftp-monitore/ftp-monitor-check-triggern
Beschreibung: POST /api/ftp-monitors/:ftpMonitorPublicId/trigger-check
Endpunkte: POST /api/ftp-monitors/:ftpMonitorPublicId/trigger-check
Wichtige Abschnitte: Authentifizierung | Parameter | Beispiel (cURL) | Response | Häufige Fehler
Zusammenfassung: FTP Check triggern POST /api/ftp-monitors/:ftpMonitorPublicId/trigger-check Startet einen sofortigen Check von allen zulässigen Monitoring-Standorten. Authentifizierung Authorization: Bearer <token Parameter ftpMonitorPublicId (Pfad, erforderlich): Öffentliche UUID des FTP Monitors. Beispiel (cURL) BASE URL="https://uptimeify.io" TOKEN="<your-api-token " curl -X POST \ "$BASE URL/api/ftp-monitors/55555555-5555-4555-8555-555555555555/trigger-check" \ -H "Authorization: Bearer $TOKEN" Response { "success": true, "message": "Checks triggered successfully", "ftpMonitorId": 400, "locationCodes": ["DE", "US"], "queueNames": ["ftp-monitor-checks-DE", "ftp-monitor-checks-US"] } Häufige Fehler 400 FTP monitor public ID (UUID) required wenn ftpMonitorPublicId fehlt oder ungültig ist 400 No eligible monitoring locations for the selected allowed countries wenn deine Country-Restriction keine...

#### FTP Monitor Details abrufen
URL: https://uptimeify.io/docs/api/monitore/ftp-monitore/ftp-monitor-details-abrufen
Beschreibung: GET /api/ftp-monitors/:ftpMonitorPublicId/details
Endpunkte: GET /api/ftp-monitors/:ftpMonitorPublicId/details
Wichtige Abschnitte: Authentifizierung | Parameter | Query Parameter | Beispiel (cURL) | Beispiel Response (Shape) | Häufige Fehler
Zusammenfassung: FTP Monitor Details abrufen GET /api/ftp-monitors/:ftpMonitorPublicId/details Gibt die FTP-Monitor-Detailseiten-Daten in einem Call zurück (Mega-Endpoint). Authentifizierung Authorization: Bearer <token Parameter ftpMonitorPublicId (Pfad, erforderlich): Öffentliche UUID des FTP Monitors. Query Parameter range (optional): day (default), week, month, year date (optional): Referenzdatum (ISO String) startDate / endDate (optional): Überschreibt das Zeitfenster (ISO Strings) granularity (optional): Wenn weggelassen, kann der Server bei großen Zeiträumen automatisch aggregieren. Nutze granularity=raw, um Raw-Daten zu erzwingen. Beispiel (cURL) BASE URL="https://uptimeify.io" TOKEN="<your-api-token " curl -X GET \ "$BASE URL/api/ftp-monitors/55555555-5555-4555-8555-555555555555/details?range=day" \ -H "Authorization: Bearer $TOKEN" Beispiel Response (Shape) Die Response ist ein einzelnes...

#### FTP Monitor erstellen
URL: https://uptimeify.io/docs/api/monitore/ftp-monitore/ftp-monitor-erstellen
Beschreibung: POST /api/ftp-monitors
Endpunkte: POST /api/ftp-monitors
Wichtige Abschnitte: Authentifizierung | Request Body | ftpConfig | Beispiel (cURL) | Response | Häufige Fehler
Zusammenfassung: FTP Monitor erstellen POST /api/ftp-monitors Erstellt einen neuen FTP Monitor. Authentifizierung Dieser Endpoint benötigt ein API-Token: Authorization: Bearer <token Request Body customerId (required, number string): interne numerische Kunden-ID oder Customer-publicId-UUID name (required, string) hostname (required, string): Muss ein Hostname sein (kein Protokoll, kein Pfad). port (optional, number null): Wenn weggelassen/null, nutzt der Worker einen Default-Port. status (optional): active, maintenance, disabled (akzeptiert auch inactive und normalisiert zu disabled) checkInterval (optional, number): Minuten (min: 1, max: 60) timeoutSeconds (optional, number): Sekunden (min: 1, max: 60) ftpConfig (optional, object): FTP-Verbindungsoptionen (als JSON gespeichert) ftpConfig Der Monitoring-Worker liest diese Keys: user (optional, string): Default anonymous password (optional, string):...

#### FTP Monitor löschen
URL: https://uptimeify.io/docs/api/monitore/ftp-monitore/ftp-monitor-loeschen
Beschreibung: DELETE /api/ftp-monitors/:ftpMonitorPublicId
Endpunkte: DELETE /api/ftp-monitors/:ftpMonitorPublicId
Wichtige Abschnitte: Authentifizierung | Parameter | Beispiel (cURL) | Response | Häufige Fehler
Zusammenfassung: FTP Monitor löschen DELETE /api/ftp-monitors/:ftpMonitorPublicId Löscht einen FTP Monitor. Authentifizierung Authorization: Bearer <token Parameter ftpMonitorPublicId (Pfad, erforderlich): Öffentliche UUID des FTP Monitors. Beispiel (cURL) BASE URL="https://uptimeify.io" TOKEN="<your-api-token " curl -X DELETE \ "$BASE URL/api/ftp-monitors/55555555-5555-4555-8555-555555555555" \ -H "Authorization: Bearer $TOKEN" Response { "success": true } Häufige Fehler 401 Unauthorized wenn du nicht authentifiziert bist 403 Forbidden wenn du keine Schreibrechte hast (z.B. Global Supporter oder Read-only) 404 FTP monitor not found wenn der Monitor nicht existiert

#### FTP Monitore auflisten
URL: https://uptimeify.io/docs/api/monitore/ftp-monitore/ftp-monitore-auflisten
Beschreibung: GET /api/ftp-monitors
Endpunkte: GET /api/ftp-monitors
Wichtige Abschnitte: Authentifizierung | Parameter | Beispiel (cURL) | Response | Häufige Fehler
Zusammenfassung: FTP Monitore auflisten GET /api/ftp-monitors Listet FTP Monitore einer Organisation auf. Authentifizierung Authorization: Bearer <token Parameter organizationId (Query, optional): Organisations-ID. Default ist die Organisation des aktuellen Nutzers. customerId (Query, optional): Nach Kunden-ID filtern. search (Query, optional): Suche nach Name, Hostname oder Kunde. page (Query, optional): Seite (Default: 1). perPage (Query, optional): Einträge pro Seite (Default: 50, Max: 200). Hinweis: Die Ergebnisse sind zusätzlich durch deinen Customer-Scope begrenzt (falls dein Account auf eine Teilmenge von Kunden eingeschränkt ist). Beispiel (cURL) BASE URL="https://uptimeify.io" TOKEN="<your-api-token " curl -X GET \ "$BASE URL/api/ftp-monitors?page=1&perPage=50&search=ftp" \ -H "Authorization: Bearer $TOKEN" Response { "items": [ { "id": 400, "organizationId": 1, "customerId": 10,...

#### ICMP Monitore
URL: https://uptimeify.io/docs/api/monitore/icmp-monitore
Beschreibung: Verwalte ICMP (Ping) Monitore.
Wichtige Abschnitte: Endpunkte
Zusammenfassung: Verwalte ICMP (Ping) Monitore. Pfadbasierte ICMP-Monitor-Endpunkte verwenden icmpMonitorPublicId-UUIDs. Endpunkte ICMP Monitore auflisten ICMP Monitor erstellen ICMP Monitor abrufen ICMP Monitor Details abrufen ICMP Monitor Check-Historie abrufen ICMP Monitor aktualisieren ICMP Monitor löschen ICMP Check triggern

#### ICMP Monitor abrufen
URL: https://uptimeify.io/docs/api/monitore/icmp-monitore/icmp-monitor-abrufen
Beschreibung: GET /api/icmp-monitors/:icmpMonitorPublicId
Endpunkte: GET /api/icmp-monitors/:icmpMonitorPublicId
Wichtige Abschnitte: Authentifizierung | Parameter | cURL | Response | Fehler
Zusammenfassung: ICMP Monitor abrufen GET /api/icmp-monitors/:icmpMonitorPublicId Gibt Details zu einem ICMP Monitor zurück. Die Response enthält nur den ICMP-Monitor selbst und bettet keinen vollständigen Kunden-Datensatz ein. Authentifizierung Erfordert eine gültige Session. Header: Authorization: Bearer <token Parameter icmpMonitorPublicId (Pfad, erforderlich): Öffentliche UUID des ICMP-Monitors. cURL curl "https://YOUR DOMAIN/api/icmp-monitors/22222222-2222-4222-8222-222222222222" \ -H "Authorization: Bearer $TOKEN" Response { "id": 123, "organizationId": 1, "customerId": 10, "name": "Core Router", "hostname": "10.0.0.1", "port": null, "status": "active", "checkInterval": 30, "timeoutSeconds": 30, "config": { "packetSize": 56, "count": 3 }, "notificationPhoneNumber": null, "notificationEmail": null, "lastCheckedAt": null, "createdAt": "2026-02-26T12:00:00.000Z", "updatedAt":...

#### ICMP Monitor aktualisieren
URL: https://uptimeify.io/docs/api/monitore/icmp-monitore/icmp-monitor-aktualisieren-status
Beschreibung: PATCH /api/icmp-monitors/:icmpMonitorPublicId
Endpunkte: PATCH /api/icmp-monitors/:icmpMonitorPublicId
Wichtige Abschnitte: Authentifizierung | Parameter | Request Body | cURL | Response | Fehler
Zusammenfassung: ICMP Monitor aktualisieren PATCH /api/icmp-monitors/:icmpMonitorPublicId Aktualisiert einen ICMP Monitor. Dieser Endpunkt wird auch genutzt, um den Status zu wechseln. Authentifizierung Erfordert eine gültige Session. Header: Authorization: Bearer <token Parameter icmpMonitorPublicId (Pfad, erforderlich): Öffentliche UUID des ICMP Monitors. Request Body Alle Felder sind optional. status (optional) - Erlaubt: active, maintenance, disabled, paused, inactive - Hinweis: paused / inactive werden zu disabled normalisiert. name, hostname, checkInterval, timeoutSeconds (optional) port (optional) - Wird von der API akzeptiert, aktuell aber nicht vom ICMP Worker genutzt. allowedCheckCountryCodes (optional) - Wird auf Großbuchstaben normalisiert und dedupliziert. icmpConfig (optional) - Alias für das gespeicherte config JSON. config (optional) - Alternative Möglichkeit, das gleiche gespeicherte...

#### ICMP Monitor Check-Historie abrufen
URL: https://uptimeify.io/docs/api/monitore/icmp-monitore/icmp-monitor-check-historie-abrufen
Beschreibung: GET /api/icmp-monitors/:icmpMonitorPublicId/check-history
Endpunkte: GET /api/icmp-monitors/:icmpMonitorPublicId/check-history
Wichtige Abschnitte: Authentifizierung | Parameter | cURL | Response | Fehler
Zusammenfassung: ICMP Monitor Check-Historie abrufen GET /api/icmp-monitors/:icmpMonitorPublicId/check-history Gibt die letzten Check-Ergebnisse für den ICMP Monitor zurück. Authentifizierung Erfordert eine gültige Session. Header: Authorization: Bearer <token Parameter icmpMonitorPublicId (Pfad, erforderlich): Öffentliche UUID des ICMP Monitors. limit (Query, optional): Maximale Anzahl an Ergebnissen (Default: 50, Max: 200). cURL curl -X GET "https://YOUR DOMAIN/api/icmp-monitors/22222222-2222-4222-8222-222222222222/check-history?limit=50" \ -H "Authorization: Bearer $TOKEN" Response { "data": [ { "id": "f6b0e5a7-4c4a-4d3b-9f6b-0e5a74c4a4d3", "status": "success", "errorMessage": null, "warningMessage": null, "timingIcmp": 22, "diagnostics": { "min": 11.1, "avg": 22.2, "max": 33.3, "packetLoss": 0 }, "checkedAt": "2026-02-26T12:00:00.000Z", "locationId": 1, "locationName": "Frankfurt", "locationCode":...

#### ICMP Check triggern
URL: https://uptimeify.io/docs/api/monitore/icmp-monitore/icmp-monitor-check-triggern
Beschreibung: POST /api/icmp-monitors/:icmpMonitorPublicId/trigger-check
Endpunkte: POST /api/icmp-monitors/:icmpMonitorPublicId/trigger-check
Wichtige Abschnitte: Authentifizierung | Parameter | cURL | Response | Fehler
Zusammenfassung: ICMP Check triggern POST /api/icmp-monitors/:icmpMonitorPublicId/trigger-check Startet einen sofortigen Check von allen zulässigen Monitoring-Standorten. Authentifizierung Erfordert eine gültige Session. Header: Authorization: Bearer <token Parameter icmpMonitorPublicId (Pfad, erforderlich): Öffentliche UUID des ICMP Monitors. cURL curl -X POST "https://YOUR DOMAIN/api/icmp-monitors/22222222-2222-4222-8222-222222222222/trigger-check" \ -H "Authorization: Bearer $TOKEN" Response { "success": true, "message": "Checks triggered successfully", "icmpMonitorId": 123, "locationCodes": ["fra", "nyc"], "queueNames": ["icmp-monitor-checks-fra", "icmp-monitor-checks-nyc"] } Fehler 400 ICMP Monitor Public ID (UUID) erforderlich oder keine zulässigen Standorte 401 Unauthorized 403 Forbidden 404 ICMP Monitor nicht gefunden 503 Keine aktiven Monitoring-Standorte verfügbar 500 Failed to trigger check

#### ICMP Monitor Details abrufen
URL: https://uptimeify.io/docs/api/monitore/icmp-monitore/icmp-monitor-details-abrufen
Beschreibung: GET /api/icmp-monitors/:icmpMonitorPublicId/details
Endpunkte: GET /api/icmp-monitors/:icmpMonitorPublicId/details
Wichtige Abschnitte: Authentifizierung | Parameter | Time-Range Query-Parameter | cURL | Response | Fehler
Zusammenfassung: ICMP Monitor Details abrufen GET /api/icmp-monitors/:icmpMonitorPublicId/details Gibt ein konsolidiertes Payload zurück, das in der Monitor-Detailseite verwendet wird (u. a. Monitor, letzter Check, aggregierte Daten im Zeitbereich). Authentifizierung Erfordert eine gültige Session. Header: Authorization: Bearer <token Parameter icmpMonitorPublicId (Pfad, erforderlich): Öffentliche UUID des ICMP Monitors. Time-Range Query-Parameter Der Zeitbereich kann auf mehrere Arten definiert werden. Nutze die einfachste Option für deinen Use-Case: range (Query, optional): Preset-Zeitraum. - Erlaubt: day (Default), week, month, year date (Query, optional): Referenzdatum, das als Default-Ende verwendet wird. - Beispiel: 2026-02-26 startDate (Query, optional): Startdatum/-zeit. endDate (Query, optional): Enddatum/-zeit. granularity (Query, optional): Steuert Aggregation. - Nutze raw, um Aggregation zu...

#### ICMP Monitor erstellen
URL: https://uptimeify.io/docs/api/monitore/icmp-monitore/icmp-monitor-erstellen
Beschreibung: POST /api/icmp-monitors
Endpunkte: POST /api/icmp-monitors
Wichtige Abschnitte: Authentifizierung | Request Body | Felder | icmpConfig (vom Worker unterstützte Keys) | cURL | Response
Zusammenfassung: ICMP Monitor erstellen POST /api/icmp-monitors Erstellt einen neuen ICMP Monitor. Authentifizierung Erfordert eine gültige Session. Header: Authorization: Bearer <token Request Body { "customerId": "6764e84f-f02a-43e6-a46d-cecaec556723", "name": "Ping Gateway", "hostname": "claas.sh", "status": "active", "checkInterval": 5, "timeoutSeconds": 10, "icmpConfig": { "packetSize": 56, "count": 4 } } Felder customerId (number string, required) - Akzeptiert die interne numerische Kunden-ID oder die Customer-publicId-UUID. name (string, required) hostname (string, required) - Muss nur Hostname oder IP sein (kein Protokoll wie https://, kein Pfad wie /ping). status (string, optional) - Erlaubt: active, maintenance, disabled, paused, inactive - Hinweis: paused / inactive werden zu disabled normalisiert. checkInterval (number, optional) timeoutSeconds (number, optional) icmpConfig (object,...

#### ICMP Monitor löschen
URL: https://uptimeify.io/docs/api/monitore/icmp-monitore/icmp-monitor-loeschen
Beschreibung: DELETE /api/icmp-monitors/:icmpMonitorPublicId
Endpunkte: DELETE /api/icmp-monitors/:icmpMonitorPublicId
Wichtige Abschnitte: Authentifizierung | Parameter | cURL | Response | Fehler
Zusammenfassung: ICMP Monitor löschen DELETE /api/icmp-monitors/:icmpMonitorPublicId Löscht einen ICMP Monitor. Authentifizierung Erfordert eine gültige Session. Header: Authorization: Bearer <token Parameter icmpMonitorPublicId (Pfad, erforderlich): Öffentliche UUID des ICMP Monitors. cURL curl -X DELETE "https://YOUR DOMAIN/api/icmp-monitors/22222222-2222-4222-8222-222222222222" \ -H "Authorization: Bearer $TOKEN" Response { "success": true } Fehler 400 ICMP Monitor Public ID (UUID) erforderlich 401 Unauthorized 403 Forbidden 404 ICMP Monitor nicht gefunden

#### ICMP Monitore auflisten
URL: https://uptimeify.io/docs/api/monitore/icmp-monitore/icmp-monitore-auflisten
Beschreibung: GET /api/icmp-monitors
Endpunkte: GET /api/icmp-monitors
Wichtige Abschnitte: Authentifizierung | Parameter | cURL | Response | Fehler
Zusammenfassung: ICMP Monitore auflisten GET /api/icmp-monitors Listet ICMP Monitore einer Organisation auf. Authentifizierung Erfordert eine gültige Session. Header: Authorization: Bearer <token Parameter organizationId (Query, optional): Organisations-ID. Default ist die Organisation des aktuellen Nutzers. customerId (Query, optional): Nach Kunden-ID filtern. search (Query, optional): Suche nach Name, Hostname oder Kunde. page (Query, optional): Seite (Default: 1). perPage (Query, optional): Einträge pro Seite (Default: 50, Max: 200). cURL curl "https://YOUR DOMAIN/api/icmp-monitors?page=1&perPage=50" \ -H "Authorization: Bearer $TOKEN" Response { "items": [ { "id": 123, "organizationId": 1, "customerId": 10, "customerName": "Example Customer", "name": "Core Router", "hostname": "10.0.0.1", "status": "active", "checkInterval": 30, "timeoutSeconds": 30, "port": null, "config": { "packetSize": 56,...

#### IMAP/POP Monitore
URL: https://uptimeify.io/docs/api/monitore/imap-pop-monitore
Beschreibung: Verwalte IMAP/POP Monitore.
Wichtige Abschnitte: Endpunkte
Zusammenfassung: Verwalte IMAP/POP Monitore. Pfadbasierte IMAP/POP-Monitor-Endpunkte verwenden imapPopMonitorPublicId-UUIDs. Endpunkte IMAP/POP Monitore auflisten IMAP/POP Monitor erstellen IMAP/POP Monitor abrufen IMAP/POP Monitor aktualisieren IMAP/POP Monitor löschen IMAP/POP Check triggern IMAP/POP Monitor Details abrufen IMAP/POP Monitor Check Historie abrufen

#### IMAP/POP Monitor abrufen
URL: https://uptimeify.io/docs/api/monitore/imap-pop-monitore/imap-pop-monitor-abrufen
Beschreibung: GET /api/imap-pop-monitors/:imapPopMonitorPublicId
Endpunkte: GET /api/imap-pop-monitors/:imapPopMonitorPublicId
Wichtige Abschnitte: Authentifizierung | Parameter | cURL | Response | Errors
Zusammenfassung: IMAP/POP Monitor abrufen GET /api/imap-pop-monitors/:imapPopMonitorPublicId Gibt Details zu einem IMAP/POP Monitor zurück. Authentifizierung Erfordert eine gültige Session. Header: Authorization: Bearer <token Parameter imapPopMonitorPublicId (Pfad, erforderlich): Öffentliche UUID des IMAP/POP Monitors. cURL curl -X GET "https://YOUR DOMAIN/api/imap-pop-monitors/66666666-6666-4666-8666-666666666666" \ -H "Authorization: Bearer $TOKEN" Response { "id": 500, "organizationId": 1, "customerId": 10, "name": "Mailbox Access", "hostname": "mail.example.com", "port": 993, "checkInterval": 30, "timeoutSeconds": 30, "config": { "protocol": "imap", "user": "monitor@example.com", "password": "password", "tls": true }, "allowedCheckCountryCodes": null, "status": "active", "notificationPhoneNumber": null, "notificationEmail": null, "lastCheckedAt": null, "createdAt": "2026-02-26T12:00:00.000Z",...

#### IMAP/POP Monitor aktualisieren
URL: https://uptimeify.io/docs/api/monitore/imap-pop-monitore/imap-pop-monitor-aktualisieren-status
Beschreibung: PATCH /api/imap-pop-monitors/:imapPopMonitorPublicId
Endpunkte: PATCH /api/imap-pop-monitors/:imapPopMonitorPublicId
Wichtige Abschnitte: Authentifizierung | Parameter | Request Body | Response | Errors
Zusammenfassung: IMAP/POP Monitor aktualisieren PATCH /api/imap-pop-monitors/:imapPopMonitorPublicId Aktualisiert einen IMAP/POP Monitor und/oder ändert den Status. Authentifizierung Erfordert eine gültige Session. Header: Authorization: Bearer <token Parameter imapPopMonitorPublicId (Pfad, erforderlich): Öffentliche UUID des IMAP/POP Monitors. Request Body status (optional) - Erlaubt: active, maintenance, disabled, paused, inactive - Hinweis: paused / inactive werden zu disabled normalisiert. name, hostname, port, checkInterval, timeoutSeconds (optional) allowedCheckCountryCodes (optional) - Wird zu Uppercase normalisiert und dedupliziert. imapPopConfig (optional) - Alias für das gespeicherte config JSON. config (optional) - Alternative, um dasselbe gespeicherte config JSON zu aktualisieren. Hinweis: Read-only Nutzer dürfen nur status ändern (bei anderen Feldern kommt 403). { "status": "active" }...

#### IMAP/POP Monitor Check Historie abrufen
URL: https://uptimeify.io/docs/api/monitore/imap-pop-monitore/imap-pop-monitor-check-historie-abrufen
Beschreibung: GET /api/imap-pop-monitors/:imapPopMonitorPublicId/check-history
Endpunkte: GET /api/imap-pop-monitors/:imapPopMonitorPublicId/check-history
Wichtige Abschnitte: Authentifizierung | Parameter | cURL | Response | Errors
Zusammenfassung: IMAP/POP Monitor Check Historie abrufen GET /api/imap-pop-monitors/:imapPopMonitorPublicId/check-history Gibt die letzten Check-Ergebnisse für den IMAP/POP Monitor zurück. Authentifizierung Erfordert eine gültige Session. Header: Authorization: Bearer <token Parameter imapPopMonitorPublicId (Pfad, erforderlich): Öffentliche UUID des IMAP/POP Monitors. limit (Query, optional): Maximale Anzahl Ergebnisse (Default: 50, Max: 200). cURL curl -X GET "https://YOUR DOMAIN/api/imap-pop-monitors/66666666-6666-4666-8666-666666666666/check-history?limit=50" \ -H "Authorization: Bearer $TOKEN" Response { "data": [ { "id": 123, "status": "success", "errorMessage": null, "warningMessage": null, "timingImapPop": 142, "diagnostics": { "message": "IMAP connection successful" }, "checkedAt": "2026-02-26T12:00:00.000Z", "locationId": 1, "locationName": "Frankfurt", "locationCode": "fra" } ] } Errors 400...

#### IMAP/POP Check triggern
URL: https://uptimeify.io/docs/api/monitore/imap-pop-monitore/imap-pop-monitor-check-triggern
Beschreibung: POST /api/imap-pop-monitors/:imapPopMonitorPublicId/trigger-check
Endpunkte: POST /api/imap-pop-monitors/:imapPopMonitorPublicId/trigger-check
Wichtige Abschnitte: Authentifizierung | Parameter | Response | Errors
Zusammenfassung: IMAP/POP Check triggern POST /api/imap-pop-monitors/:imapPopMonitorPublicId/trigger-check Startet einen sofortigen Check von allen zulässigen Monitoring-Standorten. Authentifizierung Erfordert eine gültige Session. Header: Authorization: Bearer <token Parameter imapPopMonitorPublicId (Pfad, erforderlich): Öffentliche UUID des IMAP/POP Monitors. Response { "success": true, "message": "Checks triggered successfully", "imapPopMonitorId": 500, "locationCodes": ["fra", "nyc"], "queueNames": ["imap-pop-monitor-checks-fra", "imap-pop-monitor-checks-nyc"] } Errors 400 Ungültige IMAP/POP Monitor Public ID (UUID) oder keine zulässigen Locations 401 Unauthorized 403 Forbidden 404 IMAP/POP monitor not found 503 No active monitoring locations available 500 Failed to trigger check

#### IMAP/POP Monitor Details abrufen
URL: https://uptimeify.io/docs/api/monitore/imap-pop-monitore/imap-pop-monitor-details-abrufen
Beschreibung: GET /api/imap-pop-monitors/:imapPopMonitorPublicId/details
Endpunkte: GET /api/imap-pop-monitors/:imapPopMonitorPublicId/details
Wichtige Abschnitte: Authentifizierung | Parameter | cURL | Response | Errors
Zusammenfassung: IMAP/POP Monitor Details abrufen GET /api/imap-pop-monitors/:imapPopMonitorPublicId/details Konsolidierter Endpunkt, der das IMAP/POP Monitor Detailseiten-Payload in einem Call zurückgibt (latest check, uptime stats, incidents, alert history, maintenance windows, chart data, etc.). Authentifizierung Erfordert eine gültige Session. Header: Authorization: Bearer <token Parameter imapPopMonitorPublicId (Pfad, erforderlich): Öffentliche UUID des IMAP/POP Monitors. range (Query, optional): day week month year (Default: day). date (Query, optional): Referenzdatum als ISO String. startDate (Query, optional): Override Startdatum als ISO String. endDate (Query, optional): Override Enddatum als ISO String. granularity (Query, optional): Wenn gesetzt und nicht raw, kann das Backend Chart-Daten aggregieren. cURL curl -X GET "https://YOUR...

#### IMAP/POP Monitor erstellen
URL: https://uptimeify.io/docs/api/monitore/imap-pop-monitore/imap-pop-monitor-erstellen
Beschreibung: POST /api/imap-pop-monitors
Endpunkte: POST /api/imap-pop-monitors
Wichtige Abschnitte: Authentifizierung | Request Body | Felder | imapPopConfig (vom Worker unterstützte Keys) | Default-Ports (Worker-Verhalten) | cURL
Zusammenfassung: IMAP/POP Monitor erstellen POST /api/imap-pop-monitors Erstellt einen neuen IMAP/POP Monitor. Authentifizierung Erfordert eine gültige Session. Header: Authorization: Bearer <token Request Body { "customerId": "11111111-1111-4111-8111-111111111111", "name": "Mailbox Access", "hostname": "mail.example.com", "port": 993, "status": "active", "checkInterval": 30, "timeoutSeconds": 30, "imapPopConfig": { "protocol": "imap", "user": "monitor@example.com", "password": "password", "tls": true, "tlsOptions": { "rejectUnauthorized": true } } } Felder customerId (number string, required) - Akzeptiert entweder die interne numerische Kunden-ID oder die öffentliche Kunden-UUID. name (string, required) hostname (string, required) - Muss ein Hostname sein (kein Protokoll wie https://, kein Pfad wie /imap). port (number null, optional) - Wenn weggelassen oder null, wählt der Worker einen Default-Port...

#### IMAP/POP Monitor löschen
URL: https://uptimeify.io/docs/api/monitore/imap-pop-monitore/imap-pop-monitor-loeschen
Beschreibung: DELETE /api/imap-pop-monitors/:imapPopMonitorPublicId
Endpunkte: DELETE /api/imap-pop-monitors/:imapPopMonitorPublicId
Wichtige Abschnitte: Authentifizierung | Parameter | Response | Errors
Zusammenfassung: IMAP/POP Monitor löschen DELETE /api/imap-pop-monitors/:imapPopMonitorPublicId Löscht einen IMAP/POP Monitor. Authentifizierung Erfordert eine gültige Session. Header: Authorization: Bearer <token Parameter imapPopMonitorPublicId (Pfad, erforderlich): Öffentliche UUID des IMAP/POP Monitors. Response { "success": true } Errors 400 IMAP/POP Monitor Public ID (UUID) erforderlich 401 Unauthorized 403 Forbidden (z.B. readonly oder global supporter) 404 IMAP/POP monitor not found

#### IMAP/POP Monitore auflisten
URL: https://uptimeify.io/docs/api/monitore/imap-pop-monitore/imap-pop-monitore-auflisten
Beschreibung: GET /api/imap-pop-monitors
Endpunkte: GET /api/imap-pop-monitors
Wichtige Abschnitte: Authentifizierung | Parameter | cURL | Response | Errors
Zusammenfassung: IMAP/POP Monitore auflisten GET /api/imap-pop-monitors Listet IMAP/POP Monitore einer Organisation auf. Authentifizierung Erfordert eine gültige Session. Header: Authorization: Bearer <token Parameter organizationId (Query, optional): Organisations-ID. Default ist die Organisation des aktuellen Nutzers. customerId (Query, optional): Nach Kunden-ID filtern. search (Query, optional): Suche nach Name, Hostname oder Kunde. page (Query, optional): Seite (Default: 1). perPage (Query, optional): Einträge pro Seite (Default: 50, Max: 200). cURL curl "https://YOUR DOMAIN/api/imap-pop-monitors?page=1&perPage=50" \ -H "Authorization: Bearer $TOKEN" Response { "items": [ { "id": 500, "organizationId": 1, "customerId": 10, "name": "Mailbox Access", "hostname": "mail.example.com", "port": 993, "checkInterval": 30, "timeoutSeconds": 30, "customerName": "Example Customer", "config": { "protocol":...

#### SMTP Monitore
URL: https://uptimeify.io/docs/api/monitore/smtp-monitore
Beschreibung: Verwalte SMTP Monitore über die API.
Wichtige Abschnitte: Endpunkte
Zusammenfassung: Verwalte SMTP Monitore. Pfadbasierte SMTP-Monitor-Endpunkte verwenden smtpMonitorPublicId-UUIDs. Endpunkte SMTP Monitore auflisten SMTP Monitor erstellen SMTP Monitor abrufen SMTP Monitor Details abrufen SMTP Monitor Check-Historie abrufen SMTP Monitor aktualisieren SMTP Monitor löschen Check für SMTP Monitor triggern

#### SMTP Monitor abrufen
URL: https://uptimeify.io/docs/api/monitore/smtp-monitore/smtp-monitor-abrufen
Beschreibung: GET /api/smtp-monitors/:smtpMonitorPublicId
Endpunkte: GET /api/smtp-monitors/:smtpMonitorPublicId
Wichtige Abschnitte: Authentifizierung | Parameter | cURL | Response | Errors
Zusammenfassung: SMTP Monitor abrufen GET /api/smtp-monitors/:smtpMonitorPublicId Gibt Details zu einem SMTP Monitor zurück. Authentifizierung Erfordert eine gültige Session. Header: Authorization: Bearer <token Parameter smtpMonitorPublicId (Pfad, erforderlich): Öffentliche UUID des SMTP Monitors. cURL curl "https://YOUR DOMAIN/api/smtp-monitors/33333333-3333-4333-8333-333333333333" \ -H "Authorization: Bearer $TOKEN" Response { "id": 200, "organizationId": 1, "customerId": 10, "name": "Outbound SMTP", "hostname": "smtp.example.com", "port": 587, "status": "active", "checkInterval": 60, "timeoutSeconds": 30, "customerName": "Example Customer", "notificationEmail": null, "notificationPhoneNumber": null, "lastCheckedAt": "2026-01-01T12:00:00.000Z", "createdAt": "2026-01-01T12:00:00.000Z", "updatedAt": "2026-01-01T12:00:00.000Z", "config": { "secure": false, "ignoreTls": false, "requireTls": false },...

#### SMTP Monitor aktualisieren
URL: https://uptimeify.io/docs/api/monitore/smtp-monitore/smtp-monitor-aktualisieren-status
Beschreibung: PATCH /api/smtp-monitors/:smtpMonitorPublicId
Endpunkte: PATCH /api/smtp-monitors/:smtpMonitorPublicId
Wichtige Abschnitte: Authentifizierung | Parameter | Request Body | Hinweise | cURL | Response
Zusammenfassung: SMTP Monitor aktualisieren PATCH /api/smtp-monitors/:smtpMonitorPublicId Aktualisiert einen SMTP Monitor. Authentifizierung Erfordert eine gültige Session. Header: Authorization: Bearer <token Parameter smtpMonitorPublicId (Pfad, erforderlich): Öffentliche UUID des SMTP Monitors. Request Body Alle Felder sind optional. { "name": "Outbound SMTP (Primary)", "hostname": "smtp.example.com", "port": 587, "status": "paused", "checkInterval": 60, "timeoutSeconds": 30, "allowedCheckCountryCodes": ["de", "us"], "smtpConfig": { "secure": false, "requireTls": true, "auth": { "user": "username", "pass": "password" } } } Hinweise status akzeptiert active, maintenance, disabled, paused, inactive. - paused und inactive werden zu disabled normalisiert. allowedCheckCountryCodes wird zu Uppercase ISO Codes normalisiert (z. B. DE, US). Leere Listen werden null. SMTP Config kann als smtpConfig oder als...

#### SMTP Monitor Check-Historie abrufen
URL: https://uptimeify.io/docs/api/monitore/smtp-monitore/smtp-monitor-check-historie-abrufen
Beschreibung: GET /api/smtp-monitors/:smtpMonitorPublicId/check-history
Endpunkte: GET /api/smtp-monitors/:smtpMonitorPublicId/check-history
Wichtige Abschnitte: Authentifizierung | Parameter | Query Parameter | cURL | Response | Errors
Zusammenfassung: SMTP Monitor Check-Historie abrufen GET /api/smtp-monitors/:smtpMonitorPublicId/check-history Gibt die letzten Check-Ergebnisse für einen SMTP Monitor zurück. Authentifizierung Erfordert eine gültige Session. Header: Authorization: Bearer <token Parameter smtpMonitorPublicId (Pfad, erforderlich): Öffentliche UUID des SMTP Monitors. Query Parameter limit (number, optional) - Default: 50 - Max: 200 cURL curl "https://YOUR DOMAIN/api/smtp-monitors/33333333-3333-4333-8333-333333333333/check-history?limit=50" \ -H "Authorization: Bearer $TOKEN" Response { "data": [ { "id": 12345, "status": "success", "errorMessage": null, "warningMessage": null, "timingSmtp": 123, "diagnostics": { "raw": "optional diagnostic payload" }, "checkedAt": "2026-01-01T12:00:00.000Z", "locationId": 1, "locationName": "Nuremberg (DE)", "locationCode": "de-nbg" } ] } Errors 400 SMTP Monitor Public ID (UUID)...

#### Check für SMTP Monitor triggern
URL: https://uptimeify.io/docs/api/monitore/smtp-monitore/smtp-monitor-check-triggern
Beschreibung: POST /api/smtp-monitors/:smtpMonitorPublicId/trigger-check
Endpunkte: POST /api/smtp-monitors/:smtpMonitorPublicId/trigger-check
Wichtige Abschnitte: Authentifizierung | Parameter | cURL | Response | Errors
Zusammenfassung: Check für SMTP Monitor triggern POST /api/smtp-monitors/:smtpMonitorPublicId/trigger-check Startet einen sofortigen Check von allen zulässigen Monitoring-Standorten. Authentifizierung Erfordert eine gültige Session und Schreibrechte. Header: Authorization: Bearer <token Parameter smtpMonitorPublicId (Pfad, erforderlich): Öffentliche UUID des SMTP Monitors. cURL curl -X POST "https://YOUR DOMAIN/api/smtp-monitors/33333333-3333-4333-8333-333333333333/trigger-check" \ -H "Authorization: Bearer $TOKEN" Response { "success": true, "message": "Checks triggered successfully", "smtpMonitorId": 200, "locationCodes": ["de-nbg", "fi-hel"], "queueNames": ["smtp-monitor-checks-de-nbg", "smtp-monitor-checks-fi-hel"] } Errors 400 SMTP Monitor Public ID (UUID) erforderlich 401 Unauthorized 403 Forbidden 404 Not found 500 Failed to trigger check (die Status-Message kann z. B. "No active monitoring...

#### SMTP Monitor Details abrufen
URL: https://uptimeify.io/docs/api/monitore/smtp-monitore/smtp-monitor-details-abrufen
Beschreibung: GET /api/smtp-monitors/:smtpMonitorPublicId/details
Endpunkte: GET /api/smtp-monitors/:smtpMonitorPublicId/details
Wichtige Abschnitte: Authentifizierung | Parameter | Query Parameter | cURL | Response | Errors
Zusammenfassung: SMTP Monitor Details abrufen GET /api/smtp-monitors/:smtpMonitorPublicId/details Konsolidierter Endpunkt, der die Daten für die SMTP Monitor Detailseite in einem Call zurückgibt. Authentifizierung Erfordert eine gültige Session. Header: Authorization: Bearer <token Parameter smtpMonitorPublicId (Pfad, erforderlich): Öffentliche UUID des SMTP Monitors. Query Parameter range (string, optional): day, week, month, year (Default: day) date (string, optional): Referenzdatum (wird via new Date(date) geparst) startDate (string, optional) endDate (string, optional) granularity (string, optional) - Wenn raw, wird Aggregation deaktiviert. cURL curl "https://YOUR DOMAIN/api/smtp-monitors/33333333-3333-4333-8333-333333333333/details?range=day" \ -H "Authorization: Bearer $TOKEN" Response Die Response ist ein einzelnes Objekt mit diesen Top-Level Keys: smtpMonitorId monitor latestCheck uptimeStats...

#### SMTP Monitor erstellen
URL: https://uptimeify.io/docs/api/monitore/smtp-monitore/smtp-monitor-erstellen
Beschreibung: POST /api/smtp-monitors
Endpunkte: POST /api/smtp-monitors
Wichtige Abschnitte: Authentifizierung | Request Body | Felder | smtpConfig (vom Worker unterstützte Keys) | cURL | Response
Zusammenfassung: SMTP Monitor erstellen POST /api/smtp-monitors Erstellt einen neuen SMTP Monitor. Authentifizierung Erfordert eine gültige Session. Header: Authorization: Bearer <token Request Body { "customerId": "11111111-1111-4111-8111-111111111111", "name": "Outbound SMTP", "hostname": "smtp.example.com", "port": 587, "status": "active", "checkInterval": 60, "timeoutSeconds": 30, "smtpConfig": { "secure": false, "ignoreTls": false, "requireTls": false, "auth": { "user": "username", "pass": "password" } } } Felder customerId (number string, erforderlich) - Akzeptiert entweder die interne numerische Kunden-ID oder die öffentliche Kunden-UUID. name (string, erforderlich) hostname (string, erforderlich) - Muss nur ein Hostname sein (kein Protokoll wie https://, kein Pfad wie /smtp). port (number null, optional) - Wenn weggelassen oder null, nutzt der Worker standardmäßig 465, wenn...

#### SMTP Monitor löschen
URL: https://uptimeify.io/docs/api/monitore/smtp-monitore/smtp-monitor-loeschen
Beschreibung: DELETE /api/smtp-monitors/:smtpMonitorPublicId
Endpunkte: DELETE /api/smtp-monitors/:smtpMonitorPublicId
Wichtige Abschnitte: Authentifizierung | Parameter | cURL | Response | Errors
Zusammenfassung: SMTP Monitor löschen DELETE /api/smtp-monitors/:smtpMonitorPublicId Löscht einen SMTP Monitor. Authentifizierung Erfordert eine gültige Session und Schreibrechte. Header: Authorization: Bearer <token Parameter smtpMonitorPublicId (Pfad, erforderlich): Öffentliche UUID des SMTP Monitors. cURL curl -X DELETE "https://YOUR DOMAIN/api/smtp-monitors/33333333-3333-4333-8333-333333333333" \ -H "Authorization: Bearer $TOKEN" Response { "success": true } Errors 400 SMTP Monitor Public ID (UUID) erforderlich 401 Unauthorized 403 Forbidden 404 Not found

#### SMTP Monitore auflisten
URL: https://uptimeify.io/docs/api/monitore/smtp-monitore/smtp-monitore-auflisten
Beschreibung: GET /api/smtp-monitors
Endpunkte: GET /api/smtp-monitors
Wichtige Abschnitte: Authentifizierung | Parameter | cURL | Response | Errors
Zusammenfassung: SMTP Monitore auflisten GET /api/smtp-monitors Listet SMTP Monitore einer Organisation auf. Authentifizierung Erfordert eine gültige Session. Header: Authorization: Bearer <token Parameter organizationId (Query, optional): Organisations-ID. Default ist die Organisation des aktuellen Nutzers. customerId (Query, optional): Nach Kunden-ID filtern. search (Query, optional): Suche nach Name, Hostname oder Kunde. page (Query, optional): Seite (Default: 1). perPage (Query, optional): Einträge pro Seite (Default: 50, Max: 200). cURL curl "https://YOUR DOMAIN/api/smtp-monitors?page=1&perPage=50" \ -H "Authorization: Bearer $TOKEN" Response { "items": [ { "id": 200, "organizationId": 1, "customerId": 10, "name": "Outbound SMTP", "hostname": "smtp.example.com", "port": 587, "status": "active", "checkInterval": 60, "timeoutSeconds": 30, "customerName": "Example Customer", "notificationEmail": null,...

#### SSH Monitore
URL: https://uptimeify.io/docs/api/monitore/ssh-monitore
Beschreibung: Verwalte SSH Monitore.
Wichtige Abschnitte: Endpunkte
Zusammenfassung: Verwalte SSH Monitore. Pfadbasierte SSH-Monitor-Endpunkte verwenden sshMonitorPublicId-UUIDs. Endpunkte SSH Monitore auflisten SSH Monitor erstellen SSH Monitor abrufen SSH Monitor Details abrufen SSH Monitor Check Historie abrufen SSH Monitor aktualisieren SSH Monitor löschen SSH Check triggern

#### SSH Monitor abrufen
URL: https://uptimeify.io/docs/api/monitore/ssh-monitore/ssh-monitor-abrufen
Beschreibung: GET /api/ssh-monitors/:sshMonitorPublicId
Endpunkte: GET /api/ssh-monitors/:sshMonitorPublicId
Wichtige Abschnitte: Authentifizierung | Parameter | cURL | Response | Errors
Zusammenfassung: SSH Monitor abrufen GET /api/ssh-monitors/:sshMonitorPublicId Gibt Details zu einem SSH Monitor zurück. Authentifizierung Erfordert eine gültige Session. Header: Authorization: Bearer <token Parameter sshMonitorPublicId (Pfad, erforderlich): Öffentliche UUID des SSH Monitors. cURL curl "https://YOUR DOMAIN/api/ssh-monitors/44444444-4444-4444-8444-444444444444" \ -H "Authorization: Bearer $TOKEN" Response { "id": 300, "organizationId": 1, "customerId": 10, "name": "Bastion Host", "hostname": "ssh.example.com", "port": 22, "status": "active", "checkInterval": 60, "timeoutSeconds": 30, "customerName": "Example Customer", "notificationEmail": null, "notificationPhoneNumber": null, "lastCheckedAt": "2026-02-26T12:00:00.000Z", "createdAt": "2026-02-26T12:00:00.000Z", "updatedAt": "2026-02-26T12:00:00.000Z", "config": { "username": "root" }, "sshConfig": { "username": "root" } } Errors 400 SSH...

#### SSH Monitor aktualisieren
URL: https://uptimeify.io/docs/api/monitore/ssh-monitore/ssh-monitor-aktualisieren-status
Beschreibung: PATCH /api/ssh-monitors/:sshMonitorPublicId
Endpunkte: PATCH /api/ssh-monitors/:sshMonitorPublicId
Wichtige Abschnitte: Authentifizierung | Parameter | Request Body | Hinweise | cURL | Response
Zusammenfassung: SSH Monitor aktualisieren PATCH /api/ssh-monitors/:sshMonitorPublicId Aktualisiert einen SSH Monitor und/oder ändert den Status. Authentifizierung Erfordert eine gültige Session. Header: Authorization: Bearer <token Parameter sshMonitorPublicId (Pfad, erforderlich): Öffentliche UUID des SSH Monitors. Request Body Alle Felder sind optional. { "name": "Bastion Host (Primary)", "hostname": "ssh.example.com", "port": 22, "status": "paused", "checkInterval": 60, "timeoutSeconds": 30, "allowedCheckCountryCodes": ["de", "us"], "sshConfig": { "username": "root", "privateKey": "-----BEGIN OPENSSH PRIVATE KEY-----..." } } Hinweise status akzeptiert active, maintenance, disabled, paused, inactive. - paused und inactive werden zu disabled normalisiert. allowedCheckCountryCodes wird zu Uppercase ISO Codes normalisiert (z.B. DE, US). Leere Listen werden zu null. SSH Config kann als sshConfig oder als...

#### SSH Monitor Check Historie abrufen
URL: https://uptimeify.io/docs/api/monitore/ssh-monitore/ssh-monitor-check-historie-abrufen
Beschreibung: GET /api/ssh-monitors/:sshMonitorPublicId/check-history
Endpunkte: GET /api/ssh-monitors/:sshMonitorPublicId/check-history
Wichtige Abschnitte: Authentifizierung | Parameter | Query Parameter | cURL | Response | Errors
Zusammenfassung: SSH Monitor Check Historie abrufen GET /api/ssh-monitors/:sshMonitorPublicId/check-history Gibt die letzten Check-Ergebnisse für einen SSH Monitor zurück. Authentifizierung Erfordert eine gültige Session. Header: Authorization: Bearer <token Parameter sshMonitorPublicId (Pfad, erforderlich): Öffentliche UUID des SSH Monitors. Query Parameter limit (number, optional) - Default: 50 - Max: 200 cURL curl "https://YOUR DOMAIN/api/ssh-monitors/44444444-4444-4444-8444-444444444444/check-history?limit=50" \ -H "Authorization: Bearer $TOKEN" Response { "data": [ { "id": 12345, "status": "success", "errorMessage": null, "warningMessage": null, "timingSsh": 123, "diagnostics": { "message": "SSH connection successful" }, "checkedAt": "2026-02-26T12:00:00.000Z", "locationId": 1, "locationName": "Nuremberg (DE)", "locationCode": "de-nbg" } ] } Errors 400 SSH Monitor Public ID (UUID) erforderlich 401...

#### SSH Check triggern
URL: https://uptimeify.io/docs/api/monitore/ssh-monitore/ssh-monitor-check-triggern
Beschreibung: POST /api/ssh-monitors/:sshMonitorPublicId/trigger-check
Endpunkte: POST /api/ssh-monitors/:sshMonitorPublicId/trigger-check
Wichtige Abschnitte: Authentifizierung | Parameter | cURL | Response | Errors
Zusammenfassung: SSH Check triggern POST /api/ssh-monitors/:sshMonitorPublicId/trigger-check Startet einen sofortigen Check von allen zulässigen Monitoring-Standorten. Authentifizierung Erfordert eine gültige Session und Schreibrechte. Header: Authorization: Bearer <token Parameter sshMonitorPublicId (Pfad, erforderlich): Öffentliche UUID des SSH Monitors. cURL curl -X POST "https://YOUR DOMAIN/api/ssh-monitors/44444444-4444-4444-8444-444444444444/trigger-check" \ -H "Authorization: Bearer $TOKEN" Response { "success": true, "message": "Checks triggered successfully", "sshMonitorId": 300, "locationCodes": ["de-nbg", "fi-hel"], "queueNames": ["ssh-monitor-checks-de-nbg", "ssh-monitor-checks-fi-hel"] } Errors 400 SSH Monitor Public ID (UUID) erforderlich 401 Unauthorized 403 Forbidden 404 Not found 500 Failed to trigger check (die StatusMessage kann z.B. "No active monitoring locations available"...

#### SSH Monitor Details abrufen
URL: https://uptimeify.io/docs/api/monitore/ssh-monitore/ssh-monitor-details-abrufen
Beschreibung: GET /api/ssh-monitors/:sshMonitorPublicId/details
Endpunkte: GET /api/ssh-monitors/:sshMonitorPublicId/details
Wichtige Abschnitte: Authentifizierung | Parameter | Query Parameter | cURL | Response | Errors
Zusammenfassung: SSH Monitor Details abrufen GET /api/ssh-monitors/:sshMonitorPublicId/details Konsolidierter Endpunkt, der die Daten für die SSH Monitor Detailseite in einem Call zurückgibt. Authentifizierung Erfordert eine gültige Session. Header: Authorization: Bearer <token Parameter sshMonitorPublicId (Pfad, erforderlich): Öffentliche UUID des SSH Monitors. Query Parameter range (string, optional): day, week, month, year (Default: day) date (string, optional): Referenzdatum (wird via new Date(date) geparst) startDate (string, optional) endDate (string, optional) granularity (string, optional) - Wenn raw, wird Aggregation deaktiviert. cURL curl "https://YOUR DOMAIN/api/ssh-monitors/44444444-4444-4444-8444-444444444444/details?range=day" \ -H "Authorization: Bearer $TOKEN" Response Die Response ist ein einzelnes Objekt mit diesen Top-Level Keys: sshMonitorId monitor latestCheck uptimeStats...

#### SSH Monitor erstellen
URL: https://uptimeify.io/docs/api/monitore/ssh-monitore/ssh-monitor-erstellen
Beschreibung: POST /api/ssh-monitors
Endpunkte: POST /api/ssh-monitors
Wichtige Abschnitte: Authentifizierung | Request Body | Felder | sshConfig (vom Worker unterstützte Keys) | cURL | Response
Zusammenfassung: SSH Monitor erstellen POST /api/ssh-monitors Erstellt einen neuen SSH Monitor. Authentifizierung Erfordert eine gültige Session. Header: Authorization: Bearer <token Request Body { "customerId": "11111111-1111-4111-8111-111111111111", "name": "Bastion Host", "hostname": "ssh.example.com", "port": 22, "status": "active", "checkInterval": 60, "timeoutSeconds": 30, "sshConfig": { "username": "root", "password": "password", "privateKey": "-----BEGIN OPENSSH PRIVATE KEY-----..." } } Felder customerId (number string, required) - Akzeptiert entweder die interne numerische Kunden-ID oder die öffentliche Kunden-UUID. name (string, required) hostname (string, required) - Muss ein Hostname sein (kein Protokoll wie https://, kein Pfad wie /ssh). port (number null, optional) - Wenn weggelassen oder null, nutzt der Worker standardmäßig Port 22. status (string, optional) - Erlaubt: active,...

#### SSH Monitor löschen
URL: https://uptimeify.io/docs/api/monitore/ssh-monitore/ssh-monitor-loeschen
Beschreibung: DELETE /api/ssh-monitors/:sshMonitorPublicId
Endpunkte: DELETE /api/ssh-monitors/:sshMonitorPublicId
Wichtige Abschnitte: Authentifizierung | Parameter | cURL | Response | Errors
Zusammenfassung: SSH Monitor löschen DELETE /api/ssh-monitors/:sshMonitorPublicId Löscht einen SSH Monitor. Authentifizierung Erfordert eine gültige Session und Schreibrechte. Header: Authorization: Bearer <token Parameter sshMonitorPublicId (Pfad, erforderlich): Öffentliche UUID des SSH Monitors. cURL curl -X DELETE "https://YOUR DOMAIN/api/ssh-monitors/44444444-4444-4444-8444-444444444444" \ -H "Authorization: Bearer $TOKEN" Response { "success": true } Errors 400 SSH Monitor Public ID (UUID) erforderlich 401 Unauthorized 403 Forbidden 404 Not found

#### SSH Monitore auflisten
URL: https://uptimeify.io/docs/api/monitore/ssh-monitore/ssh-monitore-auflisten
Beschreibung: GET /api/ssh-monitors
Endpunkte: GET /api/ssh-monitors
Wichtige Abschnitte: Authentifizierung | Parameter | cURL | Response | Errors
Zusammenfassung: SSH Monitore auflisten GET /api/ssh-monitors Listet SSH Monitore einer Organisation auf. Authentifizierung Erfordert eine gültige Session. Header: Authorization: Bearer <token Parameter organizationId (Query, optional): Organisations-ID. Default ist die Organisation des aktuellen Nutzers. customerId (Query, optional): Nach Kunden-ID filtern. search (Query, optional): Suche nach Name, Hostname oder Kunde. page (Query, optional): Seite (Default: 1). perPage (Query, optional): Einträge pro Seite (Default: 50, Max: 200). cURL curl "https://YOUR DOMAIN/api/ssh-monitors?page=1&perPage=50" \ -H "Authorization: Bearer $TOKEN" Response { "items": [ { "id": 300, "organizationId": 1, "customerId": 10, "name": "Bastion Host", "hostname": "ssh.example.com", "port": 22, "status": "active", "checkInterval": 60, "timeoutSeconds": 30, "customerName": "Example Customer", "notificationEmail": null,...

### Konfiguration
URL: https://uptimeify.io/docs/api/website-konfiguration
Beschreibung: Verwalte Check-Konfiguration, Benachrichtigungskanäle und Wartungsfenster.
Endpunkte: PATCH /api/websites/:websiteId/check-config | GET /api/maintenance-windows?websiteId=:websiteId | GET /api/maintenance-windows/:id | POST /api/maintenance-windows | PATCH /api/maintenance-windows/:id | DELETE /api/maintenance-windows/:id | GET /api/maintenance-windows/check/:websiteId | POST /api/maintenance-windows/check/batch
Wichtige Abschnitte: Authentifizierung | Check-Konfiguration | Check-Einstellungen aktualisieren | Anfrage (Request Body) | Alarm-Konfigurationen | Benachrichtigungskanäle
Zusammenfassung: Verwalte erweiterte Monitoring-Einstellungen für deine Websites. Authentifizierung Alle Beispiele gehen von einem Bearer-Token aus: BASE URL="https://uptimeify.io" TOKEN="<dein-api-token " Check-Konfiguration Check-Einstellungen aktualisieren PATCH /api/websites/:websiteId/check-config Konfiguriere, welche Aspekte der Website überwacht werden sollen. Anfrage (Request Body) { "checkSslEnabled": true, "checkHttpsRedirectEnabled": true, "checkStatusEnabled": true, "checkSizeEnabled": true, "checkResponseTimeEnabled": true, "checkKeywordEnabled": false, "checkDomainExpiryEnabled": true, "minPageSize": 1024, // in Bytes (optional) "maxPageSize": 5242880 // in Bytes (optional) } Beispiel (cURL): curl -X PATCH \ "$BASE URL/api/websites/101/check-config" \ -H "Authorization: Bearer $TOKEN" \ -H "Content-Type: application/json" \ -d...

#### Check-Einstellungen aktualisieren
URL: https://uptimeify.io/docs/api/website-konfiguration/check-konfiguration-aktualisieren
Beschreibung: PATCH /api/websites/:websiteId/check-config
Endpunkte: PATCH /api/websites/:websiteId/check-config
Wichtige Abschnitte: Anfrage (Request Body) | Beispiel (cURL) | Beispiel-Antwort | Häufige Fehler
Zusammenfassung: Check-Einstellungen aktualisieren PATCH /api/websites/:websiteId/check-config Konfiguriere, welche Aspekte der Website überwacht werden sollen. Anfrage (Request Body) { "checkSslEnabled": true, "checkHttpsRedirectEnabled": true, "checkStatusEnabled": true, "checkSizeEnabled": true, "checkResponseTimeEnabled": true, "checkKeywordEnabled": false, "checkDomainExpiryEnabled": true, "minPageSize": 1024, // in Bytes (optional) "maxPageSize": 5242880 // in Bytes (optional) } Beispiel (cURL) BASE URL="https://uptimeify.io" TOKEN="<dein-api-token " curl -X PATCH \ "$BASE URL/api/websites/101/check-config" \ -H "Authorization: Bearer $TOKEN" \ -H "Content-Type: application/json" \ -d '{"checkSslEnabled":true,"checkHttpsRedirectEnabled":true,"checkStatusEnabled":true,"checkSizeEnabled":true,"checkResponseTimeEnabled":true,"checkKeywordEnabled":false,"minPageSize":1024,"maxPageSize":5242880}'...

#### Wartungsfenster abrufen
URL: https://uptimeify.io/docs/api/website-konfiguration/wartungsfenster-abfragen
Beschreibung: GET /api/maintenance-windows/:id
Endpunkte: GET /api/maintenance-windows/:id
Wichtige Abschnitte: Authentifizierung | Parameter | Beispiel (cURL) | Antwort (Response) | Häufige Fehler
Zusammenfassung: Wartungsfenster abrufen GET /api/maintenance-windows/:id Gibt ein einzelnes Wartungsfenster anhand der ID zurück (inkl. Target-Relation). Authentifizierung Erfordert eine gültige Session. Header: Authorization: Bearer <token Hinweis (API-Token Scope): Wenn du ein Customer-scoped API-Token nutzt, muss das Wartungsfenster zu diesem Kunden gehören. Parameter id (Path, required): Wartungsfenster-ID. Beispiel (cURL) BASE URL="https://uptimeify.io" TOKEN="<dein-api-token " curl -X GET "$BASE URL/api/maintenance-windows/5" \ -H "Authorization: Bearer $TOKEN" \ -H "Accept: application/json" Antwort (Response) { "id": 5, "websiteId": 101, "icmpMonitorId": null, "smtpMonitorId": null, "sshMonitorId": null, "ftpMonitorId": null, "imapPopMonitorId": null, "customerId": 12, "name": "Wöchentliche Wartung", "description": "Geplante Downtime", "startTime": "2026-02-25T02:00:00.000Z", "endTime":...

#### Wartungsfenster aktualisieren
URL: https://uptimeify.io/docs/api/website-konfiguration/wartungsfenster-aktualisieren
Beschreibung: PATCH /api/maintenance-windows/:id
Endpunkte: PATCH /api/maintenance-windows/:id
Wichtige Abschnitte: Authentifizierung | Parameter | Anfrage (Request Body) | Beispiel (cURL) | Antwort (Response) | Häufige Fehler
Zusammenfassung: Wartungsfenster aktualisieren PATCH /api/maintenance-windows/:id Aktualisiert ein bestehendes Wartungsfenster. Alle Felder sind optional (Partial Update). Authentifizierung Erfordert eine gültige Session. Header: Authorization: Bearer <token Hinweis: Global-Supporter dürfen keine Wartungsfenster aktualisieren (403). Read-only Nutzer dürfen es. Parameter id (Path, required): Wartungsfenster-ID. Anfrage (Request Body) { "name": "Server-Upgrade (updated)", "description": null, "startTime": "2026-02-25T03:00:00.000Z", "endTime": "2026-02-25T05:00:00.000Z", "isRecurring": true, "recurrencePattern": { "frequency": "weekly", "interval": 1, "daysOfWeek": [1] }, "isActive": true } Hinweise: Du kannst die Target-IDs (websiteId, icmpMonitorId, ...) nicht ändern. Es werden nur die Felder des Wartungsfensters aktualisiert. description kann auf null gesetzt werden, um sie zu löschen. Wenn du...

#### Wartungsfenster auflisten
URL: https://uptimeify.io/docs/api/website-konfiguration/wartungsfenster-auflisten
Beschreibung: GET /api/maintenance-windows
Endpunkte: GET /api/maintenance-windows
Wichtige Abschnitte: Authentifizierung | Query Parameter | Beispiel (cURL) | Antwort (Response) | Häufige Fehler
Zusammenfassung: Wartungsfenster auflisten GET /api/maintenance-windows Gibt Wartungsfenster zurück, standardmäßig auf deine Organisation scoped. Du kannst nach einem konkreten Ziel (z. B. websiteId) oder nach customerId/organizationId filtern. Authentifizierung Erfordert eine gültige Session. Header: Authorization: Bearer <token Query Parameter websiteId (optional) customerId (optional) organizationId (optional, Standard: deine Session-Organisation) activeOnly (optional): true liefert nur aktive Fenster Target-Filter (optional): icmpMonitorId, smtpMonitorId, sshMonitorId, ftpMonitorId, imapPopMonitorId Hinweis (API-Token Scope): Wenn du ein Customer-scoped API-Token nutzt, sind Ergebnisse auf diesen Kunden beschränkt. Ein anderer customerId liefert 403. Beispiel (cURL) BASE URL="https://uptimeify.io" TOKEN="<dein-api-token " curl -X GET "$BASE URL/api/maintenance-windows?websiteId=101" \ -H...

#### Wartung prüfen (Website)
URL: https://uptimeify.io/docs/api/website-konfiguration/wartungsfenster-check-website
Beschreibung: GET /api/maintenance-windows/check/:websiteId
Endpunkte: GET /api/maintenance-windows/check/:websiteId
Wichtige Abschnitte: Parameter | Beispiel (cURL) | Antwort (Response) | Häufige Fehler
Zusammenfassung: Wartung prüfen (Website) GET /api/maintenance-windows/check/:websiteId Prüft, ob eine Website aktuell in einem aktiven Wartungsfenster ist. Dieser Endpoint erfordert Authentifizierung per Browser-Session oder API-Token. Parameter websiteId (Path, required): Interne numerische Website-ID oder websitePublicId (UUID). Beispiel (cURL) BASE URL="https://uptimeify.io" API TOKEN="wsm your real api token" curl -X GET "$BASE URL/api/maintenance-windows/check/cd11a84d-96a2-41aa-a957-b1db8ee01b72" \ -H "Authorization: Bearer $API TOKEN" \ -H "Accept: application/json" Antwort (Response) { "inMaintenance": true, "activeWindows": [ { "id": 5, "name": "Wöchentliche Wartung", "startTime": "2026-02-25T02:00:00.000Z", "endTime": "2026-02-25T04:00:00.000Z", "description": "Geplante Downtime" } ] } Häufige Fehler 401 Unauthorized wenn keine gültige Session oder kein gültiger API-Token mitgesendet wird 403...

#### Wartungsfenster erstellen
URL: https://uptimeify.io/docs/api/website-konfiguration/wartungsfenster-erstellen
Beschreibung: POST /api/maintenance-windows
Endpunkte: POST /api/maintenance-windows
Wichtige Abschnitte: Authentifizierung | Anfrage (Request Body) | Felder | Beispiel (cURL) | Antwort (Response) | Häufige Fehler
Zusammenfassung: Wartungsfenster erstellen POST /api/maintenance-windows Erstellt ein neues Wartungsfenster. Wichtig: Du musst genau eine Target-ID angeben (z. B. websiteId oder icmpMonitorId, smtpMonitorId, sshMonitorId, ftpMonitorId, imapPopMonitorId). Alle Target-IDs und customerId akzeptieren entweder die interne numerische ID oder die jeweilige Public ID als UUID. Authentifizierung Erfordert eine gültige Session oder einen gültigen API-Token. Header: Authorization: Bearer <token Hinweis: Global-Supporter dürfen keine Wartungsfenster erstellen (403). Read-only Nutzer dürfen es. Anfrage (Request Body) { "websiteId": "521e3338-4597-4d1d-8eeb-dc56d271e71c", "name": "Server-Upgrade", "description": "Geplante Downtime", "startTime": "2026-02-25T02:00:00.000Z", "endTime": "2026-02-25T04:00:00.000Z", "isRecurring": true, "recurrencePattern": { "frequency": "weekly", "interval": 1, "daysOfWeek": [1] },...

#### Wartungsfenster löschen
URL: https://uptimeify.io/docs/api/website-konfiguration/wartungsfenster-loeschen
Beschreibung: DELETE /api/maintenance-windows/:id
Endpunkte: DELETE /api/maintenance-windows/:id
Wichtige Abschnitte: Authentifizierung | Parameter | Beispiel (cURL) | Antwort (Response) | Häufige Fehler
Zusammenfassung: Wartungsfenster löschen DELETE /api/maintenance-windows/:id Löscht ein Wartungsfenster. Authentifizierung Erfordert eine gültige Session. Header: Authorization: Bearer <token Hinweis: Global-Supporter dürfen keine Wartungsfenster löschen (403). Read-only Nutzer dürfen es. Parameter id (Path, required): Wartungsfenster-ID. Beispiel (cURL) BASE URL="https://uptimeify.io" TOKEN="<dein-api-token " curl -X DELETE "$BASE URL/api/maintenance-windows/5" -H "Authorization: Bearer $TOKEN" Antwort (Response) { "success": true } Häufige Fehler 400 Invalid maintenance window ID wenn :id ungültig ist 401 Unauthorized wenn du nicht angemeldet bist 403 Forbidden wenn du keinen Zugriff auf das Wartungsfenster hast 404 Maintenance window not found wenn das Wartungsfenster nicht existiert

#### Wartung prüfen (Batch)
URL: https://uptimeify.io/docs/api/website-konfiguration/wartungsfenster-pruefen
Beschreibung: POST /api/maintenance-windows/check/batch
Endpunkte: POST /api/maintenance-windows/check/batch
Wichtige Abschnitte: Anfrage (Request Body) | Felder | Beispiel (cURL) | Antwort (Response) | Häufige Fehler
Zusammenfassung: Wartung prüfen (Batch) POST /api/maintenance-windows/check/batch Batch-Check für mehrere Websites (reduziert N+1 Requests). Dieser Endpoint erfordert Authentifizierung per Browser-Session oder API-Token. Anfrage (Request Body) { "websiteIds": [101, "cd11a84d-96a2-41aa-a957-b1db8ee01b72", 103] } Felder websiteIds ((number string)[], required): numerische Website-IDs oder websitePublicId-UUIDs Beispiel (cURL) BASE URL="https://uptimeify.io" API TOKEN="wsm your real api token" curl -X POST "$BASE URL/api/maintenance-windows/check/batch" \ -H "Authorization: Bearer $API TOKEN" \ -H "Content-Type: application/json" \ -H "Accept: application/json" \ -d '{"websiteIds":[101,"cd11a84d-96a2-41aa-a957-b1db8ee01b72",103]}' Antwort (Response) { "results": { "101": { "inMaintenance": true, "activeWindows": [ { "id": 5, "name": "Wöchentliche Wartung", "startTime": "2026-02-25T02:00:00.000Z",...

## Organization API
Organisationsweite Ressourcen fuer Kundenverwaltung, Billing, Benutzer und Eskalationsregeln.

### Kunden-Verwaltung
URL: https://uptimeify.io/docs/api/kunden
Beschreibung: Pfadbasierte Kunden-Endpunkte verwenden customerPublicId-UUIDs.
Wichtige Abschnitte: Endpunkte
Zusammenfassung: Pfadbasierte Kunden-Endpunkte verwenden customerPublicId-UUIDs. Endpunkte Kunden auflisten Kunden erstellen Kunden-Details abrufen Kunden aktualisieren Paket wechseln Kunden kündigen

#### Kunden aktualisieren
URL: https://uptimeify.io/docs/api/kunden/kunden-aktualisieren
Beschreibung: PATCH /api/customers/:customerPublicId
Endpunkte: PATCH /api/customers/:customerPublicId
Wichtige Abschnitte: Authentifizierung | Anfrage (Request Body) | Beispiel-Request | Beispiel-Response | Häufige Fehler
Zusammenfassung: Kunden aktualisieren PATCH /api/customers/:customerPublicId Aktualisiert Kundendetails. Authentifizierung BASE URL="https://uptimeify.io" TOKEN="<your-api-token " Anfrage (Request Body) Alle Felder sind optional. Nicht gesendete Felder behalten ihren aktuellen Wert. { "name": "Neuer Name", "email": "neu@example.com", "status": "active", "packageType": "business", // konfigurierter packageType oder Display-Name der Organisation "notificationEmail": "alerts@customer-a.de", "notificationPhoneNumber": "+491701234567", "monthlyReportsEnabled": true, "customFields": { "internalReference": "KD-999" } } Hinweise: packageType kann den konfigurierten Paket-Key oder den Display-Namen des Pakets enthalten. Bekannte Alias-Schreibweisen wie aquisition test werden automatisch normalisiert. Beispiel-Request curl -X PATCH "$BASE URL/api/customers/6bfec6f6-245a-47ce-843b-157d97d56f88" \ -H...

#### Kunden auflisten
URL: https://uptimeify.io/docs/api/kunden/kunden-auflisten
Beschreibung: GET /api/customers
Endpunkte: GET /api/customers
Wichtige Abschnitte: Query-Parameter | Antwort (Response)
Zusammenfassung: Kunden auflisten GET /api/customers Listet alle Kunden der Organisation auf. Query-Parameter organizationId (erforderlich): Die ID der Organisation. Antwort (Response) [ { "id": 101, "organizationId": 1, "name": "Kunde A GmbH", "email": "kontakt@kunde-a.de", "packageId": 4, "packageDisplayName": "Business", "status": "active", "cancellationDate": null, "notificationEmail": "alerts@kunde-a.de", "createdAt": "2023-05-15T10:00:00Z" }, { "id": 102, "organizationId": 1, "name": "StartUp XY", "email": "info@startup-xy.com", "packageId": 1, "packageDisplayName": "Essential", "status": "marked for cancellation", "cancellationDate": "2024-12-31T23:59:59Z", "createdAt": "2023-06-20T14:30:00Z" } ] Hinweis: Die Listen-Response liefert absichtlich keinen rohen packageType mehr. Verwende packageDisplayName für Anzeigezwecke und packageId für technische Zuordnung. packageDisplayName stammt aus der...

#### Kunden-Details abrufen
URL: https://uptimeify.io/docs/api/kunden/kunden-details-abfragen
Beschreibung: GET /api/customers/:customerPublicId
Endpunkte: GET /api/customers/:customerPublicId
Wichtige Abschnitte: Antwort (Response) | Häufige Fehler
Zusammenfassung: Kunden-Details abrufen GET /api/customers/:customerPublicId Gibt Details eines bestimmten Kunden zurück. packageDisplayName ist das konfigurierte Anzeigename-Label des zugewiesenen Organisations-Pakets. Es ist kein global normalisierter Enum und kann deshalb organisationsspezifische Namen wie aquisition test enthalten. Antwort (Response) { "id": 101, "publicId": "6bfec6f6-245a-47ce-843b-157d97d56f88", "organizationId": 1, "name": "Kunde A GmbH", "email": "kontakt@kunde-a.de", "notificationPhoneNumber": "+491701234567", "notificationEmail": "alerts@kunde-a.de", "packageId": 3, "packageDisplayName": "Growth", "status": "active", "customFields": { "interneReferenz": "KD-999" }, "monthlyReportsEnabled": true, "notificationChannels": null, "notificationTargets": null, "notificationRules": null, "smsUsageCurrentMonth": 0, "updatedAt": "2023-05-15T10:00:00Z", "createdAt":...

#### Kunden erstellen
URL: https://uptimeify.io/docs/api/kunden/kunden-erstellen
Beschreibung: POST /api/customers
Endpunkte: POST /api/customers
Wichtige Abschnitte: Authentifizierung | Anfrage (Request Body) | Response
Zusammenfassung: Kunden erstellen POST /api/customers Erstellt einen neuen Kunden und weist über packageType ein organisationsdefiniertes Paket zu. Authentifizierung Dieser Endpoint erfordert Authentifizierung. BASE URL="https://uptimeify.io" TOKEN="wsm <dein-api-token " Anfrage (Request Body) { "name": "Kundenname", "email": "kunde@example.com", "packageType": "business", // konfigurierter packageType oder Display-Name aus der Paket-Konfiguration der Organisation "organizationId": 1, // optional (nur für Global Admins erforderlich) "status": "active", // optional, Standard: active "customFields": { ... } // optional } Hinweise: packageType kann den konfigurierten Paket-Key oder den Display-Namen des Pakets enthalten. Bekannte Alias-Schreibweisen wie aquisition test werden automatisch normalisiert. Wenn kein konfiguriertes Paket dazu passt, wird der Request mit 400 Bad Request abgelehnt. Für normale...

#### Kunden kündigen
URL: https://uptimeify.io/docs/api/kunden/kunden-kuendigen
Beschreibung: POST /api/customers/:customerPublicId/cancel
Endpunkte: POST /api/customers/:customerPublicId/cancel
Wichtige Abschnitte: Authentifizierung | Beispiel-Request | Beispiel-Response | Häufige Fehler
Zusammenfassung: Kunden kündigen POST /api/customers/:customerPublicId/cancel Markiert einen Kunden zur Kündigung und startet die 3-Tage-Schonfrist sofort. Authentifizierung Dieser Endpoint erfordert Authentifizierung. BASE URL="https://uptimeify.io" TOKEN="wsm <dein-api-token " Beispiel-Request curl -X POST "$BASE URL/api/customers/6bfec6f6-245a-47ce-843b-157d97d56f88/cancel" \ -H "Authorization: Bearer $TOKEN" \ -H "Content-Type: application/json" Beispiel-Response { "id": 101, "publicId": "6bfec6f6-245a-47ce-843b-157d97d56f88", "organizationId": 1, "name": "Customer A GmbH", "email": "contact@customer-a.de", "notificationPhoneNumber": "+491701234567", "notificationEmail": "alerts@customer-a.de", "packageId": 3, "packageType": "acquisition test", "status": "marked for cancellation", "cancellationDate": "2026-03-01T19:37:00.000Z", "cancelledAt": "2026-02-26T19:37:00.000Z", "customFields": {...

#### Paket wechseln
URL: https://uptimeify.io/docs/api/kunden/paket-wechseln
Beschreibung: PATCH /api/customers/:customerPublicId
Endpunkte: PATCH /api/customers/:customerPublicId
Wichtige Abschnitte: Authentifizierung | Anfrage (Request Body) | Beispiel-Request | Beispiel-Response | Häufige Fehler
Zusammenfassung: Paket wechseln PATCH /api/customers/:customerPublicId Ändert die Paketzuordnung des Kunden. Technisch ist das derselbe Endpoint wie Kunden aktualisieren — normalerweise sendest du hier packageId. Legacy-packageType-Werte werden aus Kompatibilitätsgründen weiterhin akzeptiert. Authentifizierung BASE URL="https://uptimeify.io" TOKEN="<your-api-token " Anfrage (Request Body) { "packageId": 12 } Beispiel-Request curl -X PATCH "$BASE URL/api/customers/6bfec6f6-245a-47ce-843b-157d97d56f88" \ -H "Authorization: Bearer $TOKEN" \ -H "Content-Type: application/json" \ -d '{ "packageId": 12 }' Beispiel-Response { "id": 101, "publicId": "6bfec6f6-245a-47ce-843b-157d97d56f88", "organizationId": 1, "name": "Customer A GmbH", "email": "contact@customer-a.de", "notificationPhoneNumber": null, "notificationEmail": null, "packageId": 12, "status": "active", "monthlyReportsEnabled": true, "customFields":...

### Organisation & Abrechnung
URL: https://uptimeify.io/docs/api/organisation
Beschreibung: Pfadbasierte Organisations-Endpunkte verwenden organizationPublicId-UUIDs.
Wichtige Abschnitte: Endpunkte
Zusammenfassung: Pfadbasierte Organisations-Endpunkte verwenden organizationPublicId-UUIDs. Endpunkte Organisations-Details abrufen Organisation aktualisieren Paket-Konfigurationen auflisten Paket-Konfiguration erstellen/aktualisieren Paket-Konfiguration löschen Rechnungs-Details abrufen Rechnungs-Details aktualisieren Rechnungen auflisten Fehlerliste und bekannte API-Fallen

#### Organisation aktualisieren
URL: https://uptimeify.io/docs/api/organisation/organisation-aktualisieren
Beschreibung: PATCH /api/organization
Endpunkte: PATCH /api/organization | PATCH /api/organizations/:organizationPublicId | PATCH /api/organizations
Wichtige Abschnitte: Anfrage (Request Body) | Beispiel (cURL) | Häufige Fehler
Zusammenfassung: Organisation aktualisieren PATCH /api/organization Aktualisiert die Organisation aus deiner authentifizierten Session. Anfrage (Request Body) { "name": "Neuer Name", "companyName": "Neuer Firmenname", "street": "Neue Straße", "postalCode": "54321", "city": "Neue Stadt", "country": "US", "vatId": "US123", "billingEmail": "neu@example.com", "defaultNotificationChannels": { "email": true, "sms": false, "webhook": true, "integrations": false }, "defaultNotificationTargets": { "email": "both", // customer, organization, both "sms": "organization", "webhook": "organization", "integrations": "customer" } } Beispiel (cURL) BASE URL="https://uptimeify.io" TOKEN="<dein-api-token " curl -X PATCH "$BASE URL/api/organization" \ -H "Authorization: Bearer $TOKEN" \ -H "Content-Type: application/json" \ -H "Accept: application/json" \ -d '{ "name": "Neuer Name", "billingEmail": "neu@example.com" }'...

#### Organisations-Details abrufen
URL: https://uptimeify.io/docs/api/organisation/organisation-details-abfragen
Beschreibung: GET /api/organization
Endpunkte: GET /api/organization | GET /api/organizations/:organizationPublicId | GET /api/organizations
Wichtige Abschnitte: Beispiel (cURL) | Antwort (Response) | Häufige Fehler
Zusammenfassung: Organisations-Details abrufen GET /api/organization Gibt Details der Organisation aus deiner authentifizierten Session zurück. Beispiel (cURL) BASE URL="https://uptimeify.io" TOKEN="<dein-api-token " curl -X GET "$BASE URL/api/organization" \ -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 bleibt aus Kompatibilitätsgründen weiterhin verfügbar. Der plurale org-lose Alias GET /api/organizations wird ebenfalls unterstützt. Global Admins brauchen für die org-lose Route einen aktiven Organisationskontext in der Session. Antwort (Response) { "id": 1, "name": "Meine Org", "companyName": "Meine Firma GmbH", "street": "Musterstr. 1", "postalCode": "12345", "city": "Berlin", "country": "DE", "vatId":...

#### Paket-Konfiguration löschen
URL: https://uptimeify.io/docs/api/organisation/paket-konfiguration-loeschen
Beschreibung: DELETE /api/package-configs/:packageType
Endpunkte: DELETE /api/package-configs/:packageType | DELETE /api/organizations/:organizationPublicId/package-configs/:packageType | DELETE /api/organizations/package-configs/:packageType
Wichtige Abschnitte: Beispiel (cURL) | Antwort (Response) | Häufige Fehler
Zusammenfassung: Paket-Konfiguration löschen DELETE /api/package-configs/:packageType Löscht eine Paket-Konfiguration der Organisation. Das ist nur möglich, wenn keine Kunden aktuell diesen :packageType verwenden. Das Paket wird direkt über den Pfad-Parameter aufgelöst. Werte wie test1 funktionieren also, solange sie exakt dem gespeicherten packageType entsprechen. Beispiel (cURL) BASE URL="https://uptimeify.io" TOKEN="<dein-api-token " curl -X DELETE "$BASE URL/api/package-configs/pro" \ -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 DELETE /api/organizations/:organizationPublicId/package-configs/:packageType bleibt aus Kompatibilitätsgründen weiterhin verfügbar. Der plurale org-lose Alias DELETE /api/organizations/package-configs/:packageType wird...

#### Paket-Konfiguration erstellen/aktualisieren
URL: https://uptimeify.io/docs/api/organisation/paket-konfiguration-upsert
Beschreibung: PATCH /api/package-configs/:packageType
Endpunkte: PATCH /api/package-configs/:packageType | PATCH /api/package-configs | PATCH /api/organizations/:organizationPublicId/package-configs/:packageType | PATCH /api/organizations/package-configs/:packageType
Wichtige Abschnitte: Anfrage (Request Body) | Beispiel (cURL) | Antwort (Response) | Häufige Fehler
Zusammenfassung: Paket-Konfiguration erstellen/aktualisieren PATCH /api/package-configs/:packageType 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. 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,...

#### Paket-Konfigurationen auflisten
URL: https://uptimeify.io/docs/api/organisation/paket-konfigurationen-auflisten
Beschreibung: GET /api/package-configs
Endpunkte: GET /api/package-configs | GET /api/organizations/:organizationPublicId/package-configs
Wichtige Abschnitte: Beispiel (cURL) | Antwort (Response) | Häufige Fehler
Zusammenfassung: Paket-Konfigurationen auflisten GET /api/package-configs Gibt alle Paket-Konfigurationen der Organisation aus deiner authentifizierten Session zurück. Jede Konfiguration enthält zusätzlich usedByCustomerCount. 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. Antwort (Response) [ { "id": 10, "packageType": "pro", "maxUrls": 100, "dataRetentionMonths": 12, "checkIntervalMinutes": 1, "checkLocations": 3,...

#### Rechnungs-Details abrufen
URL: https://uptimeify.io/docs/api/organisation/rechnung-details-abfragen
Beschreibung: GET /api/organization/billing
Endpunkte: GET /api/organization/billing | GET /api/organizations/:organizationPublicId/billing | GET /api/organizations/billing
Wichtige Abschnitte: Beispiel (cURL) | Antwort (Response) | Häufige Fehler
Zusammenfassung: Rechnungs-Details abrufen GET /api/organization/billing Gibt Rechnungsinformationen und Zahlungsmethoden der Organisation aus deiner authentifizierten Session zurück. Beispiel (cURL) BASE URL="https://uptimeify.io" TOKEN="<dein-api-token " curl -X GET "$BASE URL/api/organization/billing" \ -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/billing bleibt aus Kompatibilitätsgründen weiterhin verfügbar. Der plurale org-lose Alias GET /api/organizations/billing wird ebenfalls unterstützt. Global Admins brauchen für die org-lose Route einen aktiven Organisationskontext in der Session. Antwort (Response) { "billingEmail": "billing@beispiel.de", "paymentMethod": "mollie" } Häufige Fehler 400 Organization...

#### Rechnungs-Details aktualisieren
URL: https://uptimeify.io/docs/api/organisation/rechnung-details-aktualisieren
Beschreibung: PATCH /api/organization/billing
Endpunkte: PATCH /api/organization/billing | PATCH /api/organizations/:organizationPublicId/billing | PATCH /api/organizations/billing
Wichtige Abschnitte: Anfrage (Request Body) | Beispiel (cURL) | Hinweise | Häufige Fehler
Zusammenfassung: Rechnungs-Details aktualisieren PATCH /api/organization/billing Aktualisiert Rechnungsinformationen der Organisation aus deiner authentifizierten Session. Anfrage (Request Body) { "billingEmail": "billing@example.com" } Beispiel (cURL) BASE URL="https://uptimeify.io" TOKEN="<dein-api-token " curl -X PATCH "$BASE URL/api/organization/billing" \ -H "Authorization: Bearer $TOKEN" \ -H "Content-Type: application/json" \ -H "Accept: application/json" \ -d '{ "billingEmail": "billing@example.com" }' Hinweise Dieses Endpoint akzeptiert aktuell nur billingEmail. Die Organisation wird automatisch aus deiner authentifizierten Session bzw. deinem API-Token abgeleitet. Die Legacy-Route PATCH /api/organizations/:organizationPublicId/billing bleibt aus Kompatibilitätsgründen weiterhin verfügbar. Der plurale org-lose Alias PATCH /api/organizations/billing wird ebenfalls unterstützt. Global Admins...

#### Rechnungen auflisten
URL: https://uptimeify.io/docs/api/organisation/rechnungen-auflisten
Beschreibung: GET /api/mollie/invoices
Endpunkte: GET /api/mollie/invoices | GET /api/organizations/:organizationPublicId/mollie/invoices
Wichtige Abschnitte: Beispiel (cURL) | Antwort (Response) | Häufige Fehler
Zusammenfassung: Rechnungen auflisten GET /api/mollie/invoices Listet alle Rechnungen für die Organisation auf. Beispiel (cURL) BASE URL="https://uptimeify.io" TOKEN="<dein-api-token " curl -X GET \ "$BASE URL/api/mollie/invoices" \ -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/mollie/invoices bleibt aus Kompatibilitätsgründen weiterhin verfügbar. Die pdfUrl-Werte in der Response verwenden die org-lose Download-Route /api/invoices/:invoiceId/pdf. Global Admins brauchen für die org-lose Route einen aktiven Organisationskontext in der Session. Antwort (Response) { "invoices": [ { "id": "inv 123456", "reference": "RE-2024-001", "status": "paid", "issuedAt": "2024-01-15T10:00:00.000Z", "netAmount": { "value":...

### Benutzer
URL: https://uptimeify.io/docs/api/benutzer
Beschreibung: Verwalte Benutzer innerhalb deiner Organisation.
Wichtige Abschnitte: Endpoints
Zusammenfassung: Verwalte Benutzer innerhalb deiner Organisation. Endpoints Benutzer auflisten Benutzer erstellen Benutzer abrufen Benutzer aktualisieren Benutzer löschen

#### Benutzer abrufen
URL: https://uptimeify.io/docs/api/benutzer/benutzer-abrufen
Beschreibung: GET /api/users/:id
Endpunkte: GET /api/users/:id
Wichtige Abschnitte: Antwort (Response)
Zusammenfassung: Benutzer abrufen GET /api/users/:id Gibt die Details eines bestimmten Benutzers zurück. Antwort (Response) { "id": "user 123", "name": "Max Mustermann", "email": "max@example.com", "role": "admin", "isActive": true, "createdAt": "2023-01-01T00:00:00Z" }

#### Benutzer aktualisieren
URL: https://uptimeify.io/docs/api/benutzer/benutzer-aktualisieren
Beschreibung: PATCH /api/users/:id
Endpunkte: PATCH /api/users/:id
Wichtige Abschnitte: Anfrage (Request Body)
Zusammenfassung: Benutzer aktualisieren PATCH /api/users/:id Aktualisiert die Details und Berechtigungen eines Benutzers. Anfrage (Request Body) { "firstName": "Jane", "lastName": "Smith", "role": "admin", "isActive": true, "customerIds": ["11111111-1111-4111-8111-111111111111", "22222222-2222-4222-8222-222222222222"] // Update der Liste zugewiesener Kunden per Public ID } Hinweise: customerIds akzeptiert Customer-Public-IDs und weiterhin Legacy-Integer-IDs. Für neue Integrationen sind Public IDs die bevorzugte Form.

#### Benutzer auflisten
URL: https://uptimeify.io/docs/api/benutzer/benutzer-auflisten
Beschreibung: GET /api/users
Endpunkte: GET /api/users
Wichtige Abschnitte: Antwort (Response)
Zusammenfassung: Benutzer auflisten GET /api/users Listet alle Benutzer in der Organisation auf. Antwort (Response) { "id": "user 123", "name": "Max Mustermann", "email": "max@example.com", "role": "admin", "isActive": true, "createdAt": "2023-01-01T00:00:00Z" }

#### Benutzer erstellen
URL: https://uptimeify.io/docs/api/benutzer/benutzer-erstellen
Beschreibung: POST /api/users
Endpunkte: POST /api/users
Wichtige Abschnitte: Anfrage (Request Body)
Zusammenfassung: Benutzer erstellen POST /api/users Erstellt einen neuen Benutzer in der Organisation. Anfrage (Request Body) { "email": "jane@example.com", "firstName": "Jane", "lastName": "Doe", "role": "user", // "admin" oder "user" "password": "temporaryPassword123", // Optional, Benutzer kann es später setzen "customerIds": ["11111111-1111-4111-8111-111111111111", "22222222-2222-4222-8222-222222222222"] // Optional: Zugriff auf bestimmte Kunden per Public ID beschränken } Hinweise: customerIds akzeptiert Customer-Public-IDs und weiterhin Legacy-Integer-IDs. Für neue Integrationen sind Public IDs die bevorzugte Form.

#### Benutzer löschen
URL: https://uptimeify.io/docs/api/benutzer/benutzer-loeschen
Beschreibung: DELETE /api/users/:id
Endpunkte: DELETE /api/users/:id
Wichtige Abschnitte: Antwort
Zusammenfassung: Benutzer löschen DELETE /api/users/:id Entfernt einen Benutzer aus der Organisation. Antwort Bei Erfolg: 204 No Content.

## Status-Seiten & Benachrichtigungskanaele
Oeffentliche Status-Seiten, Benachrichtigungskanaele (E-Mail, SMS, Webhook, Slack, Discord, PagerDuty, Pushover, Opsgenie) und Eskalations-Webhooks.

### Status-Seiten
URL: https://uptimeify.io/docs/api/status-seiten
Beschreibung: Status-Seiten erstellen und verwalten – öffentliche Seiten für Verfügbarkeit, Vorfälle und Wartungsfenster.
Wichtige Abschnitte: Authentifizierung | Endpunkte
Zusammenfassung: Status-Seiten Status-Seiten ermöglichen es, den Betriebsstatus überwachter Dienste für Kunden oder die Öffentlichkeit transparent darzustellen. Sie können öffentlich zugänglich oder auf Kundenmitglieder beschränkt sein. Custom Domains werden per DNS-Verifizierung eingebunden. Authentifizierung Alle Beispiele setzen einen Bearer-Token voraus: BASE URL="https://uptimeify.io" TOKEN="<dein-api-token " Endpunkte Status-Seiten auflisten Status-Seite erstellen Status-Seite abfragen Status-Seite aktualisieren Status-Seite löschen Design abfragen Design aktualisieren </content </invoke

#### Design abfragen
URL: https://uptimeify.io/docs/api/status-seiten/design-abfragen
Beschreibung: GET /api/status-pages/:id/design
Endpunkte: GET /api/status-pages/:id/design
Wichtige Abschnitte: Pfad-Parameter | Beispiel (cURL) | Antwort | Fehler
Zusammenfassung: Design abfragen GET /api/status-pages/:id/design Gibt die aktuelle visuelle Designkonfiguration einer Status-Seite zurück. Erfordert Admin-Rolle. Pfad-Parameter Parameter Beschreibung ----------- ------------- id Status-Seiten-ID oder publicId (UUID) Beispiel (cURL) curl "$BASE URL/api/status-pages/db58058e-4b58-4d97-a314-3bb8e279a182/design" \ -H "Authorization: Bearer $TOKEN" Antwort { "designConfig": { "layout": "timeline", "colorScheme": "dark", "accentColor": "#f59e0b", "headerStyle": "simple", "fontFamily": "system", "cardRadius": "md", "pageWidth": "lg", "customTitle": "", "customSubtitle": "", "showPoweredBy": true, "showUptimeStats": true, "showServiceUrls": false, "showLastChecked": false, "showHistory": true } } Wenn noch kein Design gespeichert wurde, werden alle Felder mit den Standardwerten befüllt. Fehler 401 Unauthorized – nicht angemeldet 403 Forbidden – keine...

#### Design aktualisieren
URL: https://uptimeify.io/docs/api/status-seiten/design-aktualisieren
Beschreibung: PATCH /api/status-pages/:id/design
Endpunkte: PATCH /api/status-pages/:id/design
Wichtige Abschnitte: Pfad-Parameter | Request Body (alle Felder optional) | Layout | Farben | Typografie & Stil | Header
Zusammenfassung: Design aktualisieren PATCH /api/status-pages/:id/design Aktualisiert die visuelle Designkonfiguration einer Status-Seite. Es werden nur die übermittelten Felder geändert – alle anderen Einstellungen bleiben unverändert. Erfordert Admin-Rolle. Pfad-Parameter Parameter Beschreibung ----------- ------------- id Status-Seiten-ID oder publicId (UUID) Request Body (alle Felder optional) Layout Feld Typ Werte Standard Beschreibung ------ ----- ------- ---------- ------------- layout string classic cards minimal sleek board split timeline compact classic Visuelles Layout-Template pageWidth string sm md lg xl lg Maximale Inhaltsbreite: sm = 672 px, md = 896 px, lg = 1024 px, xl = 1280 px Farben Feld Typ Werte Standard Beschreibung ------ ----- ------- ---------- ------------- colorScheme string light dark auto auto Farbmodus. auto folgt der Systemeinstellung des Besuchers. accentColor string...

## Whitelabel & API-Tokens
White-Label-Branding, Custom Domains, SMTP-Konfiguration, API-Token-Verwaltung und benutzerdefinierte Felder.

## Organisations-SMTP & Monitoring-Standorte
Benutzerdefinierte SMTP-Konfiguration fuer ausgehende E-Mails und Discovery der Monitoring-Probe-Standorte.

## Plattform-Administration
Administrative und interne Plattform-Endpunkte fuer erweiterte Operator-Rollen.

### Globale Administration
URL: https://uptimeify.io/docs/api/admin
Beschreibung: Dieser Abschnitt deckt die Endpunkte der globalen Administration ab, die geschützt sind und nur für Plattform-Administratoren zugänglich sind.
Wichtige Abschnitte: Endpunkte
Zusammenfassung: Dieser Abschnitt deckt die Endpunkte der globalen Administration ab, die geschützt sind und nur für Plattform-Administratoren zugänglich sind. (Endpunkte werden noch dokumentiert) Endpunkte

## Lokalisierte Dokumentation
Deutsch ist die kanonische Sprache fuer diesen Voll-Export. Eine englische Variante der LLMS- und API-Dokumentation ist ebenfalls verfuegbar.

- English LLMS index: https://uptimeify.io/llms.txt
- English LLMS full: https://uptimeify.io/llms-full.txt
- English API docs: https://uptimeify.io/docs/api