Saltar al contenido principal

Gestión de la configuración

Obtener configuración de correo electrónico - /api/configuration/email​

  • Endpoint: /api/configuration/email

  • Método: GET

  • Descripción: Recupera la configuración actual de notificaciones por correo electrónico y si las notificaciones por correo electrónico están habilitadas/configuradas.

  • Autenticación: Requiere una sesión y un token CSRF válidos

  • Respuesta (configurado):

    {
      "configured": true,
      "config": {
        "host": "smtp.example.com",
        "port": 465,
        "connectionType": "ssl",
        "username": "user@example.com",
        "mailto": "admin@example.com",
        "senderName": "duplistatus",
        "fromAddress": "user@example.com",
        "requireAuth": true,
        "hasPassword": true
      },
      "message": "Email is configured and ready to use."
    }

  • Respuesta (no configurado):

    {
      "configured": false,
      "config": null,
      "message": "Email is not configured. Please configure SMTP settings."
    }

  • Respuestas de Error:

    • 400: La clave maestra no es válida - Todas las contraseñas y configuraciones cifradas deben volver a configurarse
    • 401: No autorizado - Sesión inválida o token CSRF
    • 500: Error al obtener la configuración de correo electrónico

  • Notas:

    • Devuelve la configuración sin contraseña por seguridad
    • Incluye el campo hasPassword para indicar si se ha establecido una contraseña
    • Incluye los campos connectionType (plain|starttls|ssl), senderName, fromAddress y requireAuth
    • Indica si las notificaciones por correo electrónico están disponibles para uso de prueba y producción
    • Maneja errores de validación de clave maestra correctamente

Actualizar la configuración de correo electrónico - /api/configuration/email​

  • Endpoint: /api/configuration/email

  • Método: POST

  • Descripción: Actualiza la configuración de notificaciones por correo electrónico SMTP.

  • Autenticación: Requiere sesión válida y token CSRF

  • Cuerpo de la solicitud:

    {
      "host": "smtp.example.com",
      "port": 465,
      "secure": true,
      "username": "user@example.com",
      "password": "password",
      "mailto": "admin@example.com"
    }

  • Respuesta:

    {
      "success": true,
      "message": "SMTP configuration saved successfully"
    }

  • Respuestas de Error:

    • 400: Faltan campos obligatorios o número de puerto no válido
    • 401: No autorizado - Sesión inválida o token CSRF
    • 500: Error al guardar la configuración SMTP

  • Notas:

    • Todos los campos (host, puerto, nombre de usuario, contraseña, mailto) son obligatorios
    • El puerto debe ser un número válido entre 1 y 65535
    • El campo seguro es booleano (verdadero para SSL/TLS)
    • La contraseña se gestiona por separado a través del punto final de contraseña

Eliminar configuración de correo electrónico - /api/configuration/email​

  • Endpoint: /api/configuration/email

  • Método: DELETE

  • Descripción: Elimina la configuración de notificaciones por correo electrónico SMTP.

  • Autenticación: Requiere sesión válida y token CSRF

  • Respuesta:

    {
      "success": true,
      "message": "SMTP configuration deleted successfully"
    }

  • Respuestas de Error:

    • 401: No autorizado - Sesión inválida o token CSRF
    • 404: No se encontró configuración SMTP para eliminar
    • 500: Error al eliminar la configuración SMTP

  • Notas:

    • Esta operación elimina permanentemente la configuración SMTP
    • Devuelve 404 si no existe ninguna configuración para eliminar
    • Devuelve 400 mientras el modo Resumen Diario esté habilitado, porque ese modo requiere SMTP

Actualizar la contraseña de correo electrónico - /api/configuration/email/password​

  • Endpoint: /api/configuration/email/password

  • Método: PATCH

  • Descripción: Actualiza la contraseña de correo electrónico para la autenticación SMTP.

  • Autenticación: Requiere sesión válida y token CSRF

  • Cuerpo de la solicitud:

    {
      "password": "new-password",
      "config": {
        "host": "smtp.example.com",
        "port": 465,
        "secure": true,
        "username": "user@example.com",
        "mailto": "admin@example.com"
      }
    }

  • Respuesta:

    {
      "message": "Email password updated successfully"
    }

  • Respuestas de Error:

    • 400: La contraseña debe ser una cadena o faltan campos de configuración obligatorios
    • 401: No autorizado - Sesión inválida o token CSRF
    • 500: Error al actualizar la contraseña de correo electrónico

  • Notas:

    • La contraseña puede ser una cadena vacía para borrar la contraseña
    • Si no existe configuración SMTP, crea una mínima a partir de la configuración proporcionada
    • El parámetro de configuración es obligatorio cuando no existe configuración SMTP existente
    • La contraseña se almacena de forma segura mediante cifrado

Obtener token CSRF de contraseña de correo electrónico - /api/configuration/email/password​

  • Punto de conexión: /api/configuration/email/password

  • Método: GET

  • Descripción: Recupera un token CSRF para operaciones de contraseña de correo electrónico.

  • Autenticación: Requiere sesión válida

  • Respuesta:

    {
      "csrfToken": "csrf-token-string"
    }

  • Respuestas de Error:

    • 401: Sesión no válida o expirada
    • 500: Error al generar el token CSRF

  • Notas:

    • Devuelve el token CSRF para su uso con operaciones de actualización de contraseña
    • La sesión debe ser válida para generar el token

Obtener configuración unificada - /api/configuration/unified​

  • Punto de conexión: /api/configuration/unified

  • Método: GET

  • Descripción: Recupera un objeto de configuración unificado que contiene todos los datos de configuración, incluida la configuración de cron, la frecuencia de notificación y los servidores con copias de seguridad.

  • Autenticación: Requiere sesión válida y token CSRF

  • Respuesta:

    {
      "ntfy": {
        "url": "https://ntfy.sh",
        "topic": "duplistatus-notifications",
        "accessToken": ""
      },
      "templates": {
        "language": "en-GB",
        "success": {
          "title": "✅ {status} - {backup_name} @ {server_name}",
          "message": "Backup {backup_name} on {server_name} completed with status '{status}' at {backup_date} in {duration}.",
          "priority": "default",
          "tags": "duplicati, duplistatus, success"
        },
        "warning": {
          "title": "⚠️ {status} - {backup_name} @ {server_name}",
          "message": "Backup {backup_name} on {server_name} completed with status '{status}' at {backup_date}.",
          "priority": "high",
          "tags": "duplicati, duplistatus, warning, error"
        },
        "overdueBackup": {
          "title": "🕑 Overdue - {backup_name} @ {server_name}",
          "message": "The backup {backup_name} is overdue on {server_name}.",
          "priority": "default",
          "tags": "duplicati, duplistatus, overdue"
        },
        "dailySummary": {
          "email": {
            "title": "Daily Backup Summary — {summary_date} — ✅ {success_count} Success, ⚠️ {warning_count} Warning, 🕑 {overdue_count} Overdue, 🛑 {error_count} Error, ❌ {fatal_count} Fatal",
            "message": "## Daily backup summary"
          }
        }
      },
      "email": {
        "host": "smtp.example.com",
        "port": 465,
        "connectionType": "ssl",
        "username": "user@example.com",
        "mailto": "admin@example.com",
        "senderName": "duplistatus",
        "fromAddress": "user@example.com",
        "requireAuth": true,
        "hasPassword": true
      },
      "overdue_tolerance": "2h",
      "backup_settings": {
        "server1:backup1": {
          "notificationEvent": "all",
          "expectedInterval": 24,
          "overdueBackupCheckEnabled": true,
          "intervalUnit": "hours",
          "expectedBackupDate": "2025-02-07T00:00:00.000Z",
          "lastBackupDate": "2025-02-06T00:00:00.000Z"
        }
      },
      "serverAddresses": [
        {
          "id": "server1",
          "name": "Server 1",
          "server_url": "http://localhost:8200"
        }
      ],
      "cronConfig": {
        "cronExpression": "*/20 * * * *",
        "enabled": true
      },
      "notificationFrequency": "every_day",
      "serversWithBackups": [
        {
          "id": "server1",
          "name": "Server 1",
          "backupName": "backup1",
          "server_url": "http://localhost:8200",
          "alias": "My Server",
          "note": "Primary backup server",
          "hasPassword": true,
          "expectedBackupDate": "2025-02-07T00:00:00.000Z",
          "lastBackupDate": "2025-02-06T00:00:00.000Z"
        }
      ]
    }

  • Respuestas de Error:

    • 500: Error del servidor al recuperar la configuración unificada

  • Notas:

    • Devuelve todos los datos de configuración en una sola respuesta
    • Incluye configuración de cron, frecuencia de notificaciones y servidores con copias de seguridad
    • La configuración de correo electrónico incluye el campo hasPassword pero no la contraseña real
    • Recupera todos los datos en paralelo para un mejor rendimiento

Obtener Configuración de NTFY - /api/configuration/ntfy​

  • Endpoint: /api/configuration/ntfy

  • Method: GET

  • Descripción: Recupera la configuración actual de NTFY.

  • Autenticación: Requiere sesión válida y token CSRF

  • Respuesta:

    {
      "ntfy": {
        "url": "https://ntfy.sh",
        "topic": "duplistatus-notifications",
        "accessToken": "optional-access-token"
      }
    }

  • Respuestas de Error:

    • 401: No autorizado - Sesión inválida o token CSRF
    • 500: Error al recuperar la configuración de NTFY

  • Notas:

    • Devuelve la configuración actual de NTFY
    • Se utiliza para la gestión del sistema de notificaciones
    • Requiere autenticación para acceder a los datos de configuración

Obtener configuración de notificación - /api/configuration/notifications​

  • Punto de conexión: /api/configuration/notifications

  • Método: GET

  • Descripción: Recupera la configuración de frecuencia de notificación actual.

  • Autenticación: Requiere sesión válida y token CSRF

  • Respuesta:

    {
      "value": "every_day"
    }

  • Respuestas de Error:

    • 401: No autorizado - Sesión inválida o token CSRF
    • 500: Error al recuperar la configuración

  • Notas:

    • Recupera la configuración actual de frecuencia de notificaciones
    • Se utiliza para la gestión de notificaciones de copia de seguridad vencida
    • Devuelve uno de: "onetime", "every_day", "every_week", "every_month"

Actualizar Configuración de Notificaciones - /api/configuration/notifications​

  • Endpoint: /api/configuration/notifications

  • Method: POST

  • Descripción: Actualiza la configuración de notificaciones (Configuración de NTFY o frecuencia de notificaciones).

  • Autenticación: Requiere una sesión válida y un token CSRF

  • Cuerpo de la solicitud: Para la Configuración de NTFY:

    {
      "ntfy": {
        "enabled": true,
        "url": "https://ntfy.sh",
        "topic": "duplistatus-notifications",
        "accessToken": "optional-access-token"
      }
    }

Para la Frecuencia de notificación:

{
  "value": "every_week"
}

  • Respuesta: Para la Configuración de NTFY:

    {
      "message": "Notification config updated successfully",
      "ntfy": {
        "enabled": true,
        "url": "https://ntfy.sh",
        "topic": "duplistatus-notifications",
        "accessToken": "optional-access-token"
      }
    }

Para la Frecuencia de notificación:

{
  "value": "every_week"
}
  • Valores Disponibles: "onetime", "every_day", "every_week", "every_month"
  • Respuestas de Error:
    • 401: No autorizado - Sesión inválida o token CSRF
    • 400: Se requiere la configuración de NTFY o valor no válido
    • 500: Error del servidor al actualizar la configuración de notificaciones
  • Notas:
    • Admite actualizaciones tanto de configuración de NTFY como de frecuencia de notificaciones
    • Actualiza solo la configuración de NTFY cuando se proporciona el campo ntfy
    • Actualiza la frecuencia de notificación cuando se proporciona el campo value
    • Genera un tema predeterminado si no se proporciona ninguno
    • Conserva la configuración existente de configuración
    • Utiliza el campo accessToken en lugar de campos separados de nombre de usuario/contraseña
    • Valida el valor de frecuencia de notificación contra opciones permitidas
    • Afecta la frecuencia con que se envían las notificaciones vencidas

Actualizar la configuración de la Copia de seguridad - /api/configuration/backup-settings​

  • Endpoint: /api/configuration/backup-settings

  • Método: POST

  • Descripción: Actualiza la configuración de las Notificaciones de Copia de Seguridad para Servidores/copias de seguridad específicos.

  • Autenticación: Requiere sesión válida y token CSRF

  • Cuerpo de la solicitud:

    {
      "backupSettings": {
        "Server Name:Backup Name": {
          "notificationEvent": "all",
          "expectedInterval": 24,
          "overdueBackupCheckEnabled": true,
          "intervalUnit": "hours"
        }
      }
    }

  • Respuesta:

    {
      "message": "Backup settings updated successfully"
    }

  • Respuestas de Error:

    • 401: No autorizado - Sesión inválida o token CSRF
    • 400: backupSettings es obligatorio
    • 500: Error del servidor al actualizar la configuración de copia de seguridad

  • Notas:

    • Actualiza la configuración de notificaciones de copia de seguridad para servidores/copias de seguridad específicos
    • Limpia las notificaciones de copia de seguridad vencida para copias de seguridad deshabilitadas
    • Borra las notificaciones cuando cambian los ajustes de tiempo de espera

Actualizar Plantillas de Notificaciones - /api/configuration/templates​

  • Endpoint: /api/configuration/templates

  • Método: POST

  • Descripción: Actualiza las Plantillas de notificación.

  • Autenticación: Requiere sesión válida y token CSRF

  • Cuerpo de la solicitud:

    {
      "templates": {
        "success": {
          "title": "✅ {status} - {backup_name} @ {server_name}",
          "message": "Backup {backup_name} on {server_name} completed with status '{status}' at {backup_date} in {duration}.",
          "priority": "default",
          "tags": "duplicati, duplistatus, success"
        }
      }
    }

  • Respuesta:

    {
      "message": "Notification templates updated successfully"
    }

  • Respuestas de Error:

    • 401: No autorizado - Sesión o token CSRF inválido
    • 400: Las plantillas son obligatorias
    • 500: Error del servidor al actualizar las plantillas de notificación

  • Notas:

    • Actualiza las plantillas de notificación para diferentes estados de copia de seguridad
    • Conserva la configuración existente
    • Las plantillas admiten cuerpos de correo electrónico en formato Markdown y sustitución de {placeholder}
    • Se requiere una plantilla de correo electrónico dailySummary (asunto y cuerpo en formato Markdown)

Resumen Diario - /api/configuration/daily-summary​

  • Endpoint: /api/configuration/daily-summary
  • Método: GET, POST
  • Descripción: Lee o actualiza el Modo resumen diario. GET devuelve la configuración saneada, el estado del despachador, la Siguiente ejecución y el Estado de entrega del Correo electrónico. POST guarda enabled, utcTime (HH:mm UTC), timeZone (zona horaria IANA del navegador del último Guardar), publicUrl opcional y smtpRecipient opcional (si está vacío, utiliza el Destinatario SMTP de la Configuración de correo electrónico). La activación requiere un SMTP válido. Modificar utcTime actualiza daily-summary-dispatch a minute hour * * * UTC y recarga el servicio cron. Modificar la programación establece la próxima ejecución futura.
  • Autenticación: GET requiere una sesión válida y token CSRF. POST requiere una sesión de administrador y token CSRF.
  • Respuestas de Error:
    • 400: Hora/zona horaria inválida, URL pública inválida, destinatario SMTP inválido o falta SMTP
    • 401: No autorizado
    • 500: Falló al leer o actualizar el Resumen Diario

Enviar Resumen Diario - /api/configuration/daily-summary/send​

  • Endpoint: /api/configuration/daily-summary/send
  • Método: POST
  • Descripción: Envía una instantánea de estado actual adicional inmediatamente. No consume la siguiente ocurrencia programada. Utiliza SMTP almacenado. Envía a daily_summary.smtpRecipient cuando está configurado, de lo contrario al destinatario de configuración de correo electrónico. No acepta direcciones de destinatarios en la solicitud. Registra daily_summary_sent en el registro de auditoría (sistema).
  • Autenticación: Requiere sesión de administrador y token CSRF

Reintentar Resumen Diario - /api/configuration/daily-summary/retry​

  • Endpoint: /api/configuration/daily-summary/retry
  • Método: POST
  • Descripción: Reintenta canales fallidos de la carga persistida. Cuerpo opcional { "occurrenceKey": "..." }; de lo contrario, reintenta el último envío de correo electrónico fallido.
  • Autenticación: Requiere sesión de administrador y token CSRF

Vista previa de Resumen Diario - /api/configuration/daily-summary/preview​

  • Endpoint: /api/configuration/daily-summary/preview
  • Método: POST
  • Descripción: Representa la instantánea actual sin enviar y sin escribir filas del registro de entrega.
  • Autenticación: Requiere sesión válida y token CSRF

Obtener Tolerancia de Vencimiento - /api/configuration/overdue-tolerance​

  • Endpoint: /api/configuration/overdue-tolerance

  • Método: GET

  • Descripción: Recupera la configuración de tolerancia de vencimiento actual.

  • Respuesta:

    {
      "overdue_tolerance": "2h"
    }

  • Respuestas de Error:

    • 500: Falló al obtener la tolerancia de vencimiento

  • Notas:

    • Devuelve la configuración actual de tolerancia de vencimiento
    • Utilizado para mostrar la configuración actual

Actualizar Tolerancia de Vencimiento - /api/configuration/overdue-tolerance​

  • Endpoint: /api/configuration/overdue-tolerance

  • Método: POST

  • Descripción: Actualiza la configuración de tolerancia de vencimiento.

  • Autenticación: Requiere sesión válida y token CSRF

  • Cuerpo de la solicitud:

    {
      "overdue_tolerance": "2h"
    }

  • Respuesta:

    {
      "message": "Overdue tolerance updated successfully"
    }

  • Respuestas de Error:

    • 401: No autorizado - Sesión o token CSRF inválido
    • 400: Se requiere overdue_tolerance
    • 500: Error del servidor al actualizar la tolerancia de vencimiento

  • Notas:

    • Actualiza la configuración de tolerancia de vencimiento (acepta formato de cadena como "1h", "2h", etc.; el valor predeterminado para nuevas instalaciones es 2h)
    • Afecta cuándo se consideran vencidas las copias de seguridad
    • Utilizado por el verificador de copias de seguridad vencidas

Seguridad de APIs Externas - /api/configuration/external-api-security​

  • Endpoint: /api/configuration/external-api-security

  • Métodos: GET, PATCH

  • Descripción: Lee o actualiza si las APIs externas requieren una clave, además del tamaño de /api/upload y límites de velocidad.

  • Autenticación: Requiere privilegios de administrador, sesión válida y token CSRF

  • Cuerpo PATCH:

    {
      "requireApiKey": false,
      "uploadLimits": {
        "enabled": true,
        "maxBytes": 5242880,
        "perMinute": 20,
        "perHour": 200
      }
    }

Lista de IPs permitidas - /api/configuration/ip-allowlist​

  • Endpoint: /api/configuration/ip-allowlist
  • Métodos: GET, PATCH
  • Descripción: Lee o actualiza proxies de confianza y listas CIDR de permitidos para administrador / API externa. Habilitar la lista de administrador falla a menos que la IP del cliente actual ya esté en la lista (loopback está exento).
  • Autenticación: Requiere privilegios de administrador, sesión válida y token CSRF