Axual Rest Proxy

Basic Use Case

The Rest Proxy is available for clients who cannot use the native Axual Client and need to use low volume streams. It provides basic produce, consume and Avro schema resolve capabilities.

Rest Proxy Overview

Practical information on how to use the REST Proxy can be found in the Getting Started section.


Applications using the Rest Proxy should be registered in Self Service and use Self Service to get access to streams. This will result in Access Control Lists being created on the clusters using these resources. Rest Proxy will perform authentication and authorisation using Mutual TLS, and verify that the client has access to the resources by checking the cluster Access Control Lists.


Streams can use Avro schema definitions for keys and/or values. These schemas need to be provided with every produce call. This will usually result in a relatively high overhead in data. The schemas are stored in the backend and ids are provided for these schemas. The produce call also accepts these ids. The Avro service can provide the id of a specified schema for a specific stream and environment.

See Avro Schema Service for more information.


The produce service enables clients to produce messages to specific streams. The Rest Proxy supports multiple datatypes for key and value.

See Produce Service for more information.


The consume service enables clients to consume messages from specific streams. The Rest Proxy supports multiple datatypes for key and value. The expected key and value type should be static per stream

See Consume Service for more information