System / Health
Health Check
Check the health and operational status of the Neutron API. Returns service availability, database connectivity, and system metrics. Use this endpoint for uptime monitoring, health checks in container orchestration, or debugging connectivity issues.
GET
{baseAPIUrl}/healthAuthentication
Not Required: This endpoint does not require authentication and can be called without an API key.
Response
| 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 |
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.