HTTP Interface v1 Devices

Jump to bottom

Peter Wood edited this page Dec 19, 2020 · 4 revisions

GET: /api/v1/devices

The devices endpoint returns a list of all devices on the controller.

GET: /api/v1/devices/<identifier>

Shows an individual device.

PATCH: /api/v1/devices/<identifier>

Update metadata about the device, specific to the controller.

{
    "Name": <custom friendly name for device>
}

POST: /api/v1/devices/<identifier>/capabilities/<capability>/<action>

Submits a action to be executed by the capability/action it was directed at, the body must match that expected by the action.