Lire le journal par l'API publique
Récupérer depuis votre serveur les événements d'audit de votre client et de votre application, page par page, avec des filtres par action et par utilisateur.
- Required access
- Clé API ou jeton d'un utilisateur authentifié
- Duration
- 10 min
This page has not been translated yet and is shown in French.
L'API publique donne accès aux événements d'audit de votre organisation, par exemple pour les verser dans un SIEM ou produire un rapport mensuel. La lecture est toujours limitée à votre périmètre : vous ne pouvez pas l'élargir par un paramètre.
Avant de commencer
- Vous appelez l'API depuis un serveur, avec une clé API ou le jeton d'un utilisateur authentifié. L'API n'exige aucun droit particulier : c'est le périmètre qui limite ce que vous lisez.
- Le périmètre est fixé par l'appelant : son client (son réseau pour un administrateur réseau, tous les clients de l'application pour un propriétaire), et toujours l'application de la clé ou du jeton.
Lister les événements
/api/audit-logs| Paramètre | Description |
|---|---|
action | Code de l'action, par exemple USER_CREATE |
userId | Identifiant de l'auteur |
page | Page, à partir de 1 (1 par défaut) |
limit | De 1 à 100 événements par page (20 par défaut) |
curl "https://api.wakastart.app/api/audit-logs?action=USER_PROFILES_CHANGED&page=1&limit=50" \
-H "x-api-key: sk_test_exemple"type AuditEvent = {
id: string;
timestamp: string;
context: { origin: string; "app-id": string; action: string; severity: string };
description?: string;
info?: string;
ip?: string;
"user-id"?: string;
"customer-wid"?: string;
};
async function fetchAllEvents(action: string): Promise<AuditEvent[]> {
const events: AuditEvent[] = [];
for (let page = 1; ; page++) {
const url = `https://api.wakastart.app/api/audit-logs?action=${action}&page=${page}&limit=100`;
const response = await fetch(url, { headers: { "x-api-key": process.env.WAKASTART_API_KEY! } });
if (!response.ok) throw new Error(`Journal d'audit : HTTP ${response.status}`);
const body: { data: AuditEvent[]; totalPages: number } = await response.json();
events.push(...body.data);
if (page >= body.totalPages) return events;
}
}
const changes = await fetchAllEvents("USER_PROFILES_CHANGED");Réponse attendue (extrait) :
{
"data": [
{
"id": "6718f2a4c1d2e3f4a5b6c7d8",
"timestamp": "2026-10-23T08:12:04.511Z",
"context": {
"origin": "ws-serv-config",
"app-id": "aB3dE9",
"action": "USER_PROFILES_CHANGED",
"severity": "info"
},
"description": "Profils de l'utilisateur modifiés",
"ip": "203.0.113.24",
"customer-wid": "Cu9pL2"
}
],
"total": 1,
"page": 1,
"limit": 50,
"totalPages": 1
}Le champ info contient le détail de l'action, sous forme de texte JSON.
Tip
Pour un export régulier, dédoublonnez les événements par leur id. Respectez les limites de débit : 10 requêtes par seconde, 100 par minute et 1 000 par heure par adresse IP.
Vérifier le résultat
Le total de la réponse ne compte que les événements de votre périmètre. Chaque événement porte le WID de votre application dans context.app-id.