Health

/api/health

The /api/health endpoint provides a live health check of the cluster, executing a new health check every time it is invoked.

GET /api/health
{
  "status": "UP",
  "components": {
    "gateway": {
      "status": "UP",
      "components": {
        "auth": {
          "status": "UP"
        },
        "hello": {
          "status": "UP"
        },
        "openapi": {
          "status": "UP"
        }
      }
    },
    "kafka": {
      "status": "UP",
      "components": {
        "connection": {
          "status": "UP"
        }
      }
    },
    "minio": {
      "status": "UP",
      "components": {
        "connection": {
          "status": "UP"
        }
      }
    },
    "superset": {
      "status": "UP",
      "components": {
        "database": {
          "status": "UP"
        }
      }
    },
    "v1arcadedb": {
      "status": "UP",
      "components": {
        "openapi": {
          "status": "UP"
        },
        "ready": {
          "status": "UP"
        }
      }
    },
    "v1audit": {
      "status": "UP",
      "components": {
        "eventcount": {
          "status": "UP"
        },
        "openapi": {
          "status": "UP"
        }
      }
    },
    "v1courier": {
      "status": "UP",
      "components": {
        "listinboxes": {
          "status": "UP"
        },
        "openapi": {
          "status": "UP"
        }
      }
    },
    "v1kafka": {
      "status": "UP",
      "components": {
        "config": {
          "status": "UP"
        },
        "openapi": {
          "status": "UP"
        }
      }
    },
    "v1lakehouse": {
      "status": "UP",
      "components": {
        "openapi": {
          "status": "UP"
        },
        "schemas": {
          "status": "UP"
        }
      }
    },
    "v1registry": {
      "status": "UP",
      "components": {
        "openapi": {
          "status": "UP"
        },
        "schemas": {
          "status": "UP"
        },
        "version": {
          "status": "UP"
        }
      }
    },
    "v1s3": {
      "status": "UP",
      "components": {
        "countbuckets": {
          "status": "UP"
        },
        "openapi": {
          "status": "UP"
        }
      }
    },
    "v2catalog": {
      "status": "UP",
      "components": {
        "datasources": {
          "status": "UP"
        },
        "openapi": {
          "status": "UP"
        }
      }
    }
  },
  "groups": [
    "api",
    "liveness",
    "readiness"
  ]
}

You can also get the health from just a group of components. Below is an example of the health of just Kafka.

GET /api/health/kafka
{
  "status": "UP",
  "components": {
    "connection": {
      "status": "UP"
    }
  },
  "groups": [
    "api",
    "liveness",
    "readiness"
  ]
}