Get BlackBox Status

<< Click to Display Table of Contents >>

Navigation:  Optimizer API >

Get BlackBox Status

 

Query the BlackBox instance running behind this API to ensure availability.

 

HTTP Request

 

 GET opt/v1/status 

 

Authorization: BASIC

 

Parameters: None

 

Response:

 

{

 "status":"OK",

 "usage":"0",

 "uptime":"0 0:00:14",

 "localtime":"2018-06-15T12:14:12.865-07:00",

 "loadfactor":"0",

 "license":"xxxxxx"

}

 

Property

Description

status

"OK" if the BB is available for processing

usage

Number of optimization calls this BB has handled

uptime

Time in days hours:minutes:seconds since the BB was last restarted

localtime

Local time on the BB's server. Use this to calculate the offset between your time and the server if required

loadfactor

Current load on the BB. 0 is 100% available, the higher the number the busier the BB is

license

Internal use only