Health Check

Check Platform API service health status

Overview

Check the health status of the Platform API service. This endpoint is used for monitoring and load balancer health checks.

Example

Check API Health

GET /platform/health

Response (200 OK):

{
  "status": "RUNNING"
}

Response Fields

FieldTypeDescription
statusstringService status. Returns "RUNNING" when healthy.

Use Cases

  • Load Balancer Health Checks: Configure your load balancer to poll this endpoint
  • Monitoring Systems: Integrate with monitoring tools to track API availability
  • Container Orchestration: Use as liveness/readiness probe in Kubernetes

Notes

  • This endpoint does not require authentication
  • Returns HTTP 200 when the service is running
  • Does not verify database connectivity or downstream service health
Language
Credentials
Header
Click Try It! to start a request and see the response here!