Zum Hauptinhalt springen

Benachrichtigungssystem

Testbenachrichtigung - /api/notifications/test​

  • Endpunkt: /api/notifications/test

  • Methode: POST

  • Beschreibung: Sendet Testbenachrichtigungen (einfach, vorlagenbasiert oder per E-Mail), um die Benachrichtigungskonfiguration zu überprüfen.

  • Authentifizierung: Erfordert gültige Sitzung und CSRF-Token

  • Anforderungstext: Für einfachen Test:

    {
      "type": "simple",
      "ntfyConfig": {
        "url": "https://ntfy.sh",
        "topic": "test-topic",
        "accessToken": "optional-access-token"
      }
    }

Für Template-Test:

{
  "type": "template",
  "ntfyConfig": {
    "url": "https://ntfy.sh",
    "topic": "test-topic",
    "accessToken": "optional-access-token"
  },
  "template": {
    "title": "Test Title",
    "message": "Test message with {variable}",
    "priority": "default",
    "tags": "test"
  }
}

Für E-Mail-Test:

{
  "type": "email"
}

  • Antwort: Für einfachen Test:

    {
      "message": "Test notification sent successfully"
    }

Für Template-Test:

{
  "success": true,
  "message": "Test notifications sent successfully via NTFY and Email",
  "channels": ["NTFY", "Email"]
}

Für E-Mail-Test:

{
  "message": "Test email sent successfully"
}

Der Inhalt der Test-E-Mail zeigt Folgendes an:

  • SMTP-Server-Hostname und Port
  • Verbindungstyp (Einfaches SMTP, STARTTLS oder Direkte SSL/TLS)
  • Status der SMTP-Authentifizierungsanforderung
  • SMTP-Benutzername (nur angezeigt, wenn Authentifizierung erforderlich ist)
  • Empfänger-E-Mail-Adresse
  • Absenderadresse und Name des Absenders für die E-Mail
  • Test-Zeitstempel
  • Fehlerantworten:
    • 401: Nicht autorisiert – Ungültige Sitzung oder CSRF-Token
    • 400: NTFY-Konfiguration ist erforderlich, ungültige Konfiguration oder E-Mail nicht konfiguriert
    • 500: Testbenachrichtigung konnte nicht gesendet werden, mit Fehlerdetails
  • Hinweise:
    • Unterstützt einfache Testnachrichten, vorlagenbasierte Benachrichtigungen und E-Mail-Tests
    • Bei der Vorlagenprüfung werden Beispieldaten verwendet, um Vorlagenvariablen zu ersetzen
    • Enthält Zeitstempel in der Testnachricht
    • Überprüft NTFY-URL und Thema vor dem Senden
    • Verwendet das accessToken-Feld für die Authentifizierung
    • Sendet bei Vorlagentests Benachrichtigungen sowohl an NTFY als auch per E-Mail (falls konfiguriert)
    • E-Mail-Tests erfordern eine eingerichtete SMTP-Konfiguration
    • Der Test-E-Mail-Endpunkt löscht den Anforderungscache vor dem Lesen der SMTP-Konfiguration, sodass externe Skripte die Konfiguration aktualisieren können und diese sofort in den Test-E-Mails berücksichtigt werden

Überfällige Sicherungen prüfen - /api/notifications/check-overdue​

  • Endpunkt: /api/notifications/check-overdue

  • Methode: POST

  • Beschreibung: Löst manuell die Prüfung auf überfällige Sicherungen aus und sendet Benachrichtigungen.

  • Authentifizierung: Erfordert gültige Sitzung und CSRF-Token

  • Antwort:

    {
      "message": "Overdue backup check completed",
      "statistics": {
        "totalBackupConfigs": 5,
        "checkedBackups": 5,
        "overdueBackupsFound": 2,
        "notificationsSent": 2
      }
    }

  • Fehlerantworten:

    • 500: Überprüfung auf überfällige Sicherungen fehlgeschlagen

  • Hinweise:

    • Löst manuell die Überprüfung auf überfällige Sicherungen aus
    • Gibt Statistiken über den Überprüfungsprozess zurück
    • Sendet Benachrichtigungen für gefundene überfällige Sicherungen

Überfällige Zeitstempel löschen - /api/notifications/clear-overdue-timestamps​

  • Endpunkt: /api/notifications/clear-overdue-timestamps

  • Methode: POST

  • Beschreibung: Löscht alle Zeitstempel für Benachrichtigungen zu überfälligen Sicherungen, sodass Benachrichtigungen erneut gesendet werden können.

  • Authentifizierung: Erfordert gültige Sitzung und CSRF-Token

  • Antwort:

    {
      "message": "Overdue backup notification timestamps cleared successfully"
    }

  • Fehlerantworten:

    • 500: Löschen der Zeitstempel für überfällige Sicherungen fehlgeschlagen

  • Hinweise:

    • Löscht alle Zeitstempel für Benachrichtigungen über überfällige Sicherungen
    • Ermöglicht erneutes Senden von Benachrichtigungen
    • Nützlich zum Testen des Benachrichtigungssystems