सूचना प्रणाली

परीक्षण सूचना - /api/notifications/test

• एंडपॉइंट: /api/notifications/test

• विधि: POST

• विवरण: सूचना कॉन्फ़िगरेशन को सत्यापित करने के लिए परीक्षण सूचनाएं (सरल, टेम्पलेट-आधारित, या ईमेल) भेजें।

• प्रमाणीकरण: व्यवस्थापक सत्र और CSRF टोकन की आवश्यकता है

• अनुरोध निकाय: सरल परीक्षण के लिए:

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

टेम्पलेट परीक्षण के लिए:

{
  "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"
  }
}

ईमेल परीक्षण के लिए:

{
  "type": "email"
}

• प्रतिक्रिया: सरल परीक्षण के लिए:

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

टेम्पलेट परीक्षण के लिए:

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

ईमेल परीक्षण के लिए:

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

परीक्षण ईमेल सामग्री प्रदर्शित करता है:

• SMTP सर्वर होस्टनेम और पोर्ट
• कनेक्शन प्रकार (प्लेन SMTP, STARTTLS, या डायरेक्ट SSL/TLS)
• SMTP प्रमाणीकरण आवश्यकता स्थिति
• SMTP उपयोगकर्ता नाम (केवल तभी दिखाया जाता है जब प्रमाणीकरण आवश्यक हो)
• प्राप्तकर्ता ईमेल पता
• ईमेल के लिए उपयोग किया गया प्रेषक पता और प्रेषक नाम
• परीक्षण टाइमस्टैम्प
• त्रुटि प्रतिक्रियाएं:
  • 401: अनधिकृत - अमान्य सत्र या CSRF टोकन
  • 400: NTFY कॉन्फ़िगरेशन आवश्यक है, अमान्य कॉन्फ़िगरेशन, या ईमेल कॉन्फ़िगर नहीं है
  • 500: त्रुटि विवरण के साथ परीक्षण सूचना भेजने में विफल
• नोट्स:
  • सरल परीक्षण संदेश, टेम्पलेट-आधारित सूचनाएं और ईमेल परीक्षण का समर्थन करता है
  • टेम्पलेट परीक्षण टेम्पलेट चर को बदलने के लिए नमूना डेटा का उपयोग करता है
  • परीक्षण संदेश में टाइमस्टैम्प शामिल करता है
  • NTFY परीक्षण संग्रहीत NTFY कॉन्फ़िगरेशन का उपयोग करता है; क्लाइंट-आपूर्ति NTFY URL का उपयोग नहीं किया जाता है
  • संग्रहीत होने पर प्रमाणीकरण के लिए accessToken फ़ील्ड का उपयोग करता है
  • टेम्पलेट परीक्षण के लिए, NTFY और ईमेल (यदि कॉन्फ़िगर किया गया हो) दोनों को सूचनाएं भेजता है
  • ईमेल परीक्षण के लिए SMTP कॉन्फ़िगरेशन सेटअप की आवश्यकता होती है
  • परीक्षण ईमेल एंडपॉइंट SMTP कॉन्फ़िगरेशन पढ़ने से पहले अनुरोध कैश साफ़ करता है, सुनिश्चित करता है कि बाहरी स्क्रिप्ट कॉन्फ़िगरेशन को अपडेट कर सकती हैं और इसे तुरंत परीक्षण ईमेल में प्रतिबिंबित किया जा सके
  • टेम्पलेट परीक्षण और दैनिक सारांश अब भेजें प्रति-बैकअप दमन को छोड़ देता है

पूर्वावलोकन सूचना टेम्पलेट - /api/notifications/preview

• एंडपॉइंट: /api/notifications/preview
• विधि: POST
• विवरण: भेजे बिना उत्पादन मार्कडाउन रेंडरर के साथ एक सूचना टेम्पलेट प्रस्तुत करता है। निकाय में kind (success, warning, overdueBackup, या dailySummaryEmail) और संपादित किया जा रहा टेम्पलेट शामिल है। दैनिक सारांश पूर्वावलोकन वर्तमान वास्तविक स्नैपशॉट का उपयोग करता है; अन्य प्रकार निर्धारित नमूना मानों का उपयोग करते हैं। ईमेल HTML एक सैंडबॉक्स आईफ्रेम के लिए उद्देशित है। सफलता, चेतावनी/त्रुटि, और अतिदेय भी NTFY पेलोड (ntfyMessage) लौटाते हैं; कोई भी GFM तालिका शीर्षक छोड़ दिया जाता है और शरीर पंक्तियां सादा पाठ हैं।
• प्रमाणीकरण: वैध सत्र और CSRF टोकन की आवश्यकता होती है

बकाया बैकअप की जांच करें - /api/notifications/check-overdue

• एंडपॉइंट: /api/notifications/check-overdue

• विधि: POST

• विवरण: बकाया बैकअप जांच को मैन्युअल रूप से ट्रिगर करता है और सूचनाएं भेजता है।

• प्रमाणीकरण: वैध सत्र और CSRF टोकन की आवश्यकता है

• प्रतिक्रिया:

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

• त्रुटि प्रतिक्रियाएं:

  • 500: बकाया बैकअप की जांच करने में विफल

• नोट्स:

  • मैन्युअल रूप से बकाया बैकअप जांच ट्रिगर करता है
  • जांच प्रक्रिया के बारे में आँकड़े लौटाता है
  • पाए गए बकाया बैकअप के लिए सूचनाएं भेजता है

सूचना चैनल अलर्ट - /api/notification-channel-alerts

• एंडपॉइंट: /api/notification-channel-alerts

• विधि: GET, POST

• विवरण: साइन-इन किए गए व्यवस्थापक के लिए खुली ईमेल और ntfy डिलीवरी विफलताओं को सूचीबद्ध करता है, या किसी नई विफलता के लॉग होने तक सूचीबद्ध चैनलों पर 'साफ़ करें' लागू करता है।

• प्रमाणीकरण: व्यवस्थापक सत्र की आवश्यकता है। POST के लिए X-CSRF-Token हेडर में CSRF टोकन की भी आवश्यकता होती है।

• अनुरोध बॉडी (POST):

  {
    "channels": ["email", "ntfy"]
  }

channels में email और ntfy में से एक या दोनों होने चाहिए।

• प्रतिक्रिया:

  {
    "alerts": [
      {
        "channel": "email",
        "error": "SMTP authentication failed",
        "latestTimestamp": "2026-09-23 22:10:00",
        "failureCount": 3,
        "settingsTab": "email",
        "host": "smtp.gmail.com"
      }
    ]
  }

प्रत्येक अलर्ट में channel, error (अधिकतम 500 अक्षर), latestTimestamp, failureCount, और settingsTab (email या ntfy) शामिल होते हैं। ईमेल अलर्ट में host शामिल हो सकता है। NTFY अलर्ट में topic शामिल हो सकता है।

• त्रुटि प्रतिक्रियाएँ:
  • 400 INVALID_CONFIGURATION: POST बॉडी मौजूद नहीं है, या channels खाली है या इसमें कोई अज्ञात मान शामिल है
  • 500 INTERNAL_ERROR: अलर्ट पढ़ने या साफ़ करने में विफलता
• नोट्स:
  • GET उन चैनलों को लौटाता है जो इस व्यवस्थापक के लिए अभी भी विफल हो रहे हैं
  • POST वर्तमान में खुले प्रत्येक सूचीबद्ध चैनल के लिए प्रति-व्यवस्थापक 'साफ़ करें' रिकॉर्ड करता है, फिर शेष अलर्ट लौटाता है
  • बाद की विफलता चैनल को फिर से दिखाती है, भले ही त्रुटि टेक्स्ट अपरिवर्तित हो
  • उस चैनल के लिए बाद की सफल डिलीवरी इसे छिपा हुआ रखती है
  • 'साफ़ करें' मार्कर कॉन्फ़िगरेशन में संग्रहीत होता है और इसमें सीक्रेट शामिल नहीं होते हैं

बकाया टाइमस्टैम्प साफ़ करें - /api/notifications/clear-overdue-timestamps

• एंडपॉइंट: /api/notifications/clear-overdue-timestamps

• विधि: POST

• विवरण: सभी बकाया बैकअप सूचना टाइमस्टैम्प साफ़ करता है, सूचनाओं को फिर से भेजे जाने की अनुमति देता है।

• प्रमाणीकरण: वैध सत्र और CSRF टोकन की आवश्यकता है

• प्रतिक्रिया:

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

• त्रुटि प्रतिक्रियाएं:

  • 500: बकाया बैकअप टाइमस्टैम्प साफ़ करने में विफल

• नोट्स:

  • सभी बकाया बैकअप सूचना टाइमस्टैम्प साफ़ करता है
  • सूचनाओं को फिर से भेजे जाने की अनुमति देता है
  • सूचना प्रणाली का परीक्षण करने के लिए उपयोगी है