/health

Last updated 10 days ago

Performs the health check.

Performs the health check for the server. What this actually does is deployment and implementation specific. However, any successful response code should indicate that the service is capable of servicing requests. Any unsuccessful error codes should indicate that the instance has internal issues and should be taken offline.

get

/health

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://localhost:8080/api/rest/health' \
  --header 'Authorization: YOUR_API_KEY'

400

401

403

404

409

500

501

503

default

{
  "code": "text",
  "message": "text"
}