Passer au contenu principal

Aperçu de l'API

Ce document décrit tous les points de terminaison d'API disponibles pour l'application duplistatus. L'API suit les principes RESTful et offre des fonctionnalités complètes de surveillance des sauvegardes, de gestion des notifications et d'administration du système.

Structure de l'API​

Pour une référence rapide de tous les points de terminaison, consultez la Liste des points de terminaison de l'API.

L'API est organisée en groupes logiques :

Pour une référence rapide de tous les points de terminaison, consultez la Liste des points de terminaison de l'API.

Format des réponses​

Toutes les réponses de l'API sont renvoyées au format JSON avec des modèles cohérents de gestion des erreurs. Les réponses réussies incluent généralement un champ status, tandis que les réponses d'erreur incluent les champs error et message.

Gestion des erreurs​

Tous les points de terminaison suivent un modèle cohérent de gestion des erreurs :

  • 400 Bad Request : Données de requête non valides ou champs obligatoires manquants
  • 401 Unauthorized : Session non valide ou manquante, session expirée ou échec de validation du jeton CSRF
  • 403 Forbidden : Opération non autorisée (par ex., suppression de sauvegarde en production) ou échec de validation du jeton CSRF
  • 404 Not Found : Ressource introuvable
  • 409 Conflict : Données en double (pour les points de terminaison de téléversement)
  • 413 Payload Too Large : Le corps /api/upload dépasse la taille maximale configurée
  • 429 Too Many Requests : Limite de débit dépassée pour le téléversement, la lecture de l'API ou les échecs d'authentification
  • 500 Internal Server Error : Erreurs côté serveur avec messages d'erreur détaillés
  • 503 Service Unavailable : Échecs du contrôle d'intégrité, problèmes de connexion à la base de données ou service cron indisponible

Les réponses d'erreur comprennent :

  • error : Message d'erreur lisible par l'utilisateur
  • message : Détails techniques de l'erreur (en mode développement)
  • stack : Trace de la pile d'erreurs (en mode développement)
  • timestamp : Moment où l'erreur s'est produite

Remarques sur les types de données​

Tableaux de messages​

Les champs messages_array, warnings_array et errors_array sont stockés sous forme de chaînes JSON dans la base de données et renvoyés sous forme de tableaux dans les réponses de l'API. Ils contiennent les messages de journal réels, les avertissements et les erreurs issus des opérations de sauvegarde Duplicati.

Sauvegardes disponibles​

Le champ available_backups contient un tableau d'horodatages de versions de sauvegarde (au format ISO) qui sont disponibles pour la restauration. Il est extrait des messages de journal de sauvegarde.

Champs de Durée​

  • duration : Format lisible par l'homme (par ex. « 00:38:31 »)
  • duration_seconds : Durée brute en secondes
  • durationInMinutes : Durée convertie en minutes à des fins de création de graphiques

Champs de Taille de fichier​

Tous les champs de taille de fichier sont renvoyés en octets sous forme de nombres, et non de chaînes formatées. Le frontend est chargé de les convertir dans des formats lisibles par l'homme (Ko, Mo, Go, etc.).


attention

N'exposez pas le serveur duplistatus à l'Internet public. Utilisez-le sur un réseau sécurisé (par exemple, un réseau local protégé par un pare-feu).

Exposer l'interface duplistatus à l'Internet public sans mesures de sécurité appropriées pourrait entraîner un accès non autorisé.