DocsEnterpriseBlogDownload

API Overview

The KafkaGuard Cloud API is under development. It will provide programmatic access to scanning, reporting, and policy management through a hosted platform.

Current Status

The Cloud API is being built as part of KafkaGuard Cloud (coming soon). Planned capabilities include:

  • Scan Execution — Trigger and schedule scans via REST endpoints
  • Report Generation — Generate and retrieve reports in multiple formats
  • Policy Management — Manage and validate policies programmatically
  • Results Retrieval — Query scan results, findings, and historical trends
  • Webhook Integration — Receive scan completion notifications

Use the CLI Today

The CLI tool is available now and provides full scanning, reporting, and policy management capabilities. There are no limitations — everything you can do with the future API, you can do with the CLI today.

See the CLI Reference for complete command documentation, including:

  • kafkaguard scan — Run security and compliance scans
  • kafkaguard report — Generate reports in JSON, HTML, PDF, and CSV
  • kafkaguard policy — Validate and inspect policies
  • CI/CD integration with --exit-code for pipeline gating

Stay Updated

To be notified when the Cloud API is available:

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

Ready to get started? Download KafkaGuard and scan your first cluster in under 5 minutes. Download CLI | Quick Start Guide