Health check

Returns the health status of the Bifrost server. Checks connectivity to config store, log store, and vector store if configured.

GET /health

Error

A valid request URL is required to generate request examples

200

{
  "status": "ok",
  "components": {}
}

Authorizations

BearerAuthBasicAuthApiKeyAuth

Authorization · string · header · required

Bearer token authentication. Use your provider API key or Bifrost authentication token. Virtual keys (prefixed with sk-bf-) can also be passed here.

Response

200

application/json

Server is healthy

Health check response

status · enum<string>

Available options: ok

Example:

"ok"

components · object

Health status of individual components (config_store, log_store, vector_store)

Show child attributes