Health

The health endpoint provides a simple health check for the API.

Functionality: Check the status of the API to ensure it is functioning correctly.

Verify the status of the API

Returns a 200 status code if the API is up and running.

Securityoauth_client_credentials_token

Responses

200

Returns a healthcheck document

status required	string The status of the API Example: "UP"
version required	string The version of the API Example: "3.0.0"

401

Invalid authentication credentials

500

Unexpected error occured

get/rest/health

Request samples

Response samples

application/json

{"status": "UP",
"version": "3.0.0"
}