Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

API docs update #3208

Merged
merged 1 commit into from
Jan 29, 2025
Merged

API docs update #3208

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions docs/source/platform-features/web-api/introduction.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
---------------
Expand Down
Loading