Skip to content
Brokerium

Overview

Control plane for Apache Kafka clusters.

Brokerium REST API v1

Section titled “Brokerium REST API v1”

REST API of brokerium-server, used by the embedded dashboard and by automation.

Authentication. POST /api/v1/auth/login returns a session token and sets the brokerium_session cookie. Send the token either as the cookie or as Authorization: Bearer <token>.

CSRF. Every request with a method other than GET or HEAD must carry the X-Brokerium-Request: 1 header.

Roles. viewer reads, operator changes clusters and runs operations, admin also manages users and deletes clusters. Each operation notes the minimum role.

Operations. Every change to cluster topology is an operation: POST /clusters/{id}/operations returns a planned operation with a dry-run plan; nothing changes until POST /operations/{op}/confirm. Irreversible operations require confirmName equal to the cluster name.

Errors use {"error": {"code": "...", "message": "..."}}.

Apache, Apache Kafka and Kafka are trademarks of the Apache Software Foundation. Brokerium is not affiliated with the ASF.

Operations

Section titled “Operations”
GET
/healthz
GET
/readyz
GET
/api/v1/version
POST
/api/v1/auth/login
POST
/api/v1/auth/logout
GET
/api/v1/auth/me
GET
/api/v1/overview
GET
/api/v1/clusters
POST
/api/v1/clusters
POST
/api/v1/clusters/test
GET
/api/v1/clusters/{id}
DELETE
/api/v1/clusters/{id}
PATCH
/api/v1/clusters/{id}
POST
/api/v1/clusters/{id}/refresh
GET
/api/v1/clusters/{id}/rates
GET
/api/v1/clusters/{id}/brokers/{broker}/configs
PATCH
/api/v1/clusters/{id}/brokers/{broker}/configs
POST
/api/v1/clusters/{id}/topics
GET
/api/v1/clusters/{id}/topics/{topic}
DELETE
/api/v1/clusters/{id}/topics/{topic}
PATCH
/api/v1/clusters/{id}/topics/{topic}/configs
POST
/api/v1/clusters/{id}/topics/{topic}/partitions
GET
/api/v1/clusters/{id}/topics/{topic}/messages
POST
/api/v1/clusters/{id}/topics/{topic}/messages
GET
/api/v1/clusters/{id}/groups/{group}
DELETE
/api/v1/clusters/{id}/groups/{group}
POST
/api/v1/clusters/{id}/groups/{group}/reset-offsets
GET
/api/v1/clusters/{id}/acls
POST
/api/v1/clusters/{id}/acls
DELETE
/api/v1/clusters/{id}/acls
GET
/api/v1/clusters/{id}/scram-users
POST
/api/v1/clusters/{id}/scram-users
DELETE
/api/v1/clusters/{id}/scram-users/{user}
GET
/api/v1/clusters/{id}/quotas
PUT
/api/v1/clusters/{id}/quotas
GET
/api/v1/operation-types
GET
/api/v1/clusters/{id}/operations
POST
/api/v1/clusters/{id}/operations
GET
/api/v1/operations
GET
/api/v1/operations/{op}
DELETE
/api/v1/operations/{op}
POST
/api/v1/operations/{op}/confirm
POST
/api/v1/operations/{op}/pause
POST
/api/v1/operations/{op}/resume
POST
/api/v1/operations/{op}/cancel
GET
/api/v1/nodes
DELETE
/api/v1/nodes/{id}
POST
/api/v1/join-tokens
GET
/api/v1/agent/install.sh
GET
/api/v1/users
POST
/api/v1/users
DELETE
/api/v1/users/{id}
PATCH
/api/v1/users/{id}
GET
/api/v1/audit

Authentication

Section titled “Authentication”

sessionCookie

Section titled “sessionCookie”

Security scheme type: apiKey

Cookie parameter name: brokerium_session

bearerToken

Section titled “bearerToken”

The session token returned by POST /api/v1/auth/login.

Security scheme type: http

Apache®, Apache Kafka® and Kafka® are either registered trademarks or trademarks of the Apache Software Foundation in the United States and/or other countries. Brokerium is not affiliated with, endorsed by, or sponsored by the Apache Software Foundation.