Skip to main content

GET /health

Simple health check endpoint to verify that the Resource Service is running and responding to requests. This endpoint is useful for monitoring, load balancers, and orchestration systems.

Authentication

No authentication required.

Response

message
string
required
A greeting message indicating the service is operational.

Example Request

curl -X GET https://api.example.com/health

Example Response

Success

{
  "message": "Hello from resource service!"
}

Status Codes

200 OK
status
The service is running normally and accepting requests.

Notes

  • This endpoint always returns a 200 status code if the service is running
  • It does not check the health of dependent services (database, RabbitMQ, etc.)
  • For production monitoring, consider implementing additional health checks that verify:
    • Database connectivity
    • Message queue connectivity
    • Disk space availability
    • Memory usage

Build docs developers (and LLMs) love