- 2 minutes to read

MaintenanceMode - System Parameter

MaintenanceMode is a flag for the Nodinite Web API. When it is true, the Web API stops loading plugins and reports maintenance status. It does not pause the Logging Service or the Monitoring Service, and it does not suppress alerts.

At a Glance

Property Value
Key MaintenanceMode
Data type boolean
Default false
Read by Web API
Takes effect Within about 15 seconds; no restart needed
Status ✅ Active

How It Works

Set the flag through the Web API with PUT api/SystemParameters/MaintenanceMode; the call needs the Administrator Role (see Manage System Parameters).

Value Behaviour
false (default) ✅ The Web API loads plugins as usual.
true ⚠️ The Web API stops loading plugins and reports maintenance status.

The flag is not the same as the Maintenance Mode option of User Notifications, and it doesn't replace the steps below.

You want to… Use
Pause the Logging Service and the Monitoring Service, for example during a Log Database update The Stop Services button in the Update Guide on the Log Databases page (see Update Log Database – Step 1)
Tell users about planned maintenance and suppress alerts from Monitor Views during a maintenance window A User Notification with the Maintenance Mode option
Make the Web API skip loading plugins and report maintenance status MaintenanceMode = true

Note

Nodinite v6 and its Install and Update Tool, which also set this flag during updates, are no longer supported.

Next Steps