Skip to main content
GET
/
health
/
ready
Check service readiness
curl --request GET \
  --url https://plugin-br-bank-transfer.sandbox.lerian.net/health/ready
{
  "status": "UP",
  "checks": {
    "database": {
      "status": "UP",
      "critical": true
    },
    "cache": {
      "status": "UP",
      "critical": false
    },
    "mongo": {
      "status": "UP",
      "critical": true
    },
    "telemetry": {
      "status": "UP",
      "critical": false
    }
  },
  "timeoutMs": 5000
}

Response

Indicates that the service is ready to accept traffic. Status is UP when all dependencies are healthy, or DEGRADED when an optional dependency is down.

​
status
enum<string>
required

Overall service status. UP when all dependencies are healthy, DEGRADED when an optional dependency is down, DOWN when a mandatory dependency is down.

Available options:
UP,
DEGRADED,
DOWN
Example:

"UP"

​
checks
object
required

Health status of each dependency.

​
timeoutMs
integer
required

Timeout used for dependency checks, in milliseconds.

Example:

5000