> ## Documentation Index > Fetch the complete documentation index at: https://docs.xerobi.com/llms.txt > Use this file to discover all available pages before exploring further. # Health Check > Returns server health status, uptime, memory usage, and total test count. **Use Cases:** - Monitor API availability - Track server performance - Verify connectivity before testing **Note**: This endpoint does not require the Xerobi-Version header. Returns server health status, uptime, memory usage, and total test count. ## OpenAPI ````yaml GET /health openapi: 3.1.0 info: title: Xerobi Speed Test API description: >- A comprehensive network speed testing API with advanced metrics, real-time progress tracking, result history, and comparative analysis. ## Overview The Xerobi Speed Test API provides powerful network performance testing capabilities: - **Basic Metrics**: Individual tests for ping, jitter, download, and upload speeds - **Advanced Tests**: Multi-file testing for more accurate measurements - **Full Speed Tests**: Comprehensive analysis with quality scoring - **Real-time Monitoring**: Server-Sent Events (SSE) for live progress tracking - **Historical Data**: Store and retrieve test results with statistics - **Comparative Analysis**: Compare results over time - **Server Selection**: Test against specific servers ## Authentication Most endpoints require the `Xerobi-Version` header: ```bash curl -H "Xerobi-Version: 2.0.0" \ https://api.hixbe.com/speedtest/full ``` **Exceptions**: The `/` (docs) and `/health` endpoints don't require this header. ## Rate Limits - **Basic endpoints** (ping, download, upload): 60 requests/minute - **Full/Advanced tests**: 10 requests/minute - **Results/Stats endpoints**: 120 requests/minute Rate limit information is included in response headers. ## Test Result Storage Results from these endpoints are automatically stored: - `/ping` - Basic latency tests - `/download` - Download speed tests - `/upload` - Upload speed tests - `/full` - Comprehensive tests - `/advanced` - Advanced multi-file tests Each stored result receives a unique ID for later retrieval. ## Quality Score Calculation The quality score (0-100) is calculated based on: - **Ping** (30%): < 20ms = excellent, < 50ms = good, < 100ms = fair - **Jitter** (20%): < 5ms = excellent, < 15ms = good, < 30ms = fair - **Download** (25%): Relative to expected speeds - **Upload** (20%): Relative to expected speeds - **Packet Loss** (5%): 0% = perfect, < 1% = excellent, < 5% = acceptable ## Server-Sent Events (SSE) The `/stream` endpoint provides real-time progress updates: ```javascript const eventSource = new EventSource('/speedtest/stream', { headers: { 'Xerobi-Version': '2.0.0' } }); eventSource.addEventListener('ping', (e) => { const data = JSON.parse(e.data); console.log('Ping:', data.result, 'ms'); }); eventSource.addEventListener('finish', (e) => { const data = JSON.parse(e.data); console.log('Complete:', data.result); eventSource.close(); }); ``` ## Best Practices 1. **Use appropriate test types**: Use basic tests for quick checks, advanced tests for accuracy 2. **Handle rate limits**: Implement exponential backoff for retries 3. **Store results**: Use result IDs to track performance over time 4. **Compare wisely**: Use `/comparison` and `/stats` for trend analysis 5. **Real-time updates**: Use `/stream` for UI progress indicators 6. **Server selection**: Use `/servers` to find optimal test servers ## Support - Website: https://hixbe.com - Documentation: https://docs.hixbe.com/speedtest - Status: https://status.hixbe.com version: 2.0.0 contact: name: Xerobi Support url: https://hixbe.com email: support@xerobi.com license: name: MIT url: https://opensource.org/licenses/MIT servers: - url: https://api.hixbe.com/speedtest description: Production server security: [] tags: - name: Information description: API information, documentation, and health checks - name: Basic Metrics description: Individual speed test metrics (ping, jitter, download, upload) - name: Advanced Tests description: Comprehensive and multi-file speed tests for accuracy - name: Results & History description: Retrieve stored test results with filtering and statistics - name: Real-time description: Real-time test monitoring via Server-Sent Events (SSE) - name: Servers description: Test server management and selection paths: /health: get: tags: - Information summary: Health Check description: >- Returns server health status, uptime, memory usage, and total test count. **Use Cases:** - Monitor API availability - Track server performance - Verify connectivity before testing **Note**: This endpoint does not require the Xerobi-Version header. operationId: healthCheck responses: '200': description: Server is healthy and operational content: application/json: schema: $ref: '#/components/schemas/HealthResponse' example: success: true timestamp: '2025-12-07T10:30:00.000Z' data: status: healthy uptime: 3600 memory: used: 45 total: 256 unit: MB totalTests: 42 environment: production executionTime: 1ms security: [] components: schemas: HealthResponse: type: object properties: success: type: boolean example: true timestamp: type: string format: date-time data: type: object properties: status: type: string enum: - healthy - degraded - down example: healthy uptime: type: number description: Server uptime in seconds example: 3600 memory: type: object properties: used: type: number description: Used heap memory example: 45 total: type: number description: Total heap memory example: 256 unit: type: string example: MB totalTests: type: integer description: Total number of tests performed example: 42 minimum: 0 environment: type: string example: production required: - status - uptime - memory - totalTests executionTime: type: string required: - success - timestamp - data ```` ## Related topics - [Get Service Status](https://docs.xerobi.com/rpki-api/endpoint/get-service-status.md) - [NTP Servers](https://docs.xerobi.com/more/ntp-servers.md) - [Get Status](https://docs.xerobi.com/rpki-api/endpoint/get-status.md) - [Content Filtering FAQ](https://docs.xerobi.com/faq-guides/content-filtering.md) - [Check Route Validity (Query)](https://docs.xerobi.com/rpki-api/endpoint/check-validity-query.md) This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.