API Reference

Complete API reference documentation for the KafkaGuard RESTful API. This documentation will be available in a post-MVP release.

Status

API Reference: Coming Soon (Post-MVP)

The API reference will include:

• Authentication - API key and OAuth authentication
• Endpoints - Complete endpoint documentation
• Request/Response Formats - JSON schemas and examples
• Error Handling - Error codes and responses
• Rate Limits - API usage limits and quotas
• Code Examples - Examples in multiple languages

Planned Endpoints

Scan Endpoints

• POST /api/v1/scans - Create a new scan
• GET /api/v1/scans/{id} - Get scan status and results
• GET /api/v1/scans - List scans
• DELETE /api/v1/scans/{id} - Delete a scan

Report Endpoints

• GET /api/v1/scans/{id}/reports/{format} - Download report
• POST /api/v1/reports/generate - Generate custom report

Policy Endpoints

• GET /api/v1/policies - List available policies
• GET /api/v1/policies/{id} - Get policy details
• POST /api/v1/policies/validate - Validate policy file

Control Endpoints

• GET /api/v1/controls - List available controls
• GET /api/v1/controls/{id} - Get control details

Current Alternatives

While the API is in development, you can:

Use the CLI

# Execute scans via CLI
kafkaguard scan --bootstrap kafka:9092 --format json --out ./reports

# Parse JSON output programmatically
cat reports/scan-*.json | jq '.summary'

CI/CD Integration

# GitHub Actions example
- name: Run KafkaGuard Scan
  run: |
    kafkaguard scan \
      --bootstrap ${{ secrets.KAFKA_BROKER }} \
      --format json \
      --out ./reports

Scripting

#!/bin/bash
# Process scan results
LATEST_JSON=$(ls -t reports/scan-*.json | head -1)
SCORE=$(cat "$LATEST_JSON" | jq -r '.summary.score')
echo "Compliance score: $SCORE%"

Documentation

For current usage, see:

• CLI Reference - Complete command reference
• Configuration Guide - Configuration options
• Scanning Guide - Scanning usage patterns

Stay Updated

• Watch the Releases for API updates
• Check the Changelog for release announcements
• Follow GitHub Releases for version updates

---

Next Steps:

• API Overview - Return to API overview
• CLI Reference - Current command-line interface
• Community - Join the community

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