Health API

Display the health status of FlowSynx System.

Health Api options

note

This api doesn't have any options.

Calling Health Api

For calling this api, the following details are required to apply:

URL	Method
http://localhost:5860/health	GET

Now, if we want to have these details in the form of an http api call, open a new terminal and enter the following command:

info

First of all make sure flowsynx is running.

HTTP API (Bash)

curl -X GET http://localhost:5860/health

HTTP API (PowerShell)

Invoke-RestMethod -Method Get -Uri 'http://localhost:5860/health'

Also you can use Http Api test clients to test this api. Anyway, after executing this api, a result like below will be obtained.

{
  "Status": "Healthy",
  "HealthChecks": [
    {
      "Status": "Healthy",
      "Component": "Configuration Registry",
      "Description": "Configuration registry available"
    },
    {
      "Status": "Healthy",
      "Component": "Plugins Registry",
      "Description": "Plugins registry available"
    }
  ],
  "HealthCheckDuration": "00:00:00.0304431"
}

The information including in the result for this api is described as follows:

Status: Display the overall status of flowsynx health state.
HealthChecks: The list of different flowsynx component with details include status and description.
HealthCheckDuration: Refers to the actual time duration taken to run a health check.