Virola Web API

The Virola Web API is currently under development. We add information about implemented endpoints and requests as soon as they become available on the Virola Server.

The Virola Web API has two main purposes:

• Integration with external tools
• Creating basic web-based Virola Client

All Web API requests are sent to a specific Virola Server using its host name and port number.

Most requests require authentication, either with a username and password or with a Web API token.

All available Web API calls

• Authentication with token – suitable for individual requests
• Authentication with a username and password – suitable for maintaining a session to send multiple requests
• Login with username and password – suitable for individual requests
• Logout the current user – terminate the current session
• Getting user status – check the current user's authentication and session status
• Users API – retrieve user information
• Rooms API – retrieve room information
• Messages API – retrieve and send messages
• Comments API – retrieve and send comments on messages
• Attachments API – manage message attachments
• Events API – receive real-time updates about changes on the server
• Permissions API – retrieve user permissions in rooms
• Server Health API – check the health status of the Virola Server