Skip to main content

Apache Kafka® REST API

The Apache Kafka® REST API lets you produce and consume messages over HTTP. Use it from tools such as curl, scripts, or services that speak HTTP instead of the Kafka protocol.

Karapace serves these APIs through the REST proxy, which forwards HTTP requests to Apache Kafka.

Karapace also provides Schema Registry REST APIs to register, update, and delete schemas. Those APIs are separate from the Kafka REST API.

Enable the REST API

The REST API is available after you enable the REST proxy on your service. In Connection information, open the Apache Kafka REST tab and click Enable, or enable Apache Kafka REST API (Karapace) from Service management. For automation, set the kafka_rest parameter.

See Enable schema registry and REST proxy.

Use the REST API

Requests authenticate with a service user's username and password. To produce and consume messages with generated curl commands from the Aiven Console, see Connect with Kafka REST.

Control access

REST proxy authorization applies Kafka ACLs to REST requests. See Enable Apache Kafka® REST proxy authorization.

Related pages