RaftSysModAPI

Built-in REST Endpoints — SysMods

This page lists REST endpoints exposed by the standard Raft SysMods (publish/subscribe, etc.). For endpoints exposed by the framework core see Built-in REST Endpoints — Raft Core. The full alphabetical list is at Raft Full API List.

To register your own endpoints from a SysMod, see Adding REST API Endpoints.

URL	Verb	Description	e.g. req	e.g. resp
subscription	GET	Setup subscriptions to information published. The kind of information is selected by the “name” field in the “pubRecs” array. Information from the “rateHz” field to specify a non-zero publish rate in Hz. To disable subscriptions specify a “rateHz” value of zero for the specific type of information. Note that subscriptions operate “by channel” which means that subscriptions on a BLE connection can be different than on a WiFi connection. Note that subscriptions on BLE (and Micropython subsystems if present) are turned on by default but all other subscriptions must be turned on for the specific channel.	subscription?action=update&name=Status&rateHz=10.0	{"req":"subscription?action=update&name=Status&rateHz=10.0","rslt":"ok"}