Logging

Kismet has a centralized logging engine which supports many formats of logs.

Streaming logs like PCAP-NG also integrate with the streams API

List available log types

DESC

Fetch a list of all available log drivers.

Each logging driver handles a log output format.

ROLES
readonly
URI
/logging/drivers.json
/logging/drivers.ekjson
/logging/drivers.prettyjson
METHODS
GET

List active logs

DESC
List enabled and active logs
ROLES
readonly
URI
/logging/active.json
/logging/active.ekjson
/logging/active.prettyjson
METHODS
GET

Start a log

DESC
Open a new log; if the same type of log is closed and opened multiple times in one session, it will have multipe log instances (such as Kismet-foo-2022-10-03-1.pcap, kismet-foo-2022-10-03-2.pcap )
ROLES
URI
/logging/by-class/{LOGCLASS}/start.cmd
METHODS
GET POST
URI
PARAMETERS
LOGCLASS string REQUIRED

Log class / type to start

JSON
PARAMETERS

This endpoint takes additional parameters by using a `POST` request and supplying a JSON document or json form variable.

You can find more information about API parameters here.

title string OPTIONAL

Alternate file name / log title

RETURN
Success or failure of log opening.
RESPONSES
200
Success
ERROR
Request error, such as malformed log class or permissions error
NOTES
Some logs, like kismetdb, are only permitted a single logging instance.

Stopping a log

DESC
Stop and close a current log.
ROLES
URI
/logging/by-uuid/{UUID}/stop.cmd
METHODS
GET
URI
PARAMETERS
UUID string REQUIRED

Log UUID to stop