SRS-054: API Health Check Endpoint
Identifier​
SRS-054
Software System​
- API Gateway
- Orchestrator
Category​
- Maintenance
- Functional
Description​
The software shall provide a public, unauthenticated health check endpoint at GET /health
. This endpoint is intended for use by automated monitoring and load balancing systems.
- Endpoint behavior: When a request is made to this endpoint, the system shall perform a quick, internal check to verify its operational status.
- Healthy response: If the system is healthy and ready to serve traffic, it shall respond with an HTTP
200 OK
status code and a JSON body indicating the status, such as{"status": "ok"}
. - Unhealthy response: If the system detects an internal issue and is not able to serve traffic correctly, it shall respond with an appropriate server error status code (e.g.,
503 Service Unavailable
).
Derived from PRS​
PRS-005
: Expose the device’s functionality through a versioned, network-accessible API