API Log

Vue d’ensemble

L’API Log permet de consulter et de telecharger les fichiers journaux de Fess. Vous pouvez obtenir la liste des fichiers journaux generes sur le serveur et telecharger individuellement chaque fichier journal.

URL de base

/api/admin/log

Authentification

Comme pour les autres API Admin, une authentification par jeton d’acces est requise. Le jeton d’acces doit disposer de la permission Radmin-api (configuree via api.admin.access.permissions, valeur par defaut : Radmin-api). Indiquez le jeton d’acces dans l’en-tete de la requete.

Authorization: Bearer <jeton d'acces>

Pour plus de details sur l’authentification et l’obtention d’un jeton d’acces, consultez Vue d’ensemble de l’API Admin.

Liste des endpoints

Methode Chemin Description
GET /files Obtention de la liste des fichiers journaux
GET /file/{id} Telechargement d’un fichier journal

Obtention de la liste des fichiers journaux

Renvoie la liste des fichiers journaux (.log et .log.gz) presents dans le repertoire de sortie des journaux du serveur. Les fichiers sont retournes tries par ordre croissant de nom de fichier.

Requete

GET /api/admin/log/files

Reponse

files contient un tableau d’objets representant les informations de chaque fichier journal, et total contient le nombre d’elements. Chaque objet possede les champs suivants.

Champ Description
id Valeur du nom de fichier encode en Base64 URL (utilisee comme {id} lors du telechargement)
name Nom du fichier journal
lastModified Date et heure de derniere modification 
{
  "response": {
    "version": "15.7.0",
    "status": 0,
    "files": [
      {
        "id": "ZmVzcy5sb2c=",
        "name": "fess.log",
        "lastModified": "2025-01-01T00:00:00.000+00:00"
      },
      {
        "id": "ZmVzcy1jcmF3bGVyLmxvZw==",
        "name": "fess-crawler.log",
        "lastModified": "2025-01-01T00:00:00.000+00:00"
      }
    ],
    "total": 2
  }
}

Note

version contient la version du produit Fess en cours d’execution. Le contenu de files et le nombre d’elements varient selon les fichiers journaux presents sur le serveur ; l’exemple ci-dessus est fourni a titre indicatif.

Telechargement d’un fichier journal

Telecharge le contenu du fichier journal specifie. Pour {id}, indiquez tel quel l”id retourne lors de l’obtention de la liste (la valeur du nom de fichier encodee en Base64 URL). La reponse est renvoyee sous forme de flux application/octet-stream. Pour des raisons de securite, seuls les noms se terminant par .log ou .log.gz sont acceptes ; les noms contenant des sequences de manipulation de chemin telles que .. sont rejetes. Si vous specifiez un nom de fichier inexistant ou un nom non autorise en tant que fichier journal, une reponse vide est renvoyee.

Requete

GET /api/admin/log/file/{id}

Reponse

Flux binaire du fichier journal (Content-Type: application/octet-stream).

Exemples d’utilisation

Obtention de la liste des fichiers journaux

curl -X GET "http://localhost:8080/api/admin/log/files" \
     -H "Authorization: Bearer YOUR_TOKEN"

Telechargement d’un fichier journal

curl -X GET "http://localhost:8080/api/admin/log/file/ZmVzcy5sb2c=" \
     -H "Authorization: Bearer YOUR_TOKEN" \
     -o fess.log

Informations complementaires