Ir al contenido principal

Resumen de la API

Este documento describe todos los puntos finales de la API disponibles para la aplicación duplistatus. La API sigue principios RESTful y proporciona capacidades completas de monitoreo de copias de seguridad, gestión de notificaciones y administración del sistema.

Estructura de la API​

Para una referencia rápida de todos los puntos finales, consulte la Lista de puntos finales de la API.

La API está organizada en grupos lógicos:

Para una referencia rápida de todos los puntos finales, consulte la Lista de puntos finales de la API.

Formato de respuesta​

Todas las respuestas de la API se devuelven en formato JSON con patrones consistentes de manejo de errores. Las respuestas exitosas incluyen típicamente un campo status, mientras que las respuestas de error incluyen los campos error y message.

Manejo de errores​

Todos los puntos finales siguen un patrón consistente de manejo de errores:

  • 400 Solicitud incorrecta: Datos de solicitud no válidos o campos obligatorios faltantes
  • 401 No autorizado: Sesión no válida o faltante, sesión expirada o falló la validación del token CSRF
  • 403 Prohibido: Operación no permitida (por ejemplo, eliminación de copia de seguridad en producción) o falló la validación del token CSRF
  • 404 No encontrado: Recurso no encontrado
  • 409 Conflicto: Datos duplicados (para puntos de acceso de carga)
  • 500 Error interno del servidor: Errores del lado del servidor con mensajes de error detallados
  • 503 Servicio no disponible: Fallos en la comprobación de estado, problemas de conexión a la base de datos o servicio Cron no disponible

Las respuestas de error incluyen:

  • error: Mensaje de error legible para humanos
  • message: Detalles técnicos del error (en modo desarrollo)
  • stack: Traza del error (en modo desarrollo)
  • timestamp: Cuándo ocurrió el error

Notas sobre tipos de datos​

Arrays de mensajes​

Los campos messages_array, warnings_array y errors_array se almacenan como cadenas JSON en la base de datos y se devuelven como arrays en las respuestas de la API. Estos contienen los mensajes reales de registro, advertencias y errores de las operaciones de copia de seguridad de Duplicati.

Copias de seguridad disponibles​

El campo available_backups contiene un array de marcas de tiempo de versiones de copia de seguridad (en formato ISO) disponibles para restauración. Esto se extrae de los mensajes de registro de la copia de seguridad.

Campos de duración​

  • duration: Formato legible para humanos (por ejemplo, "00:38:31")
  • duration_seconds: Duración bruta en segundos
  • durationInMinutes: Duración convertida a minutos con fines de representación gráfica

Campos de tamaño de archivo​

Todos los campos de tamaño de archivo se devuelven en bytes como números, no como cadenas formateadas. La interfaz es responsable de convertir estos valores a formatos legibles (KB, MB, GB, etc.).


precaución

No exponga el servidor duplistatus a Internet público. Úselo en una red segura (por ejemplo, una LAN local protegida por un firewall).

Exponer la interfaz duplistatus a Internet público sin medidas de seguridad adecuadas podría provocar acceso no autorizado.