Appearance

API Overview ​

KafkaGuard provides a RESTful API for programmatic access to scanning and reporting capabilities. API documentation is currently in development and will be available in a post-MVP release.

API Status ​

Status: Coming Soon (Post-MVP)

The KafkaGuard API will provide programmatic access to:

  • Scan Execution - Trigger scans via API endpoints
  • Report Generation - Generate reports in multiple formats
  • Policy Management - Manage and validate policies
  • Results Retrieval - Query scan results and findings
  • Webhook Integration - Receive scan completion notifications

Planned API Features ​

Scan Management ​

  • Execute scans via REST API
  • Query scan status and results
  • Retrieve historical scan data
  • Manage scan schedules

Report Generation ​

  • Generate reports in JSON, HTML, PDF, CSV formats
  • Customize report templates
  • Export compliance matrices
  • Schedule automated reports

Policy Management ​

  • Validate policy files
  • List available controls
  • Query policy metadata
  • Manage custom policies

Integration ​

  • Webhook support for scan completion
  • Authentication and authorization
  • Rate limiting and quotas
  • API versioning

Current Usage ​

While the API is in development, KafkaGuard can be used via:

  • Command-Line Interface - Full-featured CLI for all operations
  • CI/CD Integration - GitHub Actions and other CI/CD platforms
  • Scripting - JSON output for programmatic processing

See the CLI Reference for current usage.

API Reference ​

For detailed API documentation, see the API Reference page (coming soon).

Stay Updated ​

To be notified when the API is available:

  • Watch the Releases for updates
  • Star the repository to show interest
  • Check the Changelog for release announcements

Feedback ​

Have ideas for the API? We'd love to hear from you:

Next Steps:

Ready to Get Started?

Book a demo to see KafkaGuard in action and learn how it can help secure your Kafka clusters.

📅 Book a Demo