getHealth

GET

/health

const url = 'http://localhost:8080/api/v1/health';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url http://localhost:8080/api/v1/health

Responses

200

Server is up.

application/json

object

status

required

string

Allowed values: ok degraded

version

required

string

dbOk

boolean

Examples

seed

Derived from fixtures/seed.json.

{
  "dbOk": true,
  "status": "ok",
  "version": "1.0.0"
}