API for EVerest modules and clients to control the modules lifecycle. Provides facilities to (re)start and stop modules and monitor their status. Experimental. This API is exempt from the EVerest stability guarantees and the deprecation period; channels, operations and message payloads may change without further notice until it is promoted to stable.
default local MQTT
Request EVerest to stop all currently running modules.
Available only on servers:
Accepts the following message:
Request EVerest to stop all currently running modules.
Request to stop all modules
{
"headers": {
"replyTo": "arbitrary/reply/topic"
}
}
Accepts the following message:
Reply indicating the result of stopping modules.
Result when requesting to stop the modules
No modules to stop
{
"status": "NoModulesToStop"
}
Request EVerest to send its version.
Available only on servers:
Accepts the following message:
Request EVerest to send its version.
Request EVerest version
{
"headers": {
"replyTo": "arbitrary/reply/topic"
}
}
Accepts the following message:
Reply to get EVerest version request.
Version designators of the running EVerest instance
EVerest Version report
{
"name": "everest-core",
"version": "2026.02.0",
"git_version": "a1b2c3d4e5f6g7h8i9j0"
}
Request EVerest to start modules.
Available only on servers:
Accepts the following message:
Request EVerest to start modules.
Request to start modules
{
"headers": {
"replyTo": "arbitrary/reply/topic"
}
}
Accepts the following message:
Reply indicating the result of starting modules.
Result when requesting to start the modules
Modules starting
{
"status": "Starting"
}
Published when EVerest execution status changes.
Available only on servers:
Accepts the following message:
Published when EVerest execution status changes.
Execution status summary. Will include all the optional fields, if everest_running is true. A false everest_running carries no other field: the manager publishes exactly this payload when it shuts down, and registers it as its MQTT last will for the case where it dies before getting that far.
Modules stopped, configuration service available
{
"tstamp": "2026-03-30T17:45:00Z",
"everest_running": true,
"module_status": "NotRunning",
"configuration_api_available": "RW",
"lifecycle_api_ro": false
}
EVerest not running (manager shutdown, or last will on an unclean death)
{
"everest_running": false
}
Request EVerest to stop all currently running modules.
Reply indicating the result of stopping modules.
Result when requesting to stop the modules
Request EVerest to send its version.
Reply to get EVerest version request.
Version designators of the running EVerest instance
Request EVerest to start modules.
Reply indicating the result of starting modules.
Result when requesting to start the modules
Published when EVerest execution status changes.
Execution status summary. Will include all the optional fields, if everest_running is true. A false everest_running carries no other field: the manager publishes exactly this payload when it shuts down, and registers it as its MQTT last will for the case where it dies before getting that far.
Possible results for stop module requests
Possible results for start module requests
State of the modules
Result when requesting to stop the modules
Result when requesting to start the modules
Availability of the configuration_API
Execution status summary. Will include all the optional fields, if everest_running is true. A false everest_running carries no other field: the manager publishes exactly this payload when it shuts down, and registers it as its MQTT last will for the case where it dies before getting that far.
Version designators of the running EVerest instance