> ## Documentation Index > Fetch the complete documentation index at: https://docs.hiperai.com/llms.txt > Use this file to discover all available pages before exploring further. # Audit Logs > Retrieve SMLTP audit logs # Audit Logs Retrieve SMLTP (Secure Model Language Transfer Protocol) audit logs for security monitoring and compliance. ## Endpoint ``` GET /audit-logs ``` ## Description This endpoint returns SMLTP audit logs that track security events, policy violations, and compliance activities. This is useful for security monitoring, compliance auditing, and investigating security incidents. ## Authentication **Required**: API Key with admin privileges ``` Authorization: Bearer sk-your-api-key-here ``` ## Query Parameters | Parameter | Type | Required | Description | | | ----------- | ------- | -------- | ----------- | ------------------------------------------ | | `page` | integer | No | 1 | Page number for pagination (default: 1) | | `limit` | integer | No | 50 | Number of logs per page (default: 50) | | `startDate` | string | No | - | Start date for filtering (ISO 8601 format) | | `endDate` | string | No | - | End date for filtering (ISO 8601 format) | | `type` | string | No | - | Filter by log type | | `severity` | string | No | - | Filter by severity level | | `userId` | string | No | - | Filter by user ID | | `search` | string | No | - | Search term for description or metadata | ## Example Request ```bash theme={null} GET /audit-logs?startDate=2024-01-01T00:00:00Z&endDate=2024-01-20T23:59:59Z&severity=info&limit=20 ``` ## Success Response **Status Code**: `200 OK` ```json theme={null} { "success": true, "data": { "logs": [ { "id": "60a7c8f5e8b4f5001f7a8c23", "timestamp": "2024-01-15T10:30:00.000Z", "type": "smltp_policy_management", "severity": "info", "description": "External API: Created new SMLTP policy Custom Policy", "user": { "id": "60a7c8f5e8b4f5001f7a8c24", "name": "John Doe", "email": "john@example.com" }, "metadata": { "endpoint": "/api/external/smltp-policies", "policyId": "custom-policy", "policyName": "Custom Policy", "setAsActive": false, "apiKeyId": "60a7c8f5e8b4f5001f7a8c25" }, "complianceCategory": "data_protection", "outcome": "success" } ], "pagination": { "page": 1, "limit": 50, "total": 150, "pages": 3 }, "dateRange": { "startDate": "2024-01-08T10:30:00.000Z", "endDate": "2024-01-15T10:30:00.000Z" } } } ``` ### Response Fields | Field | Type | Description | | -------------------------------- | ------- | ----------------------------------------- | | `success` | boolean | Indicates if the operation was successful | | `data` | object | Response data object | | `data.logs` | array | Array of audit log objects | | `data.logs[].id` | string | Unique audit log identifier | | `data.logs[].timestamp` | string | Log timestamp (ISO 8601) | | `data.logs[].type` | string | Type of audit event | | `data.logs[].severity` | string | Severity level | | `data.logs[].description` | string | Event description | | `data.logs[].user` | object | User information (if available) | | `data.logs[].user.id` | string | User ID | | `data.logs[].user.name` | string | User name | | `data.logs[].user.email` | string | User email | | `data.logs[].metadata` | object | Additional metadata | | `data.logs[].complianceCategory` | string | Compliance category | | `data.logs[].outcome` | string | Event outcome | | `data.pagination` | object | Pagination information | | `data.pagination.page` | integer | Current page number | | `data.pagination.limit` | integer | Items per page | | `data.pagination.total` | integer | Total number of logs | | `data.pagination.pages` | integer | Total number of pages | | `data.dateRange` | object | Date range information | ## Example Usage ### JavaScript ```javascript theme={null} const getAuditLogs = async (params = {}) => { const queryString = new URLSearchParams(params).toString(); const url = `https://{customer.name}.hiperai.ai/api/external/audit-logs${queryString ? `?${queryString}` : ''}`; const response = await fetch(url, { method: 'GET', headers: { 'Authorization': 'Bearer sk-your-api-key-here' } }); return await response.json(); }; // Example usage const result = await getAuditLogs({ startDate: '2024-01-01T00:00:00Z', endDate: '2024-01-20T23:59:59Z', severity: 'info', limit: 20 }); console.log(result.data.logs); ``` ### Python ```python theme={null} import requests def get_audit_logs(params=None): url = "https://{customer.name}.hiperai.ai/api/external/audit-logs" headers = { "Authorization": "Bearer sk-your-api-key-here" } response = requests.get(url, headers=headers, params=params) return response.json() # Example usage params = { "startDate": "2024-01-01T00:00:00Z", "endDate": "2024-01-20T23:59:59Z", "severity": "info", "limit": 20 } result = get_audit_logs(params) print(result["data"]["logs"]) ``` ### cURL ```bash theme={null} curl -X GET "https://{customer.name}.hiperai.ai/api/external/audit-logs?startDate=2024-01-01T00:00:00Z&endDate=2024-01-20T23:59:59Z&severity=info&limit=20" \ -H "Authorization: Bearer sk-your-api-key-here" ``` ## Error Responses ### 401 Unauthorized ```json theme={null} { "success": false, "error": { "code": "UNAUTHORIZED", "message": "Invalid or missing API key" } } ``` ### 403 Forbidden ```json theme={null} { "success": false, "error": { "code": "INSUFFICIENT_PERMISSIONS", "message": "Admin privileges required" } } ``` ### 429 Too Many Requests ```json theme={null} { "success": false, "error": { "code": "RATE_LIMIT_EXCEEDED", "message": "Rate limit exceeded", "retryAfter": 60 } } ``` ## Filtering Examples ### Date Range ```bash theme={null} # Get logs from last 7 days GET /audit-logs?startDate=2024-01-13T00:00:00Z&endDate=2024-01-20T23:59:59Z # Get logs from specific date GET /audit-logs?startDate=2024-01-20T00:00:00Z&endDate=2024-01-20T23:59:59Z ``` ### Event Filtering ```bash theme={null} # Get all SMLTP policy management events GET /audit-logs?type=smltp_policy_management # Get info level events GET /audit-logs?severity=info ``` ### User Filtering ```bash theme={null} # Get logs for specific user GET /audit-logs?userId=60a7c8f5e8b4f5001f7a8c24 # Search in descriptions GET /audit-logs?search=policy ``` ## Use Cases * **Security Monitoring**: Monitor security events and policy violations * **Compliance Auditing**: Track compliance activities and violations * **Incident Investigation**: Investigate security incidents and breaches * **Policy Analysis**: Analyze policy effectiveness and enforcement * **User Activity**: Track user actions and API usage ## Rate Limits * **Default**: 100 requests per minute * **Daily**: 10,000 requests per day * **Monthly**: 300,000 requests per month ## Notes * This endpoint requires admin privileges * Pagination: Uses page parameter, not offset * Date Range: Defaults to last 7 days if no dates provided * Search: Searches in description and metadata.operation fields * Nested Response: Response is nested under data object * User Info: User information is populated when available * Logs are retained for compliance purposes ## OpenAPI ````yaml GET /audit-logs openapi: 3.0.3 info: title: SecureAI External API description: > SecureAI External API provides AI chat completion and image generation capabilities with knowledge base retrieval, security policies, and comprehensive usage tracking. This API is designed for external developers and integrations using API key authentication. ## Key Features - **RAG (Retrieval-Augmented Generation)**: Automatically search knowledge bases for relevant context - **Multi-Model Support**: OpenAI, Anthropic, Google, Meta, and other AI models - **Model Redundancy & Failover**: Caller-defined failover chains (primary + fallbacks) with per-attempt timeouts - **OpenAI-Compatible Endpoint**: Point any OpenAI SDK at `/api/external/v1` — no code changes - **Image Generation**: Generate and edit images using Google Gemini 2.5 Flash Image - **Speech-to-Speech (S2S)**: Real-time voice conversations using OpenAI Realtime API with WebRTC - **Security Policies**: SMLTP policy enforcement, per-call Prompt Shield, and signed compliance receipts - **Usage Tracking**: Comprehensive usage monitoring, self-service quota, and rate limiting - **Knowledge Base Integration**: Access to personal and shared knowledge bases - **User Management**: Complete user, group, and role management capabilities - **Audit Logging**: Comprehensive activity and security audit logs ## Authentication All endpoints (except health check) require API key authentication using Bearer token: ``` Authorization: Bearer sk-your-api-key-here ``` ## Billing and Usage By default, API requests are billed to the user account that owns the API key. You can specify a different user to bill by including the `user_id` parameter in your request. This allows for: - Multi-tenant applications with per-user billing - Flexible completion limit management - Per-user "Usage by Model" settings ## Rate Limits - Default: 60 requests per minute, 1000 requests per hour - Daily limits: 100 requests (configurable) - Monthly limits: 10,000 requests (configurable) ## Base URL ``` https://secureai.hiperai.ai/api/external ``` version: 1.1.0 contact: name: SecureAI Support email: support@secureai.hiperai.ai license: name: Proprietary url: https://secureai.hiperai.ai/terms servers: - url: https://secureai.hiperai.ai/api/external description: Production server - url: http://localhost:3010/api/external description: Development server security: - ApiKeyAuth: [] tags: - name: System description: System health and status endpoints - name: Discovery description: Endpoints to discover available models, indexes, and policies - name: Chat description: AI chat completion endpoints - name: User Management description: Endpoints for managing user accounts and roles - name: Index Management description: Endpoints for managing knowledge base indexes - name: Group Management description: Endpoints for managing user groups - name: SMLTP Security description: Endpoints for managing SMLTP security policies and audit logs - name: Role Management description: Endpoints for managing user roles - name: Activity Logs description: Endpoints for retrieving activity logs externalDocs: description: SecureAI Documentation url: https://secureai.hiperai.ai/docs paths: /audit-logs: get: tags: - SMLTP Security summary: Get SMLTP Audit Logs description: > Retrieve SMLTP audit logs with filtering. Only accessible by administrators. parameters: - name: page in: query description: Page number for pagination required: false schema: type: integer default: 1 minimum: 1 - name: limit in: query description: Number of logs per page required: false schema: type: integer default: 50 minimum: 1 maximum: 100 - name: startDate in: query description: Start date for filtering (ISO 8601 format) required: false schema: type: string format: date-time - name: endDate in: query description: End date for filtering (ISO 8601 format) required: false schema: type: string format: date-time - name: type in: query description: Filter by log type required: false schema: type: string - name: severity in: query description: Filter by severity level required: false schema: type: string enum: - info - warning - error - critical - name: userId in: query description: Filter by user ID required: false schema: type: string - name: search in: query description: Search term for description or metadata required: false schema: type: string responses: '200': description: SMLTP audit logs content: application/json: schema: type: object properties: success: type: boolean example: true data: type: object properties: logs: type: array items: type: object properties: id: type: string example: 60a7c8f5e8b4f5001f7a8c23 timestamp: type: string format: date-time example: '2024-01-15T10:30:00.000Z' type: type: string example: smltp_policy_management severity: type: string example: info description: type: string example: >- External API: Created new SMLTP policy Custom Policy user: type: object nullable: true properties: id: type: string example: 60a7c8f5e8b4f5001f7a8c24 name: type: string example: John Doe email: type: string example: john@example.com metadata: type: object description: Additional metadata complianceCategory: type: string example: data_protection outcome: type: string example: success pagination: type: object properties: page: type: integer example: 1 limit: type: integer example: 50 total: type: integer example: 150 pages: type: integer example: 3 dateRange: type: object properties: startDate: type: string format: date-time example: '2024-01-08T10:30:00.000Z' endDate: type: string format: date-time example: '2024-01-15T10:30:00.000Z' '401': description: Invalid API key content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Access denied - admin only content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - ApiKeyAuth: [] components: schemas: ErrorResponse: type: object properties: success: type: boolean example: false error: type: string example: Invalid API key message: type: string example: The provided API key is invalid or has been revoked request_id: type: string example: req-abc123 description: Request ID for tracking (if available) securitySchemes: ApiKeyAuth: type: http scheme: bearer description: | API key authentication using Bearer token format. Example: `Authorization: Bearer sk-your-api-key-here` ````