For the latest stable version, please use Korvet 0.19!

Admin API

Korvet exposes an HTTP Admin API under /api/v1 for topic administration, consumer-group inspection, and monitoring snapshots.

The Admin API is protected with HTTP Basic authentication. Admin credentials are stored in Redis through the same credential store used by broker SASL users, with the reserved tenant id admin.

Authentication

Configure the bootstrap admin credential with:

korvet:
  admin:
    username: admin
    password: admin
    bootstrap: true

Change the default password before exposing the API outside a local development environment.

Topics

  • POST /api/v1/topics creates a topic.

  • GET /api/v1/topics lists topics.

  • GET /api/v1/topics/{name} returns one topic.

  • PUT /api/v1/topics/{name} replaces explicit topic configuration.

  • DELETE /api/v1/topics/{name} deletes a topic.

Consumer Groups

  • GET /api/v1/consumer-groups lists consumer groups.

  • GET /api/v1/consumer-groups/{groupId} returns group state and members.

Monitoring

  • GET /api/v1/health returns a stable Admin API health schema backed by Spring Boot health.

  • GET /api/v1/metrics returns a curated metrics snapshot.

  • GET /api/v1/storage-stats returns remote storage diagnostics when available.

OpenAPI

OpenAPI JSON is available at /v3/api-docs.

Swagger UI is available at /swagger-ui.html.