This endpoint provides system-wide health information and operational status.
This endpoint is publicly accessible and does not require authentication.
Request
curl -X GET "https://api.g2cplatform.com/v2/health"
Response
{
"status": "healthy",
"timestamp": "2024-03-15T10:30:00Z",
"version": "2.0.0",
"uptime": 1847293,
"checks": {
"database": "healthy",
"blockchain": "healthy",
"storage": "healthy"
}
}
Response Fields
| Field | Type | Description |
|---|
status | string | Overall system health: healthy, degraded, or unhealthy |
timestamp | string | ISO 8601 timestamp of the health check |
version | string | Current API version |
uptime | integer | System uptime in seconds |
checks | object | Health status of individual system components |
checks.database | string | Database connectivity status |
checks.blockchain | string | Blockchain network status |
checks.storage | string | File storage system status |
Status Codes
| Status Code | Description |
|---|
| 200 | API is healthy and operational |
| 503 | Service unavailable - API is unhealthy |
Health Status Values
Overall Status
- healthy: All systems operational
- degraded: Some non-critical issues detected
- unhealthy: Critical systems are down
Component Status
- healthy: Component is operational
- unhealthy: Component is not functioning properly
Usage Notes
- This endpoint is useful for monitoring and alerting systems
- No authentication required - publicly accessible
- Use this for uptime monitoring and health dashboards
- The endpoint returns quickly to avoid timeout issues during health checks
- Critical for load balancer health checks and system monitoring
