Module summary

Audit module is the most important module, it provides user management, licensing and auditing services to the other modules. It automatically recognizes other modules, that are running on the same machine or on different servers - either using multicast or IP white list.

Audit module is the main communication channel for the BellaDati IoT console too.

See Audit configuration to learn more about all configuration options.

Roles

This module supports following roles:

Verticle Role Permitted operations
Instance ADMIN All operations in all modules
Audit VIEWER GET /status, GET /modules, GET /module, GET /sensors

Module states

This module can have one of following statuses:

Verticle Status Description
Audit UP Module is up and running. It operates without any specific limitations.
PAUSED Module is paused but it operates without any specific limitations. Request to "GET /" ends with response code 405.

API endpoints

This module provides following HTTP endpoints:

Path Method Description URL Parameters Example
/ GET Returns plain text with ECHO message (should be used in load balancer to detect UP/DOWN status)   https://localhost:8000/
/status GET Returns JSON object that contains internal state of audit verticle (e.g. total count of sensors)   https://localhost:8000/status
/modules GET Returns JSON array that contains all modules registered in service discovery infrastructure   https://localhost:8000/modules
/module GET Returns status and configuration of the module specified by it's name
  • name = module_name
 https://localhost:8000/module?name=Receiver_01
/module POST Sets the configuration to the module specified by name. ADMIN role is required.
  • name = module_name
  • POST body content = config in JSON format
 https://localhost:8000/module?name=Receiver_01
/reload POST Forces reloading configuration of module specified by name. ADMIN role is required.
  • name = module_name
 https://localhost:8000/reload?name=Receiver_01
/config POST Post new config to the module specified by name
  • name = module_name
 https://localhost:8000/config?name=Receiver_01
/logs GET Retrieves the current log entries for audit or for specified module
  • (optional) name = module_name
 https://localhost:8000/logs?name=Receiver_01
/sensors GET Returns JSON array that contains status of all sensors
  • order = "ASC" / "DESC" (default: "ASC")
  • start = from timestamp (default: 0)
  • stop = to timestamp
  • receiver_id = receiver identification
  • sensor_id = sensor identification
  • limit = page size (default: 100)
 https://localhost:8000/sensors
/pause GET Sets status PAUSED for audit verticle immediately. Returns response from "GET /status" endpoint (see above)   https://localhost:8000/pause
/resume GET Sets status UP for audit verticle immediately. Returns response from "GET /status" endpoint (see above)   https://localhost:8000/resume
/logout GET Executes logout of currently logged in user   https://localhost:8000/logout

On this page

  • No labels