API Reference

This section of the documentation contains the API reference for the WarpStream public API endpoints.

The WarpStream API allows programatically interacting with various aspects of the WarpStream control plane. Example request / response payloads are provided for different API endpoints.

Authentication

All API requests should be issued as POST requests with JSON payloads, and authentication for all endpoints is managed via the warpstream-api-key header with the value set to a WarpStream Application Key generated in the admin console.