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 Workspaces API

Manage WarpStream workspaces (account-level)

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

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

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

2 operations 2 paths 3 schemas 1 GET1 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 Workspaces 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 2

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

Workspaces 2

Manage WarpStream workspaces (account-level)

GET
/api/v1/list_workspaces
List Workspaces
listWorkspaces → 200
POST
/api/v1/create_workspace
Create Workspace
createWorkspace body → 200

Schemas 3

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

Workspace
object
3 properties
ApiKey
object
5 properties
AccessGrant
object
Permission grant for an API key
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

warpstream-workspaces-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 Virtual Clusters API