Overview

The Data Streamhouse Public API provides programmatic access to core administrative and operational functions of the platform. It enables organizations to integrate the Data Streamhouse seamlessly into their Infrastructure-as-Code (IaC) pipelines, automated workflows, and enterprise control planes.

The Public API is designed for secure internal use within trusted network environments.


Key Capabilities

Using the Public API, you can:

  • Provision Data Streaming Infrastructure: Configure connections to Kafka clusters, Kinesis streams, and Schema Registries. Create and manage Kafka topics and related infrastructure components dynamically.

  • Manage Metadata and Catalog Information: Create, update, and organize metadata about topics, data streams, and associated resources in the Data Streamhouse catalog.

  • Automate User and Access Control: Manage groups, roles, users, and permissions through automated workflows.

  • License Management: Activate and manage licenses in offline or automated environments using a secure challenge-response process.

  • Monitor and Operate the System: Access system health endpoints and retrieve operational status information.


Typical Use Cases

  • Integrating Data Streamhouse deployments into CI/CD pipelines.

  • Dynamically creating connections and Kafka topics during environment provisioning.

  • Managing user access control and permissions declaratively through orchestration systems.

  • Activating licenses automatically in air-gapped or restricted environments.

  • Building custom internal administration tools around the Data Streamhouse API.


API Structure

All Public API endpoints are organized under:

/public/v1/

Each endpoint is grouped logically by function (e.g., /connections, /catalog, /topics, /license, /groups, etc.).

The API uses standard HTTP methods:

Method
Purpose

GET

Retrieve data

POST

Create resources or trigger operations

PUT

Update resources

DELETE

Remove resources

Responses are provided in JSON format.


Important Notes

  • The Public API is designed for internal integration, not public exposure.

  • Changes made through the API are immediately effective across the platform.

  • All API usage should follow your organization's security and auditability policies.

Last updated

Was this helpful?