API Reference

Check API health status. No authentication required.

Response

{ "status": "healthy", "timestamp": "2024-01-15T10:00:00Z" }

Authenticate and receive a JWT token.

Request Body

{
  "email": "user@example.com",
  "password": "your-password"
}

Response

{
  "token": "<jwt-token>",
  "user": {
    "email": "user@example.com",
    "tier": "professional"
  }
}

Get current authenticated user information.

Response

{
  "user": {
    "email": "user@example.com",
    "tier": "professional",
    "created_at": "2024-01-01T00:00:00Z"
  }
}

List all scans for the authenticated user.

Query Parameters

• type - Filter by scan type (cspm, dast, runtime)
• status - Filter by status (completed, running, failed)
• limit - Number of results (default: 20)

Response

{
  "scans": [
    {
      "id": "scan-123",
      "scan_type": "cspm",
      "status": "completed",
      "created_at": "2024-01-15T10:00:00Z",
      "results": { ... }
    }
  ]
}

Submit scan results from CLI.

Request Body

{
  "scan_type": "cspm",
  "provider": "aws",
  "status": "completed",
  "results": {
    "summary": { "total": 245, "passed": 198, "failed": 42 },
    "findings": [ ... ]
  }
}

Response

{
  "id": "scan-456",
  "status": "completed",
  "created_at": "2024-01-15T10:30:00Z"
}

Get detailed scan results by ID.

Response

{
  "id": "scan-123",
  "scan_type": "cspm",
  "provider": "aws",
  "status": "completed",
  "created_at": "2024-01-15T10:00:00Z",
  "completed_at": "2024-01-15T10:05:00Z",
  "results": {
    "summary": { "total": 245, "passed": 198, "failed": 42 },
    "by_severity": { "critical": 3, "high": 12, "medium": 18 },
    "by_service": { "S3": 5, "IAM": 8, "EC2": 10 },
    "findings": [ ... ]
  }
}

Generate a new API key for programmatic access.

Request Body

{
  "name": "CI/CD Pipeline",
  "expires_in_days": 365
}

Response

{
  "api_key": "<generated-api-key>",
  "name": "CI/CD Pipeline",
  "expires_at": "2025-01-15T00:00:00Z"
}