Skip to main content
GET
/
actuator
/
health
API health
curl --request GET \
  --url https://sandbox.waftpay.io/api/actuator/health
{
  "status": "UP",
  "groups": [
    "liveness",
    "readiness"
  ]
}

​
Health Check Endpoint

The Health Check endpoint lets you verify that the Waftpay API is online and reachable. It’s a lightweight GET request that returns the current status of the service.

​
When to use

  • Monitoring – Integrate into uptime tools (e.g. Pingdom, Datadog, New Relic) to alert if the API becomes unavailable.
  • Readiness Probes – Use this endpoint in container orchestration systems (Kubernetes, Docker) to decide if an instance is ready to accept traffic.
  • Debugging – Quickly confirm if issues are due to your integration or a wider service outage.

​
Request

GET {BASE_URL}/actuator/health

Response

200 - application/json

Healthy

​
status
enum<string>
required
Available options:
UP,
DOWN
​
groups
string[]