# Reference - [Billing](https://docs.warpstream.com/warpstream/reference/billing.md): An overview of WarpStream's billing model. - [Direct billing](https://docs.warpstream.com/warpstream/reference/billing/direct-billing.md) - [AWS Marketplace](https://docs.warpstream.com/warpstream/reference/billing/aws-marketplace.md) - [Audit Logs](https://docs.warpstream.com/warpstream/reference/audit-logs.md): This page describes how to setup WarpStream Audit Logs. - [Events](https://docs.warpstream.com/warpstream/reference/events.md) - [MCP Server](https://docs.warpstream.com/warpstream/reference/mcp-server.md): This page describes the WarpStream Console MCP (Model Context Protocol) server for IDEs and AI assistants. - [Accessing the Confluent Support Portal](https://docs.warpstream.com/warpstream/reference/accessing-the-confluent-support-portal.md): This page describes how to access the Confluent customer support portal. - [Security and Privacy Considerations](https://docs.warpstream.com/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](https://docs.warpstream.com/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)](https://docs.warpstream.com/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](https://docs.warpstream.com/warpstream/reference/manage-console-access/trusted-domains.md): This page explains how to configure WarpStream's trusted domains functionality. - [Workspaces and Access Controls](https://docs.warpstream.com/warpstream/reference/manage-console-access/workspaces-and-access-controls.md): Overview of access control in the WarpStream web console. - [Secrets Overview](https://docs.warpstream.com/warpstream/reference/secrets-overview.md): This page provides an overview of the various secrets defined by WarpStream. - [API Reference](https://docs.warpstream.com/warpstream/reference/api-reference.md): This section of the documentation contains the API reference for the WarpStream public API endpoints. - [API Keys](https://docs.warpstream.com/warpstream/reference/api-reference/api-keys.md): APIs for interacting with API Keys. - [Create](https://docs.warpstream.com/warpstream/reference/api-reference/api-keys/create.md): Create a new API Key. - [Delete](https://docs.warpstream.com/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](https://docs.warpstream.com/warpstream/reference/api-reference/api-keys/list.md): List all API Keys in a workspace. - [Virtual Clusters](https://docs.warpstream.com/warpstream/reference/api-reference/virtual-clusters.md): APIs for interacting with Virtual Clusters. - [Create](https://docs.warpstream.com/warpstream/reference/api-reference/virtual-clusters/create.md): Create a new Virtual Cluster. - [Delete](https://docs.warpstream.com/warpstream/reference/api-reference/virtual-clusters/delete.md): Delete a Virtual Cluster by ID and name. - [Describe](https://docs.warpstream.com/warpstream/reference/api-reference/virtual-clusters/describe.md): Describe a specific Virtual Cluster by ID. - [List](https://docs.warpstream.com/warpstream/reference/api-reference/virtual-clusters/list.md): List all Virtual Clusters in your account. - [Create a Multi-Region Cluster](https://docs.warpstream.com/warpstream/reference/api-reference/virtual-clusters/create-a-multi-region-cluster.md) - [DescribeConfiguration](https://docs.warpstream.com/warpstream/reference/api-reference/virtual-clusters/describeconfiguration.md): Describe the configuration of a specific Virtual Cluster by ID. - [UpdateConfiguration](https://docs.warpstream.com/warpstream/reference/api-reference/virtual-clusters/updateconfiguration.md): Update the configuration of a specific Virtual Cluster by ID. - [Rename](https://docs.warpstream.com/warpstream/reference/api-reference/virtual-clusters/rename.md): Rename a virtual cluster. - [Update Tier](https://docs.warpstream.com/warpstream/reference/api-reference/virtual-clusters/rename-1.md): Update a virtual cluster's tier. - [Virtual Clusters Credentials](https://docs.warpstream.com/warpstream/reference/api-reference/virtual-clusters-credentials.md): APIs for interacting with Virtual Clusters Credentials. - [Create](https://docs.warpstream.com/warpstream/reference/api-reference/virtual-clusters-credentials/create.md): Create new Virtual Cluster Credentials. - [Delete](https://docs.warpstream.com/warpstream/reference/api-reference/virtual-clusters-credentials/delete.md): Delete a Virtual Cluster by ID and name. - [List](https://docs.warpstream.com/warpstream/reference/api-reference/virtual-clusters-credentials/list.md): List all Virtual Clusters Credentials of a given Virtual Cluster. - [ACLs](https://docs.warpstream.com/warpstream/reference/api-reference/acls.md) - [Create ACL](https://docs.warpstream.com/warpstream/reference/api-reference/acls/create-acl.md) - [List ACLs](https://docs.warpstream.com/warpstream/reference/api-reference/acls/list-acls.md) - [Delete ACLs](https://docs.warpstream.com/warpstream/reference/api-reference/acls/delete-acls.md) - [Monitoring](https://docs.warpstream.com/warpstream/reference/api-reference/monitoring.md): APIs for monitoring WarpStream and Consumers. - [Describe All Consumer Groups](https://docs.warpstream.com/warpstream/reference/api-reference/monitoring/describe-all-consumer-groups.md): Describe all consumer groups. - [Describe Account Quotas](https://docs.warpstream.com/warpstream/reference/api-reference/monitoring/describe-quotas.md): Describe account quotas. - [Pipelines](https://docs.warpstream.com/warpstream/reference/api-reference/pipelines.md) - [List Pipelines](https://docs.warpstream.com/warpstream/reference/api-reference/pipelines/list-pipelines.md): Lists all pipelines within a virtual cluster. - [Create Pipeline](https://docs.warpstream.com/warpstream/reference/api-reference/pipelines/create-pipeline.md): Creates a new pipeline in a virtual cluster. - [Delete Pipeline](https://docs.warpstream.com/warpstream/reference/api-reference/pipelines/delete-pipeline.md): Deletes a specific pipeline configuration. - [Describe Pipeline](https://docs.warpstream.com/warpstream/reference/api-reference/pipelines/describe-pipeline.md): Retrieves details about a specific pipeline, including its configurations. - [Create Pipeline Configuration](https://docs.warpstream.com/warpstream/reference/api-reference/pipelines/create-pipeline-configuration.md): Creates a configuration for a pipeline. - [Change Pipeline State](https://docs.warpstream.com/warpstream/reference/api-reference/pipelines/change-pipeline-state.md): Changes the state of an existing pipeline. - [Invitations](https://docs.warpstream.com/warpstream/reference/api-reference/invitations.md): APIs to manage invitations to a WarpStream account - [Create](https://docs.warpstream.com/warpstream/reference/api-reference/invitations/create.md): Create invitations. - [Invoices](https://docs.warpstream.com/warpstream/reference/api-reference/invoices.md): API endpoint for retrieving current and past invoices - [Get Pending Invoice](https://docs.warpstream.com/warpstream/reference/api-reference/invoices/get-pending-invoice.md) - [Get Past Invoice](https://docs.warpstream.com/warpstream/reference/api-reference/invoices/get-past-invoice.md) - [Get Invoice Breakdowns](https://docs.warpstream.com/warpstream/reference/api-reference/invoices/get-invoice-breakdowns.md): Provides a daily breakdown during a time period. - [Tableflow](https://docs.warpstream.com/warpstream/reference/api-reference/tableflow.md) - [List Tables](https://docs.warpstream.com/warpstream/reference/api-reference/tableflow/list-tables.md) - [Get Table](https://docs.warpstream.com/warpstream/reference/api-reference/tableflow/get-table.md) - [Delete/Recreate Table](https://docs.warpstream.com/warpstream/reference/api-reference/tableflow/delete-recreate-table.md) - [Topics](https://docs.warpstream.com/warpstream/reference/api-reference/topics.md) - [Create topic](https://docs.warpstream.com/warpstream/reference/api-reference/topics/create-topic.md) - [List topics](https://docs.warpstream.com/warpstream/reference/api-reference/topics/list-topics.md) - [Describe topic](https://docs.warpstream.com/warpstream/reference/api-reference/topics/describe-topic.md) - [Update topic](https://docs.warpstream.com/warpstream/reference/api-reference/topics/update-topic.md) - [Delete topic](https://docs.warpstream.com/warpstream/reference/api-reference/topics/delete-topic.md) - [Undelete topic](https://docs.warpstream.com/warpstream/reference/api-reference/topics/undelete-topic.md) - [Users](https://docs.warpstream.com/warpstream/reference/api-reference/users.md): APIs for interacting with Users - [Delete](https://docs.warpstream.com/warpstream/reference/api-reference/users/delete.md): Delete a User. - [List](https://docs.warpstream.com/warpstream/reference/api-reference/users/list.md): List all Users in the account. - [Update Roles](https://docs.warpstream.com/warpstream/reference/api-reference/users/update-roles.md): Assign and unassign a User's roles. - [User Roles](https://docs.warpstream.com/warpstream/reference/api-reference/user-roles.md): APIs for interacting with User Roles - [Create](https://docs.warpstream.com/warpstream/reference/api-reference/user-roles/create.md): Create a new User Role. - [Delete](https://docs.warpstream.com/warpstream/reference/api-reference/user-roles/delete.md): Delete a User Role. - [List](https://docs.warpstream.com/warpstream/reference/api-reference/user-roles/list.md): List all User Roles in the account. - [Update](https://docs.warpstream.com/warpstream/reference/api-reference/user-roles/update.md): Update a User Role. - [Workspaces](https://docs.warpstream.com/warpstream/reference/api-reference/workspaces.md): APIs for interacting with Workspaces. - [Create](https://docs.warpstream.com/warpstream/reference/api-reference/workspaces/create.md): Create a new Workspace. - [Delete](https://docs.warpstream.com/warpstream/reference/api-reference/workspaces/delete.md): Delete a workspace. - [List](https://docs.warpstream.com/warpstream/reference/api-reference/workspaces/list.md): List all Workspaces in your account. - [Rename](https://docs.warpstream.com/warpstream/reference/api-reference/workspaces/rename.md): Rename a Workspace. - [CLI Reference](https://docs.warpstream.com/warpstream/reference/cli-reference.md) - [warpstream agent](https://docs.warpstream.com/warpstream/reference/cli-reference/warpstream-agent.md) - [warpstream demo](https://docs.warpstream.com/warpstream/reference/cli-reference/warpstream-demo.md) - [warpstream cli](https://docs.warpstream.com/warpstream/reference/cli-reference/warpstream-kcmd.md) - [warpstream cli-beta](https://docs.warpstream.com/warpstream/reference/cli-reference/warpstream-cli-beta.md) - [benchmark-consumer](https://docs.warpstream.com/warpstream/reference/cli-reference/warpstream-cli-beta/benchmark-consumer.md) - [benchmark-producer](https://docs.warpstream.com/warpstream/reference/cli-reference/warpstream-cli-beta/benchmark-producer.md) - [console-consumer](https://docs.warpstream.com/warpstream/reference/cli-reference/warpstream-cli-beta/console-consumer.md) - [console-producer](https://docs.warpstream.com/warpstream/reference/cli-reference/warpstream-cli-beta/console-producer.md) - [consumer-group-lag](https://docs.warpstream.com/warpstream/reference/cli-reference/warpstream-cli-beta/consumer-group-lag.md) - [diagnose-record](https://docs.warpstream.com/warpstream/reference/cli-reference/warpstream-cli-beta/diagnose-record.md) - [file-reader](https://docs.warpstream.com/warpstream/reference/cli-reference/warpstream-cli-beta/file-reader.md) - [file-scrubber](https://docs.warpstream.com/warpstream/reference/cli-reference/warpstream-cli-beta/file-scrubber.md) - [warpstream playground](https://docs.warpstream.com/warpstream/reference/cli-reference/warpstream-playground.md) - [Integrations](https://docs.warpstream.com/warpstream/reference/integrations.md) - [Arroyo](https://docs.warpstream.com/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](https://docs.warpstream.com/warpstream/reference/integrations/aws-lambda-triggers.md): This page explains how to use WarpStream with AWS's Self Managed Apache Kafka Trigger - [ClickHouse](https://docs.warpstream.com/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](https://docs.warpstream.com/warpstream/reference/integrations/use-warpstream-with-debezium.md): Instructions on how to use WarpStream with Debezium. - [Decodable](https://docs.warpstream.com/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](https://docs.warpstream.com/warpstream/reference/integrations/deltastream.md): Learn how to connect DeltaStream and WarpStream. - [docker-compose](https://docs.warpstream.com/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](https://docs.warpstream.com/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](https://docs.warpstream.com/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](https://docs.warpstream.com/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](https://docs.warpstream.com/warpstream/reference/integrations/deploy-warpstream-to-fly.io.md): Instructions on how to deploy the WarpStream Agents to Fly.io - [Imply](https://docs.warpstream.com/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](https://docs.warpstream.com/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](https://docs.warpstream.com/warpstream/reference/integrations/kafbat-ui-kafka-ui.md): Kafbat UI and kafka-ui are web UIs for managing and monitoring Kafka clusters. - [Kestra](https://docs.warpstream.com/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](https://docs.warpstream.com/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](https://docs.warpstream.com/warpstream/reference/integrations/minio.md): Instructions on integrating WarpStream with MinIO. - [MirrorMaker](https://docs.warpstream.com/warpstream/reference/integrations/mirrormaker.md): This page describes the settings tweaks you may have to do to leverage MirrorMaker to migrate to Warpstream. - [MotherDuck](https://docs.warpstream.com/warpstream/reference/integrations/motherduck.md): MotherDuck provides cloud-based, serverless access to DuckDB - [ngrok](https://docs.warpstream.com/warpstream/reference/integrations/ngrok.md): How to leverage ngrok for testing WarpStream Agents running locally. - [Ockam](https://docs.warpstream.com/warpstream/reference/integrations/ockam.md): Instructions on integrating WarpStream with Ockam. - [OpenTelemetry Collector](https://docs.warpstream.com/warpstream/reference/integrations/opentelemetry-collector.md): This page describes how to connect the OpenTelemetry Collector to WarpStream using the Kafka exporter. - [Parquet](https://docs.warpstream.com/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](https://docs.warpstream.com/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](https://docs.warpstream.com/warpstream/reference/integrations/railway.md): Instructions on how to deploy the WarpStream Agents to Railway. - [Redpanda Console](https://docs.warpstream.com/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](https://docs.warpstream.com/warpstream/reference/integrations/use-warpstream-with-risingwave.md): Instructions on how to use WarpStream with RisingWave. - [Rockset](https://docs.warpstream.com/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](https://docs.warpstream.com/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](https://docs.warpstream.com/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](https://docs.warpstream.com/warpstream/reference/integrations/streambased.md): Instructions on integrating WarpStream with Streambased. - [Streamlit](https://docs.warpstream.com/warpstream/reference/integrations/streamlit.md): Streamlit is a Python library that enables the simple creation of web apps. - [Timeplus](https://docs.warpstream.com/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](https://docs.warpstream.com/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](https://docs.warpstream.com/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](https://docs.warpstream.com/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](https://docs.warpstream.com/warpstream/reference/control-plane-private-connectivity.md) - [Deprecation Policy](https://docs.warpstream.com/warpstream/reference/deprecation-policy.md): This page describes our policy in the event of removal of customer-usable functionality from WarpStream services. --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.warpstream.com/warpstream/reference.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.