Wi-Fi SSIDs

The phy80211 system in Kismet also tracks SSID broadcast, probe, and response.

These endpoints give a direct method to find all devices related to a specific SSID.

SSID view

DESC

Mirroring the device view api, the SSID summarization endpoint is the primary interface for clients to access the SSID list and for scripts to retrieve lists of SSIDs.

The SSID summarization is best utilized when applying a view window via the start and length variables.

ROLES
readonly
URI
/phy/phy80211/ssids/views/ssids.json
/phy/phy80211/ssids/views/ssids.ekjson
/phy/phy80211/ssids/views/ssids.prettyjson
METHODS
POST
POST
PARAMETERS
start number OPTIONAL

When in datatables mode, the start of the windowed view.

length number OPTIONAL

When in datatables mode, the length of the windowed view.

draw number OPTIONAL

When in datatables mode, the datatable draw sequence number.

search[value] string OPTIONAL

When in datatables mode, the search term to be applied to all fields in the summary list.

order[0][column] string OPTIONAL

When in datatables mode, the display column number for shorting, indexed by the colmap JSON data parameter.

order[0][dir] string OPTIONAL

When in datatables mode, the sort direction sent by jquery-datatables.

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.

regex regular expression OPTIONAL

When compiled with PCRE support, Kismet can apply regular expression filters.

Regular expressions can be applied to multiple fields.

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

colmap list OPTIONAL

Column map information generated by the Kismet UI for mapping jquery-datatable column information for sorting and ordering.

datatable boolean OPTIONAL

Wrap output in a container suitable for connecting to a jquery-datatable container in the web UI.

RETURN
JSON object containing the list of SSIDs and metadata for jquery-datatables.
RESPONSES
200
Basic success and JSON object
ERROR
On error (typically for malformed simplification)
NOTES
In datatables mode, this endpoint takes both a json=... command dictionary and typical FORM post variables. This is necessary to work within the datatables request structure.

SSID details

DESC

Fetch a detailed SSID object including all related device keys.

Keyed by the SSID hash (a semi-random value calculated by Kismet from the SSID content, length, and encryption options).

ROLES
readonly
ADDED
API added 2020-08
URI
/phy/phy80211/ssids/by-hash/{HASH}/ssid.json
/phy/phy80211/ssids/by-hash/{HASH}/ssid.ekjson
/phy/phy80211/ssids/by-hash/{HASH}/ssid.prettyjson
METHODS
GET POST
URI
PARAMETERS
HASH string REQUIRED

SSID hash

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.