>
Confluent
  • Product
    • Confluent Platform
    • KSQL
    • Confluent Hub
    • Subscription
    • Professional Services
    • Training
    • Customers
  • Cloud
    • Confluent Cloud
    • Support
    • Sign Up
    • Log In
    • Cloud FAQ
  • Developers
    • What is Kafka?
    • Resources
    • Events
    • Online Talks
    • Meetups
    • Kafka Summit
    • Kafka Tutorials
    • Confluent Developer
  • About Us
    • Company
    • Partners
    • News
    • Events
    • Careers
    • Contact
  • Blog
  • Docs
  • Download
Get Confluent | Sign up for Confluent Cloud or download Confluent Platform
  • Getting Started
    • What is Confluent Platform?
    • Confluent Platform Quick Start
      • Confluent Enterprise Quick Start
      • Confluent Open Source Quick Start
      • Confluent Cloud Quick Start
      • Kubernetes Helm Charts
    • Installation
      • Installing and Upgrading
        • Install Using the Confluent CLI
        • Docker Quick Start
        • Manual Install using ZIP and TAR Archives
        • Manual Install using Systemd on Ubuntu and Debian
        • Manual Install using Systemd on RHEL and CentOS
        • Docker Advanced Tutorials
          • Clustered Deployment
          • Clustered Deployment Using SSL
          • Clustered Deployment Using SASL and SSL
          • Kafka Connect Tutorial
          • Automatic Data Balancing
          • Replicator Tutorial
      • System Requirements
      • Configuration Reference
        • Broker Configurations
        • Topic Configurations
        • Producer Configurations
        • Control Center Configurations
        • Streams Configurations
        • ZooKeeper Configurations
      • Packages
      • Installing using Docker
        • Docker Quick Start
        • Docker Configuration
        • Docker Advanced Tutorials
          • Clustered Deployment
          • Clustered Deployment Using SSL
          • Clustered Deployment Using SASL and SSL
          • Kafka Connect Tutorial
          • Automatic Data Balancing
          • Replicator Tutorial
      • Using Confluent Platform systemd Service Unit Files
      • Installing Clients
      • Migrating from Open Source to Enterprise
      • Upgrade
      • Supported Versions and Interoperability
      • Migrating an Existing Kafka Deployment
    • Command Line Interface
      • Installing and Configuring the CLI
      • Command Reference
        • confluent acl
        • confluent config
        • confluent current
        • confluent destroy
        • confluent help
        • confluent list
        • confluent load
        • confluent log
        • confluent start
        • confluent status
        • confluent stop
        • confluent top
        • confluent unload
    • Tutorials and Resources
      • Monitoring Kafka streaming ETL deployments
      • Ansible Playbooks for Confluent Platform
    • Confluent Platform 4.1.2 Release Notes
  • Operations
    • Kafka Operations
      • Running Kafka in Production
      • Post Deployment
      • Auto Data Balancing
        • Configuration Options for the rebalancer tool
      • Monitoring Kafka
      • Confluent Metrics Reporter
    • Confluent Control Center
      • Control Center Quick Start
      • Installing and Configuring Control Center
        • Installing Control Center
        • Control Center System Requirements
        • Control Center Parameter Reference
        • Confluent Monitoring Interceptors
        • Installing Control Center on Apache Kafka
        • Troubleshooting Control Center
        • Upgrading Control Center
      • Control Center User Interface
        • System Health
        • Stream Monitoring
        • Kafka Connect
        • Alerts
        • Clusters
        • Topic Management
          • Create a topic
          • Detail view for a topic
          • Edit a topic
      • Confluent Control Center Security
        • Configuring SSL
        • Confluent Control Center Configuring SASL
        • Confluent Control Center UI Authentication
        • UI HTTPS
        • Authorization with Kafka ACLS
      • Changelog
    • Multi-Datacenter Replication
      • Replicator Quick Start
      • Installing and Configuring Replicator
      • Tuning and Monitoring Replicator
      • Installing and Running Replicator Executable
      • Apache Kafka’s MirrorMaker
    • Schema Registry Operations
      • Schema Registry System Requirements
      • Monitoring Schema Registry
    • Kafka REST Proxy Operations
      • Production Deployment
      • Monitoring REST Proxy
    • Docker Operations
      • Monitoring
      • Configuring logging
      • Mounting External Volumes
    • Security
      • Security Tutorial
      • Encryption with SSL
      • Encryption and Authentication with SSL
      • Authentication with SASL
        • Configuring GSSAPI
        • Configuring SCRAM
        • Configuring PLAIN
      • Authorization and ACLs
      • Adding Security to a Running Cluster
      • Streams Security
      • Confluent Security Plugins
        • Kafka REST Security Plugin
          • Kafka REST Security Plugin Quick Start
          • Principal Propagation
        • Schema Registry Security Plugin
          • Schema Registry Security Plugin Quick Start
          • Schema Registry Authorization
            • Schema Registry ACL Authorizer
            • Topic ACL Authorizer
      • Docker Security
      • Prefixes for Configuring Security
    • Kafka Connect
      • Kafka Connect Quick Start
      • Kafka Connect Concepts
      • Installing and Configuring Kafka Connect
      • Managing Connectors
      • Bundled Connectors
        • Confluent JDBC Connector
          • JDBC Source Connector
          • JDBC Source Configuration Options
          • JDBC Sink Connector
          • JDBC Sink Configuration Options
          • Changelog
        • Confluent HDFS Connector
          • HDFS Connector
          • HDFS Connector Configuration Options
          • Changelog
        • Confluent S3 Connector
          • S3 Connector
          • S3 Connector Configuration Options
          • Changelog
        • Confluent GCS Connector
          • GCS Connector
          • Configuration Options
        • Confluent Elasticsearch Connector
          • Elasticsearch Connector
          • Elasticsearch Configuration Options
          • Changelog
        • Confluent Replicator
          • Confluent Replicator
          • Changelog
          • Configuration Options
        • Confluent JMS Connector
          • JMS Source Connector
          • JMS Configuration Options
          • JMS Connector Example Configurations
          • Changelog
        • Confluent IBM MQ Connector
          • IBM MQ Source Connector
          • IBM MQ Configuration Options
          • IBM MQ Example Configurations
          • Changelog
        • Confluent ActiveMQ Connector
          • ActiveMQ Source Connector
          • ActiveMQ Configurations Options
          • ActiveMQ Example Configurations
          • Changelog
        • Kafka FileStream Connectors
      • Preview Connectors
        • Confluent Cassandra Connector
          • Cassandra Sink Connector
          • Cassandra Sink Connector Configuration Options
        • Confluent Microsoft SQL Server Connector
          • Microsoft SQL Server
          • Microsoft SQL Server Configuration Options
        • Confluent InfluxDB Connector
          • InfluxDB Sink
          • InfluxDB Sink Configuration Options
        • Confluent Kinesis Connector
          • Kinesis Source Connector
          • Kinesis Source Connector Configuration Options
        • Confluent MapR DB Connector
          • MapR DB Sink Connector
          • MapR DB Sink Connector Configuration Options
        • Confluent MQTT Connector
          • MQTT Source Connector
            • MQTT Source Connector Configuration Options
            • Example: Configure MQTT Source Connector for Eclipse Mosquitto Broker
          • MQTT Sink Connector
            • MQTT Sink Connector Configuration Options
            • Example: Configure MQTT Sink Connector for Eclipse Mosquitto Broker
          • MQTT Connectors Advanced Debugging
        • Confluent RabbitMQ Connector
          • RabbitMQ Source Connector
          • RabbitMQ Source Connector Configuration Options
        • Confluent Salesforce Connector
          • Salesforce Source Connector
          • Salesforce Source Connector Configuration Options
      • Kafka Connect Transformations
        • Cast
        • ExtractField
        • Flatten
        • HoistField
        • InsertField
        • MaskField
        • RegexRouter
        • ReplaceField
        • SetSchemaMetadata
        • TimestampConverter
        • TimestampRouter
        • ValueToKey
      • Kafka Connect Security
      • Kafka Connect Architecture
      • Connector Developer Guide
      • Kafka Connect FAQ
      • Kafka Connect Reference
        • Kafka Connect Javadocs
        • Kafka Connect REST Interface
        • Kafka Connect Worker Configs
    • Camus Operations
      • Important Configuration Options
    • ZooKeeper Operations
      • Running ZooKeeper in Production
  • Development
    • Kafka Streams
      • Introduction
      • Requirements
      • Kafka Streams Quick Start
      • Kafka Streams Demo Application
      • Concepts
      • Architecture
      • Code Examples
      • Developer Guide
        • Writing a Streams Application
        • Testing Streams Code
        • Configuring a Streams Application
        • Streams DSL
        • Processor API
        • Data Types and Serialization
        • Interactive Queries
        • Memory Management
        • Running Streams Applications
        • Managing Streams Application Topics
        • Streams Security
        • Application Reset Tool
      • Operations
        • Capacity planning and sizing
        • Monitoring your application
      • Upgrade Guide
      • FAQ
      • Javadocs
    • KSQL
      • KSQL Quick Start
      • Installation and Configuration
        • Installing KSQL
        • Install KSQL with Docker
        • Check the Health of a KSQL Server
        • Configuring KSQL Server
          • Configuring Security for KSQL
          • KSQL Configuration Parameter Reference
          • Avro and Schema Registry
        • Configuring KSQL CLI
        • Upgrading KSQL
      • KSQL Developer Guide
        • Configuring KSQL CLI
        • KSQL Syntax Reference
        • KSQL REST API Reference
        • KSQL Tutorials and Examples
          • Writing Streaming Queries Against Apache Kafka® Using KSQL (Docker)
          • Writing Streaming Queries Against Apache Kafka® Using KSQL (Local)
          • Clickstream Data Analysis Pipeline Using KSQL (Docker)
          • Generate Custom Test Data by Using the ksql-datagen tool
          • KSQL Examples
      • KSQL Operations
      • KSQL Capacity Planning
      • KSQL Tutorials and Examples
        • Writing Streaming Queries Against Apache Kafka® Using KSQL (Docker)
        • Writing Streaming Queries Against Apache Kafka® Using KSQL (Local)
        • Clickstream Data Analysis Pipeline Using KSQL (Docker)
        • Generate Custom Test Data by Using the ksql-datagen tool
        • KSQL Examples
      • Frequently Asked Questions
      • Troubleshoot KSQL issues
    • Kafka Clients
      • Kafka Java Consumer
      • Kafka Java Producer
      • JMS Client
      • Client API Docs
    • Connector Developer Guide
    • Schema Registry
      • Installing and Configuring Schema Registry
      • Schema Registry Configuration Options
      • Using Schema Registry
      • Monitoring Schema Registry
      • Schema Registry Operations
        • Schema Registry System Requirements
        • Monitoring Schema Registry
      • Schema Registry Multi-DC Setup
      • Schema Registry Security Overview
      • Schema Registry Serializer and Formatter
      • Schema Deletion Guidelines
      • Schema Registry Maven Plugin
      • Using Kafka Connect with Schema Registry
      • Schema Registry API Reference
      • Schema Registry Changelog
    • Docker Developer Guide
    • Data Serialization and Evolution
    • Confluent REST Proxy
      • Kafka REST Proxy
      • Confluent REST API Reference
      • REST Proxy Configuration Options
      • Configuration Options for HTTPS
      • Configuration Options for SSL Encryption between REST Proxy and Apache Kafka Brokers
      • Configuration Options for SASL Authentication between REST Proxy and Apache Kafka Brokers
      • Kafka REST Operations
        • Production Deployment
        • Monitoring REST Proxy
      • Security Overview
      • Changelog
    • Application Development
      • kafkacat Utility
    • Confluent Hub
      • Overview
      • Confluent Hub Client
        • confluent-hub help
        • confluent-hub install
      • Contributing Components
      • Component Archive Specification
    • Camus
      • Camus
      • Changelog
      • Camus Configuration Options
      • Design
      • Operations
        • Important Configuration Options
  • Docs
  • Development »
  • Confluent REST Proxy
  • View page source

Important

You are viewing documentation for an older version of Confluent Platform. For the latest, click here.

Confluent REST Proxy¶

Contents:

  • Kafka REST Proxy
    • Quickstart
      • Produce and Consume JSON Messages
      • Produce and Consume Avro Messages
      • Produce and Consume Binary Messages
      • Inspect Topic Metadata
    • Features
    • Installation
    • Deployment
    • Development
    • Requirements
    • Contribute
    • License
  • Confluent REST API Reference
    • Overview
      • Content Types
      • Errors
    • API v2
      • Topics
      • Partitions
      • Consumers
      • Brokers
    • API v1
      • Topics
      • Partitions
      • Consumers
      • Brokers
  • REST Proxy Configuration Options
    • Security Configuration Options
  • Configuration Options for HTTPS
  • Configuration Options for SSL Encryption between REST Proxy and Apache Kafka Brokers
  • Configuration Options for SASL Authentication between REST Proxy and Apache Kafka Brokers
    • Interceptor Configuration Options
  • Kafka REST Operations
    • Production Deployment
      • Hardware
      • JVM
      • Deployment
      • Important Configuration Options
      • Don’t Touch These Settings!
      • Post Deployment
    • Monitoring REST Proxy
      • Global Metrics
      • Per-Endpoint Metrics
      • Endpoints
  • Security Overview
  • Changelog
    • Version 3.3.0
    • Version 3.2.2
    • Version 3.2.1
    • Version 3.2.0
    • Version 3.1.2
    • Version 3.1.1
    • Version 3.1.0
    • Version 3.0.0
    • Version 2.0.1
    • Version 2.0.0

The Confluent REST Proxy is available as open source software under the Apache License v2.0 license. Source code at https://github.com/confluentinc/kafka-rest.

© Copyright , Confluent, Inc. Privacy Policy | Terms & Conditions. Apache, Apache Kafka, Kafka and the Kafka logo are trademarks of the Apache Software Foundation. All other trademarks, servicemarks, and copyrights are the property of their respective owners.

Please report any inaccuracies on this page or suggest an edit.

Next Previous

Last updated on Dec 15, 2021.

Built with Sphinx using a theme provided by Read the Docs.
    Expand Content v.--