Health Request

Request URL

GET /health

Description

This endpoint is used to check the health of the application. Currently, a successful response indicates that the server is listening.

Snippet Examples

javascript

const axios = require('axios');
const config = {
  method: 'GET',
  url: '${CONNECTFI_BASE_URL}/health',
  headers: {

  },
};

let result;
try {
  result = await axios.request(config);
  if (result.status === 200) {
    console.log(JSON.stringify(result.data));
  }
} catch (err) {
  console.log({
    errCode: err.code,
    responseStatus: err.response && err.response.status,
    data: err.response && JSON.stringify(err.response.data)
  });
}

cURL

curl --location "CONNECTFI_BASE_URL/health"  

Successful Response Examples

200 HEALTH SUCCESSFUL RESPONSE

HEADERS

Header	Value

REQUEST BODY

none

RESPONSE BODY

{
    "code": "0",
    "data": {
        "status": true,
        "name": "connectfi",
        "version": "1.0.108"
    }
}