Related

• Admin Nodes API - Create Read Update Delete (CRUD) nodes
• Delegated Authentication - Using tokens instead of username password for API's

General

All requests lists below are JSON requests.  HTML requests will work for these URL's but may return different data.  To guarantee a json request append .json to the end of the url (but not the query string).  All replies will be in the form of a JSON document.

Nodes

Nodes are gathered from the NMIS installation on the existing server.  Each node has a list of resources.  Each resource can either be indexed or non-indexed.  If non-indexed each resource contains a list of datasets (which are individual data points over time, eg. avgbusy5).  If indexed, the resource contains an array, each element in that array contains datasets.

GET nodes (fetch list of nodes)

Authentication

Authentication is required to access all methods listed below.

POST login (authenticate)

POSTGET /omk/opCharts/nodes/

Retrieves the nodes available to opCharts.  No parameters are accepted.

Successful Response

Returns an array of strings containing the node names 

[
  "odin",
  "sparkle",
  "maverick",
]

GET node resources (fetch resources for a single node)

GET /omk/opCharts/nodes/[node_name]/resources/

login

Authenticate to opCharts. 

Request

Successful Response

A cookie is created and sent with the response.  This must be saved and passed with all requests below.  

opCore Integration API (Node config/info/status)

opCore API provides access to all nodes -- their configuration, info and status.  Data for all nodes can be requested at one time, a subset of nodes or a specific node.

For opCharts Version 3.x - opCore API V1

For opCharts Version 4.x - opCore API V2

opCharts TopN API (opCharts version 2.2.2+)

TopN data is created after every NMIS collect cycle and represents the top users of each resource type.  By default there are 6 topn documents created: cpuLoad, 

opCharts Node Resource API (Performance Data)

Access resources available for each node, like interface data, health data, CBQoS data (and more).  The data available will vary per node, this API allows you to determine what each node offers and also how to access the performance data associated with that resource.R