Via this API you are able to request any data out of your OCC.
Want to export chart-data, log messages or anything else? Here's how you do it!
The API uses simple HTTPS Requests, which will always return a JSON result object.
First of all log in with a valid user account or send a valid API key with every request! The only methods not secured are the methods within the 'auth' namespace.
To perform a request, simply combine the BASE_URL (found at the bottom of this page) and the desired functions' name.
Add the required parameters to the query or as JSON object to the POST body of the request.
BASE_URL/node/chart?id=i4mju2t-20m3-w31rd-1dukn0w&timespan=DAY&dataType=MAX
The request above fetches some chart data and returns a JSON result object.
If you use API keys, you have to send the API key with every request.
BASE_URL/node/chart?id=i4mju2t-20m3-w31rd-1dukn0w&timespan=DAY&dataType=MAX&apiKey=he-ll0000h-I4mAkey
Every request returns it and this is what it looks like:
{
success : true,
message : null,
data : [{
measurement : 10,
name : "CPU",
.......
}]
}
The object always contains the following properties:
success : boolean Shows if the request was successfull or not. message : string If the request was not successfull, it contains an error message. Otherwise null. data : Array or Object Depending on the requested data this property contains an array of data or just one simple object containing a result.