Opsview 6.8.x End of Support
With the release of Opsview 6.11.0 on February 2025, versions 6.8.x have reached their End of Support (EOS) status, according to our Support policy. This means that versions 6.8.x will no longer receive code fixes or security updates.
The documentation for version 6.8.9 and earlier versions will remain accessible for the time being, but it will no longer be updated or receive backports. We strongly recommend upgrading to the latest version of Opsview to ensure continued support and access to the latest features and security enhancements.
Reload - Request Format
URL: /rest/reload
GET
— gets status of reloadPOST
— initiates a synchronous reload. Returns 200 if reload completed. Will return 400 with error messages if reload fails. Will return 409 if a reload already in progressPUT
— unimplementedDELETE
— unimplemented
Requires RELOADACCESS
.
Parameters Copied
asynchronous
— if set to 1, an asynchronous reload will be run. Use a GET request to poll to see if the reload has completed. Default 0.changelog
— if a POST request and changelog is enabled, you must set the text to save otherwise an error will occur.
Returned data Copied
server_status
— this is the state of the server.0
— server running, with no warnings.1
— server reloading.2
— server not running.3
— configuration error or critical error.4
— warnings exist.
configuration_status
— this is the state of the configuration.uptodate
— all configuration changes have been applied.pending
— at least one configuration change requires a reloadaverage_duration
— number of seconds a reload normally takes, rounded up to nearest 10 seconds.lastupdated
— epoch time for last configuration update.
auditlog_entries
— number of audit log entries since last backup. This could be undefined.messages
— array of messages, where each message is a hash (or dictionary) of strings.
If a reload is already in progress then the status code will be set to 409 with returned data of:
server_status
— set to 1.messages
— set to “Reload already running”.
Examples Copied
Fetch the current status Copied
$ opsview_rest --token-file /path/to/opsview_restapi_token --pretty GET reload
{
"auditlog_entries" : "0",
"average_duration" : "30",
"configuration_status" : "uptodate",
"lastupdated" : "1519680052",
"messages" : [
{
"detail" : "Missing required variable EMAIL for contact admin for notification method Email - ignoring this notification",
"monitoringserver" : "Master Monitoring Server",
"severity" : "warning"
},
{
"detail": "Missing required variable EMAIL for contact user for notification method Email - ignoring this notification",
"severity"; "warning",
"monitoringserver" : "Master Monitoring Server",
}
],
"server_status" : "4"
}
Initiate a reload with changelog enabled Copied
$ opsview_rest --token-file /path/to/opsview_restapi_token --pretty POST "reload?changelog=Creating new users"
{
"auditlog_entries" : "0",
"average_duration" : "30",
"configuration_status" : "uptodate",
"lastupdated" : "1519680351",
"messages" : [],
"server_status" : "0"
}