You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 14 Next »

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:

VerticleRolePermitted operations
InstanceADMINAll operations in all modules
AuditVIEWERGET /status, GET /modules, GET /module, GET /sensors

Module states

This module can have one of following statuses:

VerticleStatusDescription
AuditUPModule is up and running. It operates without any specific limitations.
PAUSEDModule 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:

PathMethodDescriptionURL ParametersExample
/GETReturns plain text with ECHO message (should be used in load balancer to detect UP/DOWN status) https://localhost:8000/
/statusGETReturns JSON object that contains internal state of audit verticle (e.g. total count of sensors) https://localhost:8000/status
/modulesGETReturns JSON array that contains all modules registered in service discovery infrastructure https://localhost:8000/modules
/moduleGETReturns status and configuration of the module specified by it's name
  • name = module_name
https://localhost:8000/module?name=Receiver_01
/modulePOSTSets 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
/reloadPOSTForces reloading configuration of module specified by name. ADMIN role is required.
  • name = module_name
https://localhost:8000/reload?name=Receiver_01
/configPOSTPost new config to the module specified by name
  • name = module_name
https://localhost:8000/config?name=Receiver_01
/logsGETRetrieves the current log entries for audit or for specified module
  • (optional) name = module_name
https://localhost:8000/logs?name=Receiver_01
/sensorsGETReturns 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
/pauseGETSets status PAUSED for audit verticle immediately. Returns response from "GET /status" endpoint (see above) https://localhost:8000/pause
/resumeGETSets status UP for audit verticle immediately. Returns response from "GET /status" endpoint (see above) https://localhost:8000/resume
/logoutGETExecutes logout of currently logged in user https://localhost:8000/logout

On this page

  • No labels