Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: update optional properties

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

Table of Contents

Status API 

This opCharts API provides access to Status collection data in a JSON format.

...

Authentication is required to access all methods below. See opCharts REST API Reference.

Public API for opCharts Status "http[s]://server/omk/opCharts/v2/status"

...

Property

Description

Example

id

A globally unique ID

"63576103ad794974594a1f11"

class

optional


cluster_id

The id of the NMIS poller server for the associated node

"6678b17aca40037e1139cace"

element

optional


event

The Event from the Event Configuration. Administration > Configuration > Event Configuration

"Proactive Response Time"

index

optional


inventory_id

The id of the associated inventory record


lastupdate

The unix timestamp that this status record was last updated. 

1687213025

level

One of Normal Warning Minor Major Critical Fatal

"Normal"

method

optional

"Alert" or "Threshold"

name

optional


node_uuid

The uuid of the associated node

"8da86248-40f3-4c92-90b6-736bb66814aa"

property


response

status


"ok" or "error"

type


"health"

value


8.59

...

RequestResponse
GET HTTP://server/omk/opCharts/v2/status/648a0e4ca44a3ab377278383.jsonRaw inventory element with given object id
GET HTTP://server/omk/opCharts/v2/status/648a0e4ca44a3ab377278383.json?properties=["event"]

Raw inventory element with given object id, event and node_uuid

{"event": "Proactive Response Time",
"id": "648a0e4ca44a3ab377278383",
"node_uuid": "8da86248-40f3-4c92-90b6-736bb66814aa"
}