System

Get system health

Changed on

Returns the health of registered components.

get/v1/system/health

Request

  • Base URL: https://example.com/api
  • URL: https://example.com/api/v1/system/health
  • Auth: none required

Response

OK

cache_database'healthy' | 'unhealthy' | 'unknown' required

Health of the cache database.

graph_database'healthy' | 'unhealthy' | 'unknown' required

Health of the graph database.

relational_database'healthy' | 'unhealthy' | 'unknown' required

Health of the relational database.

message_queue'healthy' | 'unhealthy' | 'unknown' required

Health of the message queue.

search'healthy' | 'unhealthy' | 'unknown' required

Health of the search engine.

Changes

  • 8a34c0b5508eRevision changes
    • breaking

      removed the required property from the response with the status

    • info

      added the optional property to the response with the status

  • e51f70b36692Revision changes
    • info

      added the required property to the response with the status