Status API
This opCharts API provides access to Status collection data data in a JSON format.
The Status API is available in opCharts from version 4.7.0
...
Each resource has a consistent set of operations
Request Method | Operation | URL Example | id required | Notes |
---|---|---|---|---|
GET | read list | /server/omk/opCharts/v2/status | n | Returns a list of all the status |
records (status id and node_uuid) Paginated | ||
GET | read list | /server/omk/opCharts/v2/inventory/ |
inventory_id/status | y | Returns a list of |
the |
(status id and node_uuid) for all the Status objects matching inventory_id Paginated | ||||
GET | read one | /server/omk/opCharts/v2/status/id | y | Returns the details of the |
status record with the given id. | ||
GET | read list | / |
| y | Returns |
a list of |
all the status records (status |
id and node_uuid), matching given node_uuid Paginated | ||
GET | read list | / |
|
| y | Returns |
a list of |
all the status records (status |
id and node_uuid), matching given node_uuid and inventory_id. |
Request Modifiers (query parameters)
...
You will get a list of all the Inventory subconcepts in your database.
Successful Response
HTTP Status | Body | Description |
---|---|---|
200 OK | Possibly empty JSON array of strings | Each array element is a JSON string object with the subconcept name |
Unsuccessful Response
HTTP Status | Body | Description |
---|---|---|
401 Unauthorized | JSON object with an error property | You are not authenticated. |
403 Forbidden | JSON object with an error property | You are not authorized. |
Example
Code Block |
---|
GET HTTP://server/omk/opCharts/v2/status.json Output:- List of allfirst the25 distinctstatus subconceptsobjects, presentsorted inby inventoryid [ { "id": "648a0e4ca44a3ab377278383", "node_uuid": "8da86248-40f3-4c92-90b6-736bb66814aa" }, { "id": "648a0e4ca44a3ab377278389", "node_uuid": "8da86248-40f3-4c92-90b6-736bb66814aa" }, { "id": "648a0e4ca44a3ab37727838c", "node_uuid": "8da86248-40f3-4c92-90b6-736bb66814aa" }, { "id": "648a0e4ca44a3ab377278538648a0e4ca44a3ab377278542", "node_uuid": "8da86248-40f3-4c92-90b6-736bb66814aa" }, . . . ] |
GET of opcharts/v2/inventory/inventory_id/statusfor List
...
HTTP Status | Body | Description |
---|---|---|
200 OK | Possibly empty JSON array of strings | Each array element is a JSON string object with the subconcept name |
...
HTTP Status | Body | Description |
---|---|---|
200 OK | Possibly empty JSON array of strings | Each array element is a JSON string object with the subconcept name |
...
Property | Description | Example |
| A globally unique ID | "63576103ad794974594a1f11" |
| optional | |
| The | |
| optional | |
| The Event from the Event Configuration. Administration > Configuration > Event Configuration | "Proactive Response Time" |
| optional | |
| The | |
| The unix timestamp that this status record was last updated. | 1687213025 |
| One of Normal Warning Minor Major Critical Fatal | "Normal" |
| optional | "Alert" or "Threshold" |
| The | "8da86248-40f3-4c92-90b6-736bb66814aa" |
| response | |
| "ok" or "error" | |
| "health" | |
| 8.59 |
...
Similar requests and descriptions with inventory id
Request | Response |
---|---|
GET HTTP://server/omk/opCharts/v2/status/648a0e4ca44a3ab377278383 .json | Raw 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", |