API health status

Returns the API health status, database, and payment providers

GET /health

API health status

cURL

curl --request GET \
  --url https://api-sandbox.rinne.com.br/core/health

200

{
  "status": "OK",
  "database": "CONNECTED",
  "environment": "DEVELOPMENT",
  "providers": {
    "enabled": 2,
    "initialized": 2,
    "health": [
      {
        "name": "RINNE",
        "status": "HEALTHY",
        "responseTime": 150,
        "lastChecked": "2023-12-01T10:00:00.000Z"
      }
    ]
  }
}

Response

200

application/json

OK status

status · string

Example:

"OK"

database · enum<string>

Available options: CONNECTED, DISCONNECTED

Example:

"CONNECTED"

environment · enum<string>

Available options: DEVELOPMENT, PRODUCTION, TEST

Example:

"DEVELOPMENT"

providers · object

Show child attributes