HTTP API

The Blueworx Platform includes an HTTP API that can be used to query and control various aspects of the platform.

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

The GET/POST request has to be sent to:

http://<brm>:<port>/api/v1/bvr/<operation>

or

https://<brm>:<port>/api/v1/bvr/<operation>

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 <operation> can place calls, start applications, query status and send events to CCXML applications.

The following sections go into more details about using the various operations of the HTTP API.