Authentication with Token

A Web API access token can be used to send Web API requests. This in an alternative to authenticating with a username and password, and can be useful if you need to execute individual API requests, as the token is sent alone with the request as a part of the request header.

To obtain a Web API token, open the Virola Client main menu and go to Tools -> Web API Access Token

The token links your user profile with the Web API calls you make, so all calls will be performed on your behalf.

Note! Once you generate a new token, any previously generated token will stop working.

Example Web API request with token authentication, sent using curl:

curl -k -X GET \
    -H "Authorization: Bearer TOKEN" \
    https://HOST:PORT/api/v1/server-health

Related Endpoints

• POST /api/v1/login - Start a new session
• GET /api/v1/logout - Terminate the current session
• GET /api/v1/status - Check if session is active

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