Consultation du journal d'accès

Description

Cette API permet de récupérer une quantité limitée de journaux d'accès dans une plage horaire définie, avec la possibilité d'appliquer des filtres optionnels.

Méthode : POST

URL : https://console.baleen.cloud/api/logs/access-logs

Authentification

L'utilisateur doit être authentifié à l'aide de son token d'accès personnel.
Le namespace de Baleen doit être défini dans le cookie baleen-namespace.

Format de la Requête

Paramètres de la requête (Query Params)

Paramètre	Requis / Optionnel	Type	Description

Paramètre	Requis / Optionnel	Type	Description
start	Optionnel	long	Timestamp (en secondes) pour commencer la collecte.
end	Optionnel	long	Timestamp (en secondes) pour terminer la collecte.
size	Optionnel	integer	Taille de la page des journaux à récupérer (1 à 100).
page	Optionnel	integer	Numéro de la page des journaux à récupérer.

Paramètres du corps de la requête (Body Params)

Object filters description : Un tableau optionnel permettant de définir des filtres pour les journaux d'accès.

Paramètre	Type	Description

Paramètre	Type	Description
field	enum	Champ ciblé pour filtrer les journaux. Valeurs possibles : `asn`, `connection_type`, `country`, `ip`, `isp`, `ja3`, `request_fate_action`, `method`, `status_code`, `triggered_rule_id`, `uri`, `user_agent`.
operator	enum	Opérateur utilisé pour filtrer les journaux. Valeurs possibles : `equals`, `not_equals`.
value	string	Valeur utilisée pour filtrer les journaux.

Format de la Réponse

Requête réussie (200 OK)

Champ	Requis / Optionnel	Type	Description

Champ	Requis / Optionnel	Type	Description
timestamp	Requis	ISO 8601 GMT	Timestamp au format ISO 8601 utilisant le système horaire 24 heures.
status	Requis	HTTP status	Code de statut de la réponse HTTP.
remoteAddr	Optionnel	IP address	Adresse IP du client ou du proxy client.
upstream	Optionnel	IP address	Adresse IP de sortie du proxy Baleen.
scheme	Requis	URI Scheme	Schéma URI.
requestFateAction	Optionnel	Baleen Action	Action de détection des bots de Baleen pour cette requête.
bodyBytesSent	Requis	Byte	Taille du corps de la requête en octets.
botCategory	Optionnel	Baleen Bot Category	Catégorie de bot assignée à cette requête.
httpHost	Requis	URL scheme	Valeur de l'en-tête Host de la requête.
httpUserAgent	Optionnel	String	Valeur de l'en-tête User-Agent de la requête.
remoteUser	Optionnel	IP address	Adresse IP du client.
requestTime	Optionnel	Duration (Seconds)	Temps de traitement de la requête en secondes.
clientIP	Requis	IP address	Adresse IP du client.
httpXForwardedFor	Optionnel	Comma separated IPs	Liste des adresses IP séparées par des virgules, identifiant l'adresse IP d'origine du client via un proxy ou un équilibre de charge.
httpReferrer	Optionnel	URL scheme	Valeur de l'en-tête Referrer de la requête.
upstreamResponseTime	Optionnel	Duration (Second)	Temps de réponse en amont pour cette requête.
requestFate	Optionnel	Baleen Action	Action de détection des bots de Baleen pour cette requête.
requestJa3	Optionnel	String	Empreinte TLS du dispositif.
sslProtocol	Requis	String	Protocole TLS du client.
serverProtocol	Requis	String	Protocole du serveur.
requestURI	Requis	URI scheme	Identifiant de ressource de la requête.
requestMethod	Requis	HTTP Method	Méthode de la requête HTTP.
requestArgs	Optionnel	String	Chaînes de requêtes URI de la requête.
requestISP	Optionnel	String	Fournisseur de service Internet du client.
requestCountry	Optionnel	String	Code de pays au format ISO3166-1.
requestConnectionType	Optionnel	String	Type de connexion du client.
requestIsAnonymousProxy	Optionnel	Boolean	Indique si la requête a été effectuée via un proxy anonyme comme un VPN.
responseContentType	Optionnel	String	Type de contenu de la réponse.

Requête échouée

400 Bad Request : La requête est incorrecte.
500 Internal Server Error : Erreur interne du serveur.

Exemple

Cet exemple montre une requête API pour récupérer les journaux des requêtes provenant de la France et ciblant le chemin “/” entre le 25 avril 2023 à 15h et le 25 avril 2023 à 20h.

Requête

POST https://console.baleen.cloud/api/logs/access-logs?start=1682427600&end=1682445600&page=0&size=100

Corps de la requête

{
  "filters": [
    {
      "field": "uri",
      "value": "/",
      "operator": "equals"
    },
    {
      "field": "country",
      "value": "FR",
      "operator": "equals"
    }
  ]
}

Réponse

[
    {
        "timestamp": "2023-04-25T17:59:59.976999998Z",
        "status": "200",
        "remoteAddr": "5.182.212.102",
        "upstream": "",
        "scheme": "https",
        "requestFateAction": "challengejs_displayed",
        "bodyBytesSent": "2263",
        "botCategory": "unknown",
        "httpHost": "www.cdiscount.com",
        "httpUserAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:109.0) Gecko/20100101 Firefox/112.0",
        "requestTime": "0.000",
        "clientIp": "89.85.86.142",
        "httpXForwardedFor": "89.85.86.142",
        "sslProtocol": "TLSv1.3",
        "serverProtocol": "HTTP/1.1",
        "requestUri": "/",
        "requestMethod": "GET",
        "requestIsp": "Bouygues Telecom",
        "requestCountry": "FR",
        "requestConnectionType": "Cable/DSL",
        "requestIsAnonymousProxy": false,
        "responseContentType": "text/html"
    },
    ...
]