Skip to content
WarpStream Documentation
Reference
…
API Reference
Virtual Clusters Credentials
Search
Ctrl
K
Cancel
Quick explore
Start here
Learn the architecture
Run the demo
Create an account
Deploy the Agents
Products
Kafka
Tableflow
Schema Registry
Managed Data Pipelines
Orbit
Operations
Reference
CLI
Agent configuration
API
Change log
Billing
Slack
Discord
Start Free
Menu
Overview
Introduction
Architecture
Architecture
Service Discovery
Write Path
Read Path
Life of a Request (Simplified)
Change Log
Change Log
Migrations
Getting Started
Install the WarpStream Agent / CLI
Run the Agents Locally
"Hello World" for Apache Kafka
Agent Setup
Deploy the Agents
Deploy the Agents
Kubernetes Known Issues
Rolling Restarts and Upgrades
Object Storage Configuration
Object Storage Configuration
Multi Buckets
Striped Buckets
Set up Monitoring
Set up Monitoring
Diagnostics
Important Metrics and Logs
Hosted Prometheus Endpoint
Recommended List of Alerts
Monitoring Consumer Groups
Datadog Integration
Pre-made Datadog Dashboard
Pre-made Grafana Dashboard
Infrastructure as Code
Infrastructure as Code
Terraform Provider
Helm charts
Terraform Modules
Protecting important resources from accidental deletion
Kafka
Configure Clients
Configure Clients
Tuning for Performance
Automatic Fetch Size Auto-tuning
Configure Clients to Eliminate AZ Networking Costs
Configure Clients to Eliminate AZ Networking Costs
Force Interzone Load Balancing
Configuring Kafka Client ID Features
Client Metrics (KIP-714)
Consumer Group Protocol (KIP-848)
Hosted Metadata Endpoint
Port Forwarding (K8s)
Known Issues
Manage Security
Manage Security
ACLs
TLS
SASL Authentication
Mutual TLS (mTLS)
SASL/OAUTHBEARER Authentication
Manage Connectors
Manage Connectors
Confluent Platform Components
Managed Data Pipelines
Managed Data Pipelines
Cookbooks
Deploy (advanced)
Deploy (advanced)
Agent Roles
Agent Groups
Workload Identity Federation
Low Latency Clusters
Low Latency Clusters
S3 Express
GCP Rapid Buckets (beta)
AWS DynamoDB
Google Spanner (beta)
Lightning topics
Multi-Region Clusters
Migrating Control Plane Regions
Network Architecture Considerations
Agent Configuration Reference
Reducing Infrastructure Costs
Ripcord
Reference
Reference
Compression
Protocol and Feature Support
Protocol and Feature Support
Kafka vs WarpStream Configuration Reference
Compacted topics
Broker Configuration Reference
Topic Configuration Reference
HTTP Endpoints
Partitions Auto-Scaler
Serverless Clusters
Partition Assignment Strategies
Control Plane Utilization
Benchmark
Orbit (Cluster Linking)
Orbit (Cluster Linking)
Auto Migration
Tableflow
Tableflow Setup
Query-Based Deletion
Monitoring Tableflow
Iceberg REST Catalog
Integrate With Query Engines and External Catalogs
Integrate With Query Engines and External Catalogs
Snowflake
Databricks Unity
BigQuery
Lakehouse Runtime Catalog (BigLake)
DuckDB
ClickHouse
AWS Glue
Amazon Athena
Hive Metadata Store
API Reference
Schema Registry
Setup
Enforce Schemas
Schema Linking
Manage Security
Manage Security
Basic Authentication
Reference
Billing
Billing
Direct billing
AWS Marketplace
Chargebacks
Audit Logs
Events
MCP Server
Accessing the Confluent Support Portal
Security and Privacy Considerations
Manage Console Access
Manage Console Access
Enable SAML Single Sign-on (SSO)
Trusted Domains
Workspaces and Access Controls
Secrets Overview
API Reference
API Reference
API Keys
API Keys
Create
Create (v2)
Delete
List
Virtual Clusters
Virtual Clusters
Create
Create (v2)
Delete
Describe
List
Create a Multi-Region Cluster
DescribeConfiguration
UpdateConfiguration
Rename
Update Tier
Virtual Clusters Credentials
Virtual Clusters Credentials
Create
Delete
List
ACLs
ACLs
Create ACL
List ACLs
Delete ACLs
Monitoring
Monitoring
Describe All Consumer Groups
Describe Account Quotas
Pipelines
Pipelines
List Pipelines
Create Pipeline
Delete Pipeline
Describe Pipeline
Create Pipeline Configuration
Change Pipeline State
Invitations
Invitations
Create
Invoices
Invoices
Get Pending Invoice
Get Past Invoice
Get Invoice Breakdowns
Get Pending Chargebacks
Get Past Chargebacks
Tableflow
Tableflow
List Tables
Get Table
Delete/Recreate Table
Topics
Topics
Create topic
List topics
Describe topic
Update topic
Delete topic
Undelete topic
Client Metrics
Client Metrics
List Subscriptions
Describe Subscription
Update Subscriptions
Delete Subscriptions
Users
Users
Delete
List
Update Roles
User Roles
User Roles
Create
Delete
List
Update
Workspaces
Workspaces
Create
Create (v2)
Delete
List
Rename
Orbit Auto Migration
Orbit Auto Migration
Initiate
Abort
Status
CLI Reference
CLI Reference
warpstream agent
warpstream demo
warpstream cli
warpstream cli
benchmark-consumer
benchmark-producer
console-consumer
console-producer
consumer-group-lag
diagnose-record
file-reader
file-scrubber
warpstream kcmd (a.k.a. warpstream cli-old)
warpstream local
warpstream playground
Integrations
Integrations
Arroyo
AWS Lambda Triggers
ClickHouse
Debezium
Decodable
DeltaStream
docker-compose
DuckDB
ElastiFlow
Estuary
Fly.io
Imply
InfluxDB
Kafbat UI/kafka-ui
Kestra
Materialize
MinIO
MirrorMaker
MotherDuck
ngrok
Ockam
OpenTelemetry Collector
Parquet
Quix Streams
Railway
Redpanda Console
RisingWave
Rockset
ShadowTraffic
SQLite
Streambased
Streamlit
Timeplus
Tinybird
Upsolver
Dedicated Control Plane Cells and Release Windows
Control Plane Private Connectivity
Deprecation Policy
Media
Slack
Discord
Reference
API Reference
Virtual Clusters Credentials
APIs for interacting with Virtual Clusters Credentials.
Create
Delete
List
