Health Check
Validate API and database connectivity.
Endpoint
GET /healthAuthentication
Not Required: This endpoint does not require authentication and can be called without an API key.
Response Fields
| Field | Type | Description |
|---|---|---|
| status | string | API status ("ok" when healthy) |
| timestamp | string | ISO 8601 timestamp of the check |
| uptime | number | Server uptime in seconds |
| environment | string | Current environment (e.g., "development", "production") |
| version | string | API version |
| services | object | Status of individual services (api, database) |
| services.api.status | string | API service status |
| services.database.status | string | Database service status |
| services.database.connected | boolean | Database connection state |
Status Codes
| Code | Description |
|---|---|
| 200 | Success - API and database are healthy |
Use Cases
Load Balancer Health Checks
Configure your load balancer to ping this endpoint to determine instance health.
Monitoring and Alerting
Set up automated monitoring to detect API outages and database connectivity issues.
Connection Verification
Verify API connectivity before making authenticated requests.
Base URL: All requests use https://api-development.myneutron.ai which adapts to your environment.