Status

The Blueworx Platform includes an HTTP API that can be used to query the overall call status of the platform.

The status API uses HTTP or HTTPS with a GET or POST request.

The GET/POST request has to be sent to:

http://<brm>:<port>/<api>

or

https://<brm>:<port>/<api>

Where <brm> is the address of the BRM machine and <port> is the HTTP or HTTPS port configured in BRM here: HTTP API Configuration Options. The <api> is the status API to access.

​

If BRM is running and the HTTP API is enabled the request will respond with a 200 status code. The response content will contain a JSON summary of the status.

The status API supports three versions of the status.

• api/v1/bvr/status - Short status
• api/v2/bvr/status - Status broken down by account, application, application mapping and BVR
• api/v2/bvr/status/detail - Status including average and history information broken down by account, application, application mapping and BVR