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.

Status - Service List

Request URL: /rest/status/service

• GET - lists information about services.
• PUT, POST, DELETE - unimplemented.

The URL parameters includes the service object filtering parameters. These are also available:

• downtime_start_time & downtime_comment - filter based on downtime that matches these conditions.
• filter - either handled or unhandled. Filters services by this condition.
• host_filter - either handled or unhandled. Filters host by this condition.
• state - filters by services in this state. Expects the numeric ID for state. Can be repeated.
• state_type - filters by service state type. Expects either 0 (soft) or 1 (hard). Defaults to both.
• host_state - Numeric state value. Can be repeated. If includehosts=0 (default), then the host state of each service must be in this state (AND condition). If includehosts=1, then either services are in the chosen state, or any host are in this chosen state (OR condition)
• host_state_type - filters by host state type. Expects either 0 (soft) or 1 (hard). Defaults to both.
• includeperfdata - if set, will add data re: the performance metrics for services that have performance information.
• convertuom - if set, will convert performance data into base units. Eg, if value=1500 and uom=MB, with this flag set, will return value=1500000000 uom=bytes.
• includehandleddetails - if set, will include acknowledgement information.
• includehosts - Default 0. If set, this will change the ordering by state to the order below. Also, it will change the filter=unhandled/handled to include hosts specifically. NOTE: When includehosts is set, each host could have services = [], which means this is a host only object. Note, this parameter can change the definition of host_state
• type - only applicable when includehosts=1. Set to either “host” or “service”. If not set, will assume both. If set more than once, the first value is used
• rows - returns this number of rows. Set to all to get all results. Defaults to all.
• page - returns this page number if rows is set to a number. Defaults to 1st page.
• include_allrows - if set and page is set, this will return summary.allrows which will be the total number of rows based on the filtering parameters. Default no.
• recheck=1 - the response will filter only the objects that can be rechecked (default: 0)
• order - can order the results. Can be repeated. Valid values (you can suffix with _desc to order descending):
  • state - orders by service state.
    • If includehosts=0, host states have priority (DOWN, UNREACHABLE, UP, CRITICAL, WARNING, UNKOWN, OK)
    • If includehosts=1, then states are intermingled by priority (so DOWN, CRITICAL, WARNING, UNREACHABLE, UNKNOWN, UP, OK)
  • service - orders by service name
  • host - orders by host name
  • host_state - orders by host state
  • last_check - orders by last check time
  • last_state_change - orders by last state change time
  • state_duration - orders by most recent state changes first

Example output Copied

Note

The host portion can have two additional keys regarding Monitoring Collector or Cluster health. For more details, see Host Summary.

The following attributes will only be returned if true for a host or service. If the attribute does not exist, you can assume that the values are 0:

• acknowledged — 1.
• flapping — 1.

Note

The format of the last_check field has changed to being epoch seconds. To have the old behaviour, use the URL parameter of format_datetime=1.