Utilities

Endpoint responsible for verifying the integrity and operability of the service. Checks are performed on the routes and integrity of the connection to the database.

Requires authentication: Not required

HTTP status code 200 OK indicates that the service is operational, if there is any problem in the operation, it will return code 503 Service Unavailable

Verify integrity and operation of the service

get

Responses

200

The Health Check is successful

application/json

503

The Health Check is not successful

application/json

get

HTTPcURLJavaScriptPython

GET /health-check HTTP/1.1
Host: 
Accept: */*

{
  "status": "ok",
  "info": {
    "database": {
      "status": "up"
    }
  },
  "error": {},
  "details": {
    "database": {
      "status": "up"
    }
  }
}