From c8cf56f4589c8415477cab346decb7a9e0a22b11 Mon Sep 17 00:00:00 2001 From: "David M. Raker" Date: Wed, 29 Jan 2025 11:06:29 -0800 Subject: [PATCH] Documentation update to the RESTful Web API. Clarified agents which may be required to utilize the devices endpoints. --- docs/source/platform-features/web-api/introduction.rst | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/docs/source/platform-features/web-api/introduction.rst b/docs/source/platform-features/web-api/introduction.rst index 0713d0e895..de138c96d9 100644 --- a/docs/source/platform-features/web-api/introduction.rst +++ b/docs/source/platform-features/web-api/introduction.rst @@ -105,8 +105,14 @@ set to ``https://localhost:8443`` the following HTTP request (with a proper GET https://localhost:8443/vui/ -Access to the API may be disabled by removing "vui" from the list of groups in ``$VOLTTRON_HOME/web-users.json`` for any user which should not have access -to the API. +Access to the API may be disabled by removing "vui" from the list of groups in ``$VOLTTRON_HOME/web-users.json`` for +any user which should not have access to the API. + +.. Note:: + Certain features of the API require that appropriate agents be installed to handle requests. In particular, + devices endpoints require at least the Platform Driver Agent and the Actuator Agent to both be installed. + For use with BACnet devices, the BACnet Proxy Agent may also be required. Missing agents are likely to result + in timeout errors from the API as the request has been sent to an agent which is not there to respond. Path Structure ---------------