REST APIs
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 |
|---|---|---|
| Course | Set a course, follow a route, advance to next point, etc. | vessels/self/navigation/course |
| Resources | Create, view, update and delete waypoints, routes, etc. | resources |
Following is a list of proposed APIs for implementation:
| Proposed API | Description | Endpoint |
|---|---|---|
Notifications | Provide the ability to raise, update and clear notifications from multiple sources. View PR | notifications |
Autopilot | Provide the ability to send common commands to an autopilot via a provider plugin. View PR | vessels/self/steering/autopilot |
Anchor | Provide endpoints to perform operations and facilitate an anchor alarm. | vessels/self/navigation/anchor |