Back to all guides

    API Access & Integration

    Use the Bleach API for custom integrations.

    Overview

    The Bleach API allows you to programmatically access security data, trigger scans, and integrate with your existing tools and workflows.

    Step 1: Generate API Key

    1. Navigate to Settings → API Access
    2. Click "Generate API Key"
    3. Name your key (e.g., "SIEM Integration")
    4. Select permissions scope
    5. Copy and securely store the key

    Step 2: Authentication

    Include your API key in request headers:

    Authorization: Bearer YOUR_API_KEY

    API Endpoints

    • GET /api/v1/issues - List security issues
    • GET /api/v1/score - Get security score
    • POST /api/v1/scans - Trigger a scan
    • GET /api/v1/users - List monitored users
    • GET /api/v1/compliance - Compliance status

    Example Request

    curl -X GET "https://api.yourbleach.com/api/v1/issues" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

    Rate Limits

    • 1000 requests per hour per API key
    • Rate limit headers included in responses
    • Contact support for higher limits

    Best Practices

    • Use separate API keys for different integrations
    • Apply minimum required permissions
    • Rotate keys periodically
    • Monitor API usage in audit logs

    Related Guides

    Configuring Webhooks

    Set up webhooks for real-time event notifications.

    Custom Alert Rules

    Create advanced alerting rules for specific scenarios.

    Need more help?

    Our support team is here to assist you with any questions.

    Contact Support