ZeroKey

Module Management

The module interface allows hot-plugging of add-on functionality as may be needed for a given use-case. These API operations provide administrative functions for installing, licensing, and configuring modules.

Get version number info of the EventHub

SecurityOAuth2 or ApiKey
Responses
200

Response success

Response Schema: application/json
EventHubVersion
string

Indicates the current running version number of the EventHub.

401

Unauthorized access, invalid credentials were used.

get/version
Request samples 
Response samples 
application/json
{
  • "EventHubVersion": "0.2.4"
}
Get details of currently defined modules
SecurityOAuth2 or ApiKey 
Responses 
200
Response success


Response Schema: application/json
 Array 
ModuleID
string
Globally unique identifier for the module, generated upon module installation.


 
Name
string
Friendly-name of the module, provided from the module assembly through the module interface.


 
Version
string
Indicates the current build version of the module.


 
Description
string
Long description of the module's functionality.


 
ModuleFilename
string
Path to the module's package file.


 
Active
boolean
Indicates whether the module is active. Inactive modules will not be loaded.


 
Running
boolean
Indicates whether the module has started-up and is in a running state.


 
401
Unauthorized access, invalid credentials were used.


get/modules
Request samples 
Response samples 
application/json
[
  • {
    }
]
➔ Next to Historian