System status

System status

DESC
The status endpoint returns almost all data around the current system status, load, system health, thermal and fan sensors (if any), memory use, battery state, runtime, and more.
ROLES
readonly
URI
/system/status.json
/system/status.ekjson
/system/status.prettyjson
METHODS
GET POST
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.

fields field simplification OPTIONAL

Kismet can reduce the amount of information being processed and returned by an API by simplifying the fields to only return the data needed by the caller.

You can read more about the field simplification API and how to use it here.

RETURN
JSON object of system status snapshot.
RESPONSES
200
Basic success and JSON object
ERROR
On error (typically for malformed simplification)

Timestamp

DESC
Fetch the system timestamp as a second and microsecond; this can be used to synchronize timestamps with the UI or as a keep-alive check.
ROLES
readonly
URI
/system/timestamp.json
/system/timestamp.ekjson
/system/timestamp.prettyjson
METHODS
GET
RETURN
JSON object of the timestamp as second and microsecond.
RESPONSES
200
JSON object

Tracked fields

DESC

To aid in development, Kismet maintains a list of all known field names, data types, and descriptions.

This endpoint returns a human-readable HTML page of all fields.

ROLES
readonly
URI
/system/tracked_fields.html
METHODS
GET
RETURN
HTML document
RESPONSES
200
HTML document

Packet statistics

DESC

Kismet exposes the packet processing statistics as RRD (round robin database) collections for incoming packet rate, packet proessing rates, data size, and more.

The RRD format encodes long-running data as collections of decreasing accuracy, reporting the past 60 seconds, past hour as 60 second averages, and past day as 1 hour averages.

ROLES
readonly
URI
/packetchain/packet_stats.json
/packetchain/packet_stats.ekjson
/packetchain/packet_stats.prettyjson
METHODS
GET POST
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.

fields field simplification OPTIONAL

Kismet can reduce the amount of information being processed and returned by an API by simplifying the fields to only return the data needed by the caller.

You can read more about the field simplification API and how to use it here.

RETURN
JSON object of RRD packet stats.
RESPONSES
200
JSON object
ERROR
On error (typically for malformed simplification)

Dynamic Javascript import

DESC

Kismet creates a dynamically generated javascript file for the UI to load the core system and JS plugin modules into the global JS namespace.

This endpoint is meant to be used by a web-based UI and included as a script import, such as:

<script src="dynamic.js"></script>
ROLES
readonly
URI
/dynamic.js
METHODS
GET
RESPONSES
200
Success

User status

DESC
The user Kismet is running as. This endpoint does not require a login, so a UI can warn about Kismet running as root before the user logs in.
ROLES
none
URI
/system/user_status.json
/system/user_status.ekjson
/system/user_status.prettyjson
METHODS
GET POST
RETURN
JSON object containing kismet.system.user, the system user Kismet is running as.
RESPONSES
200
Success

Incoming packet rate

DESC

RRD (round robin database) record of every packet received by Kismet, including packets which are later dropped.

This is one of the RRDs included in the packet statistics; see the RRD documentation for the RRD format.

ROLES
readonly
URI
/packetchain/packet_rate.json
/packetchain/packet_rate.ekjson
/packetchain/packet_rate.prettyjson
METHODS
GET POST
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.

fields field simplification OPTIONAL

Kismet can reduce the amount of information being processed and returned by an API by simplifying the fields to only return the data needed by the caller.

You can read more about the field simplification API and how to use it here.

RETURN
JSON RRD record, in packets per second; the hour and day records are averages.
RESPONSES
200
Success

Incoming packet peak rate

DESC

RRD (round robin database) record of every packet received by Kismet, including packets which are later dropped.

This is one of the RRDs included in the packet statistics; see the RRD documentation for the RRD format.

ROLES
readonly
URI
/packetchain/packet_peak.json
/packetchain/packet_peak.ekjson
/packetchain/packet_peak.prettyjson
METHODS
GET POST
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.

fields field simplification OPTIONAL

Kismet can reduce the amount of information being processed and returned by an API by simplifying the fields to only return the data needed by the caller.

You can read more about the field simplification API and how to use it here.

RETURN
JSON RRD record, in packets per second; the hour and day records are the peak per-second rate in each minute and hour, rather than averages.
RESPONSES
200
Success

Processed packet rate

DESC

RRD (round robin database) record of packets which have been fully processed.

This is one of the RRDs included in the packet statistics; see the RRD documentation for the RRD format.

ROLES
readonly
URI
/packetchain/packet_processed.json
/packetchain/packet_processed.ekjson
/packetchain/packet_processed.prettyjson
METHODS
GET POST
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.

fields field simplification OPTIONAL

Kismet can reduce the amount of information being processed and returned by an API by simplifying the fields to only return the data needed by the caller.

You can read more about the field simplification API and how to use it here.

RETURN
JSON RRD record, in packets per second; the hour and day records are averages.
RESPONSES
200
Success

Error packet rate

DESC

RRD (round robin database) record of processed packets marked as errors, such as corrupt or undecodable frames. Packets with an invalid checksum are not counted as errors.

This is one of the RRDs included in the packet statistics; see the RRD documentation for the RRD format.

ROLES
readonly
URI
/packetchain/packet_error.json
/packetchain/packet_error.ekjson
/packetchain/packet_error.prettyjson
METHODS
GET POST
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.

fields field simplification OPTIONAL

Kismet can reduce the amount of information being processed and returned by an API by simplifying the fields to only return the data needed by the caller.

You can read more about the field simplification API and how to use it here.

RETURN
JSON RRD record, in packets per second; the hour and day records are averages.
RESPONSES
200
Success

Duplicate packet rate

DESC

RRD (round robin database) record of processed packets identified as duplicates, such as the same packet received by multiple datasources.

This is one of the RRDs included in the packet statistics; see the RRD documentation for the RRD format.

ROLES
readonly
URI
/packetchain/packet_dupe.json
/packetchain/packet_dupe.ekjson
/packetchain/packet_dupe.prettyjson
METHODS
GET POST
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.

fields field simplification OPTIONAL

Kismet can reduce the amount of information being processed and returned by an API by simplifying the fields to only return the data needed by the caller.

You can read more about the field simplification API and how to use it here.

RETURN
JSON RRD record, in packets per second; the hour and day records are averages.
RESPONSES
200
Success

Dropped packet rate

DESC

RRD (round robin database) record of packets dropped because the packet processing queue was full. The queue size is set by packet_backlog_limit in kismet_memory.conf.

This is one of the RRDs included in the packet statistics; see the RRD documentation for the RRD format.

ROLES
readonly
URI
/packetchain/packet_drop.json
/packetchain/packet_drop.ekjson
/packetchain/packet_drop.prettyjson
METHODS
GET POST
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.

fields field simplification OPTIONAL

Kismet can reduce the amount of information being processed and returned by an API by simplifying the fields to only return the data needed by the caller.

You can read more about the field simplification API and how to use it here.

RETURN
JSON RRD record, in packets per second; the hour and day records are averages.
RESPONSES
200
Success