VDATP REST API

Reference for the VDATP REST API

The VDATP units can be controlled via a REST API.

REST and the GUI

Note that changes made via REST API are not reflected in the GUI.

The APIs are described in the OpenAPI spec below - unfortunately the Try it out option doesn’t work as the Pi isn’t listening to a publicly accessible address. However, you can use Bruno, the nice Postman replacement tool, to test out the APIs and generate code specific to your environment. Simply import the Bruno API collection into Bruno and try out all REST calls available.

You will also have to change the {baseURL} variable to point to your local VDATP:

Network Security

These APIs are not authenticated - please ensure you install your VDATP on a secure network.

The diagram below shows how the transducers are named.