WarpStream Monitoring API
Monitor consumer groups and cluster health
WarpStream Monitoring API is one of 8 APIs that WarpStream publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Monitoring. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 1 operation across 1 path, and defines 2 schemas. It is described by OpenAPI 3.0.3, at version 1.0.0.
Requests are made against a single base URL, https://api.warpstream.com.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
WarpStream Monitoring API declares
1 security scheme
for authenticating requests.
An API key is passed in the header as warpstream-api-key (ApiKeyAuth).
By default, every request must be authenticated.
ApiKeyAuth— WarpStream API key. Three key types are supported: Application Keys (manage workspace-specific resources), Agent Keys (scoped to a specific virtual cluster), a…
Paths & Operations 1
Across 1 path, the API surfaces 1 operation — 1 POST. Each is listed below with its method, path, parameters, and response codes.
Monitor consumer groups and cluster health
Schemas 2
The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are ConsumerGroup (5 properties), ConsumerGroupMember (5 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from WarpStream 7
Other APIs WarpStream publishes across the network.