Skip to content

Latest commit

 

History

History
37 lines (30 loc) · 2.74 KB

README.md

File metadata and controls

37 lines (30 loc) · 2.74 KB
title REST APIs
children
conventions.md
autopilot_api.md
course_api.md
history_api.md
notifications_api.md
radar_api.md
resources_api.md
weather_api.md
ble_api.md
plugin_api.md
./proposed/README.md

REST APIs

Modular, subdomain specific REST APIs were introduced in Signal K server version 2 to provide a way for applications and plugins perform operations and ensure that the Signal K data model is consistent.

The OpenAPI definitions can be found under Documentation -> OpenAPI in the server Admin UI.

APIs available in Signal K server v2.0.0 and later:

APIs are available via /signalk/v2/api/<endpoint>

API Description Endpoint
Autopilot Provide the ability to send common commands to an autopilot via a provider plugin. vessels/self/autopilot
Course Set a course, follow a route, advance to next point, etc. vessels/self/navigation/course
History Query historical data. history
Radar View and control marine radar equipment via a provider plugin. (In development) vessels/self/radars
Resources Create, view, update and delete waypoints, routes, etc. resources
Notifications Provide the ability to raise, update and clear notifications from multiple sources. View PR notifications
BLE Unified BLE device discovery and GATT connection management via provider plugins and remote gateways. vessels/self/ble; ble (gateways)