# Reference

- [Billing](/warpstream/reference/billing.md): An overview of WarpStream's billing model.
- [Direct billing](/warpstream/reference/billing/direct-billing.md)
- [AWS Marketplace](/warpstream/reference/billing/aws-marketplace.md)
- [Audit Logs](/warpstream/reference/audit-logs.md): This page describes how to setup WarpStream Audit Logs.
- [Events](/warpstream/reference/events.md)
- [Accessing the Confluent Support Portal](/warpstream/reference/accessing-the-confluent-support-portal.md): This page describes how to access the Confluent customer support portal.
- [Security and Privacy Considerations](/warpstream/reference/security-and-privacy-considerations.md): This page describes the various security and privacy considerations for WarpStream's BYOC deployment model.
- [Manage Console Access](/warpstream/reference/manage-console-access.md): This section describes the various option for managing access to WarpStream's console.
- [Enable SAML Single Sign-on (SSO)](/warpstream/reference/manage-console-access/enable-saml-single-sign-on-sso.md): This page explains how to configure WarpStream's SAML / SSO functionality.
- [Trusted Domains](/warpstream/reference/manage-console-access/trusted-domains.md): This page explains how to configure WarpStream's trusted domains functionality.
- [Workspaces and Access Controls](/warpstream/reference/manage-console-access/workspaces-and-access-controls.md): Overview of access control in the WarpStream web console.
- [Secrets Overview](/warpstream/reference/secrets-overview.md): This page provides an overview of the various secrets defined by WarpStream.
- [API Reference](/warpstream/reference/api-reference.md): This section of the documentation contains the API reference for the WarpStream public API endpoints.
- [API Keys](/warpstream/reference/api-reference/api-keys.md): APIs for interacting with API Keys.
- [Create](/warpstream/reference/api-reference/api-keys/create.md): Create a new API Key.
- [Delete](/warpstream/reference/api-reference/api-keys/delete.md): Delete an API key by ID. The deleted API key must belong to the same workspace as the API key used to authenticate the request.
- [List](/warpstream/reference/api-reference/api-keys/list.md): List all API Keys in a workspace.
- [Virtual Clusters](/warpstream/reference/api-reference/virtual-clusters.md): APIs for interacting with Virtual Clusters.
- [Create](/warpstream/reference/api-reference/virtual-clusters/create.md): Create a new Virtual Cluster.
- [Delete](/warpstream/reference/api-reference/virtual-clusters/delete.md): Delete a Virtual Cluster by ID and name.
- [Describe](/warpstream/reference/api-reference/virtual-clusters/describe.md): Describe a specific Virtual Cluster by ID.
- [List](/warpstream/reference/api-reference/virtual-clusters/list.md): List all Virtual Clusters in your account.
- [Create a Multi-Region Cluster](/warpstream/reference/api-reference/virtual-clusters/create-a-multi-region-cluster.md)
- [DescribeConfiguration](/warpstream/reference/api-reference/virtual-clusters/describeconfiguration.md): Describe the configuration of a specific Virtual Cluster by ID.
- [UpdateConfiguration](/warpstream/reference/api-reference/virtual-clusters/updateconfiguration.md): Update the configuration of a specific Virtual Cluster by ID.
- [Rename](/warpstream/reference/api-reference/virtual-clusters/rename.md): Rename a virtual cluster.
- [Update Tier](/warpstream/reference/api-reference/virtual-clusters/rename-1.md): Update a virtual cluster's tier.
- [Virtual Clusters Credentials](/warpstream/reference/api-reference/virtual-clusters-credentials.md): APIs for interacting with Virtual Clusters Credentials.
- [Create](/warpstream/reference/api-reference/virtual-clusters-credentials/create.md): Create new Virtual Cluster Credentials.
- [Delete](/warpstream/reference/api-reference/virtual-clusters-credentials/delete.md): Delete a Virtual Cluster by ID and name.
- [List](/warpstream/reference/api-reference/virtual-clusters-credentials/list.md): List all Virtual Clusters Credentials of a given Virtual Cluster.
- [ACLs](/warpstream/reference/api-reference/acls.md)
- [Create ACL](/warpstream/reference/api-reference/acls/create-acl.md)
- [List ACLs](/warpstream/reference/api-reference/acls/list-acls.md)
- [Delete ACLs](/warpstream/reference/api-reference/acls/delete-acls.md)
- [Monitoring](/warpstream/reference/api-reference/monitoring.md): APIs for monitoring WarpStream and Consumers.
- [Describe All Consumer Groups](/warpstream/reference/api-reference/monitoring/describe-all-consumer-groups.md): Describe all consumer groups.
- [Describe Account Quotas](/warpstream/reference/api-reference/monitoring/describe-quotas.md): Describe account quotas.
- [Pipelines](/warpstream/reference/api-reference/pipelines.md)
- [List Pipelines](/warpstream/reference/api-reference/pipelines/list-pipelines.md): Lists all pipelines within a virtual cluster.
- [Create Pipeline](/warpstream/reference/api-reference/pipelines/create-pipeline.md): Creates a new pipeline in a virtual cluster.
- [Delete Pipeline](/warpstream/reference/api-reference/pipelines/delete-pipeline.md): Deletes a specific pipeline configuration.
- [Describe Pipeline](/warpstream/reference/api-reference/pipelines/describe-pipeline.md): Retrieves details about a specific pipeline, including its configurations.
- [Create Pipeline Configuration](/warpstream/reference/api-reference/pipelines/create-pipeline-configuration.md): Creates a configuration for a pipeline.
- [Change Pipeline State](/warpstream/reference/api-reference/pipelines/change-pipeline-state.md): Changes the state of an existing pipeline.
- [Invitations](/warpstream/reference/api-reference/invitations.md): APIs to manage invitations to a WarpStream account
- [Create](/warpstream/reference/api-reference/invitations/create.md): Create invitations.
- [Invoices](/warpstream/reference/api-reference/invoices.md): API endpoint for retrieving current and past invoices
- [Get Pending Invoice](/warpstream/reference/api-reference/invoices/get-pending-invoice.md)
- [Get Past Invoice](/warpstream/reference/api-reference/invoices/get-past-invoice.md)
- [Get Invoice Breakdowns](/warpstream/reference/api-reference/invoices/get-invoice-breakdowns.md): Provides a daily breakdown during a time period.
- [Tableflow](/warpstream/reference/api-reference/tableflow.md)
- [List Tables](/warpstream/reference/api-reference/tableflow/list-tables.md)
- [Get Table](/warpstream/reference/api-reference/tableflow/get-table.md)
- [Delete/Recreate Table](/warpstream/reference/api-reference/tableflow/delete-recreate-table.md)
- [Topics](/warpstream/reference/api-reference/topics.md)
- [Create topic](/warpstream/reference/api-reference/topics/create-topic.md)
- [List topics](/warpstream/reference/api-reference/topics/list-topics.md)
- [Describe topic](/warpstream/reference/api-reference/topics/describe-topic.md)
- [Update topic](/warpstream/reference/api-reference/topics/update-topic.md)
- [Delete topic](/warpstream/reference/api-reference/topics/delete-topic.md)
- [Undelete topic](/warpstream/reference/api-reference/topics/undelete-topic.md)
- [Users](/warpstream/reference/api-reference/users.md): APIs for interacting with Users
- [Delete](/warpstream/reference/api-reference/users/delete.md): Delete a User.
- [List](/warpstream/reference/api-reference/users/list.md): List all Users in the account.
- [Update Roles](/warpstream/reference/api-reference/users/update-roles.md): Assign and unassign a User's roles.
- [User Roles](/warpstream/reference/api-reference/user-roles.md): APIs for interacting with User Roles
- [Create](/warpstream/reference/api-reference/user-roles/create.md): Create a new User Role.
- [Delete](/warpstream/reference/api-reference/user-roles/delete.md): Delete a User Role.
- [List](/warpstream/reference/api-reference/user-roles/list.md): List all User Roles in the account.
- [Update](/warpstream/reference/api-reference/user-roles/update.md): Update a User Role.
- [Workspaces](/warpstream/reference/api-reference/workspaces.md): APIs for interacting with Workspaces.
- [Create](/warpstream/reference/api-reference/workspaces/create.md): Create a new Workspace.
- [Delete](/warpstream/reference/api-reference/workspaces/delete.md): Delete a workspace.
- [List](/warpstream/reference/api-reference/workspaces/list.md): List all Workspaces in your account.
- [Rename](/warpstream/reference/api-reference/workspaces/rename.md): Rename a Workspace.
- [CLI Reference](/warpstream/reference/cli-reference.md)
- [warpstream agent](/warpstream/reference/cli-reference/warpstream-agent.md)
- [warpstream demo](/warpstream/reference/cli-reference/warpstream-demo.md)
- [warpstream cli](/warpstream/reference/cli-reference/warpstream-kcmd.md)
- [warpstream cli-beta](/warpstream/reference/cli-reference/warpstream-cli-beta.md)
- [benchmark-consumer](/warpstream/reference/cli-reference/warpstream-cli-beta/benchmark-consumer.md)
- [benchmark-producer](/warpstream/reference/cli-reference/warpstream-cli-beta/benchmark-producer.md)
- [console-consumer](/warpstream/reference/cli-reference/warpstream-cli-beta/console-consumer.md)
- [console-producer](/warpstream/reference/cli-reference/warpstream-cli-beta/console-producer.md)
- [consumer-group-lag](/warpstream/reference/cli-reference/warpstream-cli-beta/consumer-group-lag.md)
- [diagnose-record](/warpstream/reference/cli-reference/warpstream-cli-beta/diagnose-record.md)
- [file-reader](/warpstream/reference/cli-reference/warpstream-cli-beta/file-reader.md)
- [file-scrubber](/warpstream/reference/cli-reference/warpstream-cli-beta/file-scrubber.md)
- [warpstream playground](/warpstream/reference/cli-reference/warpstream-playground.md)
- [Integrations](/warpstream/reference/integrations.md)
- [Arroyo](/warpstream/reference/integrations/arroyo.md): This page describes how to integrate WarpStream with Arroyo, a distributed stream processing engine written in Rust, that is designed to efficiently perform statement computations on streams of data.
- [AWS Lambda Triggers](/warpstream/reference/integrations/aws-lambda-triggers.md): This page explains how to use WarpStream with AWS's Self Managed Apache Kafka Trigger
- [ClickHouse](/warpstream/reference/integrations/clickhouse.md): This page describes how to integrate WarpStream with ClickHouse, ingest data from WarpStream into ClickHouse, and query the data in ClickHouse.
- [Debezium](/warpstream/reference/integrations/use-warpstream-with-debezium.md): Instructions on how to use WarpStream with Debezium.
- [Decodable](/warpstream/reference/integrations/decodable.md): This page describes how to integrate WarpStream with Decodable, ingest data into Decodable from WarpStream, and query the data in Decodable.
- [DeltaStream](/warpstream/reference/integrations/deltastream.md): Learn how to connect DeltaStream and WarpStream.
- [docker-compose](/warpstream/reference/integrations/use-the-agent-in-docker-compose.md): This page describes how to configure the WarpStream Agent's so they run in docker-compose.
- [DuckDB](/warpstream/reference/integrations/duckdb.md): DuckDB is an open-source, column-oriented, relational database management system (RDBMS) designed for analytical processing and interactive querying.
- [ElastiFlow](/warpstream/reference/integrations/elastiflow.md): ElastiFlow is a network flow and SNMP analytics/monitoring solution that enables insights into network performance and security using NetFlow, IPFIX, sFlow, and SNMP with data platforms like Kafka.
- [Estuary](/warpstream/reference/integrations/estuary.md): Estuary allows you to build real-time ETL/ELT data pipelines between various platforms supported by an array of connectors.
- [Fly.io](/warpstream/reference/integrations/deploy-warpstream-to-fly.io.md): Instructions on how to deploy the WarpStream Agents to Fly.io
- [Imply](/warpstream/reference/integrations/imply.md): This page describes how to integrate, ingest and query data in Imply from WarpStream. Imply is powered by Apache Druid, a real-time analytics database.
- [InfluxDB](/warpstream/reference/integrations/influxdb.md): InfluxDB is an open-source time series database that is a perfect companion to WarpStream's Apache Kafka-compatible clusters.
- [Kafbat UI/kafka-ui](/warpstream/reference/integrations/kafbat-ui-kafka-ui.md): Kafbat UI and kafka-ui are web UIs for managing and monitoring Kafka clusters.
- [Kestra](/warpstream/reference/integrations/kestra.md): This page describes how to integrate WarpStream with Kestra. Kestra is an event-driven data orchestration platform with a UI and command-line interface.
- [Materialize](/warpstream/reference/integrations/materialize.md): This page describes how to set up a connection between WarpStream and Materialize, ingest data into Materialize, and create a materialized view of this data.
- [MinIO](/warpstream/reference/integrations/minio.md): Instructions on integrating WarpStream with MinIO.
- [MirrorMaker](/warpstream/reference/integrations/mirrormaker.md): This page describes the settings tweaks you may have to do to leverage MirrorMaker to migrate to Warpstream.
- [MotherDuck](/warpstream/reference/integrations/motherduck.md): MotherDuck provides cloud-based, serverless access to DuckDB
- [ngrok](/warpstream/reference/integrations/ngrok.md): How to leverage ngrok for testing WarpStream Agents running locally.
- [Ockam](/warpstream/reference/integrations/ockam.md): Instructions on integrating WarpStream with Ockam.
- [OpenTelemetry Collector](/warpstream/reference/integrations/opentelemetry-collector.md): This page describes how to connect the OpenTelemetry Collector to WarpStream using the Kafka exporter.
- [Parquet](/warpstream/reference/integrations/sqlite.md): Apache Parquet is an open-source, column-oriented data file format designed for efficient data storage and retrieval. It forms the backbone of many datalake and table format systems.
- [Quix Streams](/warpstream/reference/integrations/quix-streams.md): This page describes how to use the Quix Streams Python library to read and aggregate data from WarpStream and ingest the aggregations into a local DuckDB database for offline querying.
- [Railway](/warpstream/reference/integrations/railway.md): Instructions on how to deploy the WarpStream Agents to Railway.
- [Redpanda Console](/warpstream/reference/integrations/redpanda-console.md): Redpanda Console is a web application that helps you manage and debug your Kafka workloads, as well as Kafka protocol-compatible systems such as Redpanda and WarpStream.
- [RisingWave](/warpstream/reference/integrations/use-warpstream-with-risingwave.md): Instructions on how to use WarpStream with RisingWave.
- [Rockset](/warpstream/reference/integrations/rockset.md): This page describes how to integrate WarpStream with Rockset, ingest data into Rockset from WarpStream, and query the data in Rockset.
- [ShadowTraffic](/warpstream/reference/integrations/shadowtraffic.md): ShadowTraffic is a containerized service for declaratively generating data, packed with knobs to perfectly mimic your production traffic to Kafka-compatible, and other destinations.
- [SQLite](/warpstream/reference/integrations/sqlite-1.md): SQLite is an open-source, embedded, serverless RDBMS that is popular for its small size and ease of use.
- [Streambased](/warpstream/reference/integrations/streambased.md): Instructions on integrating WarpStream with Streambased.
- [Streamlit](/warpstream/reference/integrations/streamlit.md): Streamlit is a Python library that enables the simple creation of web apps.
- [Timeplus](/warpstream/reference/integrations/timeplus.md): This page describes how to integrate WarpStream with Timeplus, to perform SQL commands on a data stream to perform queries, transformations and ETL.
- [Tinybird](/warpstream/reference/integrations/tinybird.md): This page describes how to integrate WarpStream with Tinybird, ingest data into Tinybird from WarpStream, and then create an API endpoint for your applications to access the result set.
- [Upsolver](/warpstream/reference/integrations/upsolver.md): This page describes how to integrate WarpStream with Upsolver, ingest data into Upsolver from WarpStream, then process and write the data to one of the available targets in Upsolver.
- [Dedicated Control Plane Cells and Release Windows](/warpstream/reference/dedicated-control-plane-cells-and-release-windows.md): This page explains how WarpStream's dedicated control plane cells work, along with support for custom release windows.
- [Control Plane Private Connectivity](/warpstream/reference/control-plane-private-connectivity.md)
- [Deprecation Policy](/warpstream/reference/deprecation-policy.md): This page describes our policy in the event of removal of customer-usable functionality from WarpStream services.