Health check API

The Luma Automation API 'Health Checkup' is used to run a Health checkup on the Luma Automation application. The Super Administrators can execute the web service and verify if the automation application is up and running.

Use the following details to configure API:

  1. Use URI: /gateway/actuator/health

  2. HTTP Method for the operation: GET

  3. As a response, the web service fetches the Luma Automation application status and information on other services running. Following details are received as Response:

    1. HTTP Status Code. This represents the overall status of the Luma automation application, Code 200 indicates that the application is running and is accessible.

    2. Response Body: The section holds health status of various components in the Luma automation application. The response is received in following format:

      { "status": "UP", "components": { "db": { "status": "UP", "details": { "database": "MySQL", "validationQuery": "isValid()" } }, "jms": { "status": "UP", "components": { "activeMQConnectionFactory": { "status": "UP", "details": { "provider": "ActiveMQ" } }, "jmsCachingConnectionFactory": { "status": "UP", "details": { "provider": "ActiveMQ" } }, "jmsPooledConnectionFactory": { "status": "UP", "details": { "provider": "ActiveMQ" } } } }, "ping": { "status": "UP" } } }