The REST interface allows for lightweight clients, that do not have enough resources to run one of the realtime Websockets-based Client APIs or do not use a technology currently supported by the Client APIs, to consume and produce messages using HTTP requests.

You can test the REST interface using a tool like curl that allows GET and POST methods to be invoked, and can pass data into the body of the HTTP request.

In order to enable the REST interface for MigratoryData or for MigratoryData KE, configure the optional parameter Rest.Enable on true. By default, this parameter is set on false.

The interface consists of two endpoints — produce and consume — which are detailed in the sections below.