GPS

Available GPS drivers

DESC
Fetch a list of supported GPS driver types
ROLES
readonly
URI
/gps/drivers.json
/gps/drivers.ekjson
/gps/drivers.prettyjson
METHODS
GET

List configured GPS devices

DESC
Fetch a list of all configured GPS devices
ROLES
readonly
URI
/gps/all_gps.json
/gps/all_gps.ekjson
/gps/all_gps.prettyjson
METHODS
GET

Add a GPS device

DESC
Add a new GPS to Kismet
ROLES
admin
URI
/gps/add_gps.cmd
METHODS
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.

definition string REQUIRED

GPS configuration line

RESPONSES
200
GPS successfully removed
ERROR
GPS could not be added, for example due to an invalid definition line

Remove a GPS device

DESC
Disable and remove a GPS device from the system
ROLES
admin
URI
/gps/by-uuid/{UUID}/remove_gps.cmd
METHODS
POST
URI
PARAMETERS
UUID string REQUIRED

UUID of GPS device to be removed

RESPONSES
200
GPS successfully removed
ERROR
GPS could not be removed, likely due to an invalid UUID

Current location

DESC

Fetch the current “best” location from all enabled GPS devices. The “best” location is the most recent location with the highest precision.

Most configurations will have a single GPS so the “best” will always be that device.

A more efficient approach is to use the eventbus endpoint subscribed to the GPS event.

ROLES
readonly
URI
/gps/location.json
/gps/location.ekjson
/gps/location.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.

Current location (all GPS devices)

DESC

Fetch the current location from all enabled GPS devices.

A more efficient approach is to use the eventbus endpoint subscribed to the GPS event.

ROLES
readonly
URI
/gps/all_locations.json
/gps/all_locations.ekjson
/gps/all_locations.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.

Per-receiver GPS location

DESC

Fetch the current location of a specific GPS, identified by UUID.

A more efficient approach is to use the eventbus endpoint subscribed to the GPS event.

ROLES
readonly
URI
/gps/by-uuid/{UUID}/location.json
/gps/by-uuid/{UUID}/location.ekjson
/gps/by-uuid/{UUID}/location.prettyjson
METHODS
GET POST
URI
PARAMETERS
UUID string REQUIRED

UUID of GPS device

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.

Web GPS

DESC
Kismet supports GPS data from a web event. Typically this data would be provided by the browser via the location API, but could also be submitted to Kismet from other GPS devices.
ROLES
admin WEBGPS
URI
/gps/web/update.cmd
METHODS
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.

lat number OPTIONAL

Latitude in decimal degrees

lon number OPTIONAL

Longitude in decimal degrees

alt number OPTIONAL

Altitude in meters

spd number OPTIONAL

Speed, in kilometers per hour

Web GPS (websocket)

DESC
Update the web GPS via a persistent websocket. Updates can be pushed without having to create a new connection per update.
ROLES
admin WEBGPS
ADDED
API added 2021-08
URI
/gps/web/update.ws
METHODS
WEBSOCKET UPGRADE
URI
PARAMETERS
user string OPTIONAL

Login user ID; most websocket client APIs do not support basic-auth, cookies, or other header-based login methods.

You must provide either user and password GET variables, or an API token or logins ession token via the KISMET GET variable.

password string OPTIONAL

Password associated with the user.

You must provide either user and password GET variables, or an API token or logins ession token via the KISMET GET variable.

KISMET string OPTIONAL

An API key or session token key.

You must provide either user and password GET variables, or an API token or logins ession token via the KISMET GET variable.

API

The Web GPS websocket endpoint accepts continual JSON objects updating the GPS location.

lat number REQUIRED

Latitude in decimal degrees

lon number REQUIRED

Longitude in decimal degrees

alt number OPTIONAL

Altitude in meters

spd number OPTIONAL

Speed in kilometers per hour

Meta GPS

DESC

A meta-GPS device is very similar to a web GPS device, but has no defiend backend driver.

A meta-GPS device is linked to a remote capture instance, and is defined by using the metagps=... source option.

This endpoint allows a GPS tool running alongside remote cap to update the GPS location for packets from the associated remote.

ROLES
admin WEBGPS
ADDED
API added 2022-01-R3
URI
/gps/meta/{NAME}/update.cmd
METHODS
POST
URI
PARAMETERS
NAME string REQUIRED

Meta GPS device name

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.

lat number OPTIONAL

Latitude in decimal degrees

lon number OPTIONAL

Longitude in decimal degrees

alt number OPTIONAL

Altitude in meters

spd number OPTIONAL

Speed, in kilometers per hour

Meta GPS (websocket)

DESC

A meta-GPS device is very similar to a web GPS device, but has no defiend backend driver.

A meta-GPS device is linked to a remote capture instance, and is defined by using the metagps=... source option.

This endpoint allows a GPS tool running alongside remote cap to update the GPS location for packets from the associated remote.

ROLES
admin WEBGPS
ADDED
API added 2022-01-R3
URI
/gps/meta/{NAME}/update.ws
METHODS
WEBSOCKET UPGRADE
URI
PARAMETERS
NAME string REQUIRED

Meta GPS device name

user string OPTIONAL

Login user ID; most websocket client APIs do not support basic-auth, cookies, or other header-based login methods.

You must provide either user and password GET variables, or an API token or logins ession token via the KISMET GET variable.

password string OPTIONAL

Password associated with the user.

You must provide either user and password GET variables, or an API token or logins ession token via the KISMET GET variable.

KISMET string OPTIONAL

An API key or session token key.

You must provide either user and password GET variables, or an API token or logins ession token via the KISMET GET variable.

API

The meta-GPS websocket endpoint accepts continual JSON objects updating the GPS location.

lat number REQUIRED

Latitude in decimal degrees

lon number REQUIRED

Longitude in decimal degrees

alt number OPTIONAL

Altitude in meters

spd number OPTIONAL

Speed in kilometers per hour