Check API health

GET 
/api/health

Check the health of the API.

Request

Responses

200

The Health Check is successful

application/json

Schema

Schema

status string

info

object

nullable

property name*

object

nullable

status stringrequired

property name* any

error

object

nullable

property name*

object

nullable

status stringrequired

property name* any

details

object

property name*

object

status stringrequired

property name* any

Example (from schema)

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

400

application/json

Schema

Schema

statusCode integerrequired

HTTP status code

message string

Error message

error string

Error name

Example (from schema)

{
  "statusCode": 404,
  "message": "Cannot find item",
  "error": "Not Found"
}

401

application/json

Schema

Schema

statusCode integerrequired

HTTP status code

message string

Error message

error string

Error name

Example (from schema)

{
  "statusCode": 404,
  "message": "Cannot find item",
  "error": "Not Found"
}

403

application/json

Schema

Schema

statusCode integerrequired

HTTP status code

message string

Error message

error string

Error name

Example (from schema)

{
  "statusCode": 404,
  "message": "Cannot find item",
  "error": "Not Found"
}

404

application/json

Schema

Schema

statusCode integerrequired

HTTP status code

message string

Error message

error string

Error name

Example (from schema)

{
  "statusCode": 404,
  "message": "Cannot find item",
  "error": "Not Found"
}

422

application/json

Schema

Schema

statusCode integerrequired

HTTP status code

message string

Error message

errors

object[]

required

Array [

path stringrequired

Possible values: non-empty

Path to the property with the error

errors

object[]

required

Array [

type stringrequired

Possible values: non-empty

Error type

message stringrequired

Error message

]

]

Example (from schema)

{
  "statusCode": 404,
  "message": "Cannot find item",
  "errors": [
    {
      "path": "business.id",
      "errors": [
        {
          "type": "object_required_property",
          "message": "Required property"
        }
      ]
    }
  ]
}

500

application/json

Schema

Schema

statusCode integerrequired

HTTP status code

message string

Error message

error string

Error name

Example (from schema)

{
  "statusCode": 404,
  "message": "Cannot find item",
  "error": "Not Found"
}

503

The Health Check is not successful

application/json

Schema

Schema

status string

info

object

nullable

property name*

object

nullable

status stringrequired

property name* any

error

object

nullable

property name*

object

nullable

status stringrequired

property name* any

details

object

property name*

object

status stringrequired

property name* any

Example (from schema)

{
  "status": "error",
  "info": {
    "database": {
      "status": "up"
    }
  },
  "error": {
    "redis": {
      "status": "down",
      "message": "Could not connect"
    }
  },
  "details": {
    "database": {
      "status": "up"
    },
    "redis": {
      "status": "down",
      "message": "Could not connect"
    }
  }
}

Loading...