Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

WarpStream Virtual Clusters API

Manage Kafka-compatible virtual clusters

WarpStream Virtual Clusters API is one of 8 APIs that WarpStream publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Virtual Clusters. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 3 operations across 3 paths, and defines 4 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.

3 operations 3 paths 4 schemas 1 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0.0
Base URL
https://api.warpstream.com
Authentication
API Key
Resource Areas
1

Authentication & Security 1

WarpStream Virtual Clusters 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 3

Across 3 paths, the API surfaces 3 operations — 1 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Virtual Clusters 3

Manage Kafka-compatible virtual clusters

GET
/api/v1/list_virtual_clusters
List Virtual Clusters
listVirtualClusters → 200
POST
/api/v1/create_virtual_cluster
Create Virtual Cluster
createVirtualCluster body → 200
POST
/api/v1/delete_virtual_cluster
Delete Virtual Cluster
deleteVirtualCluster body → 200

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are VirtualCluster (10 properties), ApiKey (5 properties), AccessGrant (4 properties). Each schema is shown below with its type and property counts.

ApiKey
object
5 properties
EmptyResponse
object
Empty JSON object indicating success
VirtualCluster
object
10 properties
AccessGrant
object
Permission grant for an API key
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

warpstream-virtual-clusters-api-openapi.yml Raw ↑

Other APIs WarpStream publishes across the network.

WarpStream ACLs API
WarpStream API Keys API
WarpStream Monitoring API
WarpStream Pipelines API
WarpStream Topics API
WarpStream Virtual Cluster Credentials API
WarpStream Workspaces API