REST API
Table of Contents
1. Overview
The QoE REST API provides programmatic access to device monitoring and alarm data. All endpoints are served under the /api base path and return JSON responses.
The API is documented with OpenAPI 3.0 (Swagger). The interactive Swagger UI is available at:
http://<host>:<port>/qoeUI/swagger-ui.html
2. Authentication
API requests are authenticated using username and SHA-256 hashed password provided in the request body. If no active session exists, the API authenticates the user before processing the request.
The creator field in the request body identifies the user, and the password hash is extracted from the request for authentication.
3. Device Parameter Data
Retrieves device information along with monitored parameter data.
3.2. Request Body
{
"creator": "username",
"password": "sha256-hashed-password",
"serial": "device-serial-number",
"parameters": ["param1", "param2"]
}