Download OpenAPI specification:
Initial OpenAPI definition for a health-check endpoint following draft-inadarei-api-health-check-06.
The Internet-Draft specifies the application/health+json response format; the /health path used here is a
conventional implementation choice.
Returns the health of the service and, optionally, detailed health observations for downstream dependencies or sub-components.
{- "status": "pass",
- "version": "1",
- "releaseId": "1.2.2",
- "serviceId": "f03e522f-1f44-4062-9b55-9587f91c9c41",
- "description": "Health of authorization service",
- "checks": {
- "cassandra:responseTime": [
- {
- "componentId": "dfd6cf2b-1b6e-4412-a0b8-f6f7797a60d2",
- "componentType": "datastore",
- "observedValue": 250,
- "observedUnit": "ms",
- "status": "pass",
- "affectedEndpoints": [
- "/users/{userId}"
], - "time": "2018-01-17T03:36:48Z"
}
]
},
}