Health Check API

The Health Check API provides endpoints to check the connectivity status of all backend services, and to list which destinations and vector stores are actually available in this deployment.

Check Service Health

GET /api/v1/health/services

Returns the health status of all configured backend services.

Response

{
  "postgres": {"status": "up", "message": "Connected"},
  "mongodb": {"status": "up", "message": "Connected"},
  "minio": {"status": "up", "message": "Connected"},
  "activemq": {"status": "up", "message": "Connected"},
  "kafka": {"status": "up", "message": "Connected"},
  "qdrant": {"status": "not_configured"},
  "weaviate": {"status": "not_configured"},
  "milvus": {"status": "not_configured"},
  "chroma": {"status": "not_configured"},
  "pgvector": {"status": "not_configured"}
}

Status Values

Status	Description
`up`	Service is reachable and responding
`down`	Service is configured but not reachable (includes error message)
`not_configured`	No Vault secret configured for this service

Services Checked

Core infrastructure (always checked):

postgres — PostgreSQL database
mongodb — MongoDB database
minio — MinIO object store
activemq — ActiveMQ message queue
kafka — Apache Kafka

Vector databases (checked only if configured via Vault secrets):

qdrant — Qdrant vector database
weaviate — Weaviate vector database
milvus — Milvus vector database
chroma — Chroma vector database
pgvector — PostgreSQL with pgvector extension

Example

curl http://localhost:8080/api/v1/health/services

List Available Destinations

GET /api/v1/destinations/available

Returns the structured destinations that are usable in this deployment, as a JSON array of destination names. This drives the pipeline wizard’s and Assistant’s destination pickers. Two availability semantics are used on purpose:

Self-hosted destinations (mongodb, postgres, objectstore) are live-probed — a destination is listed only if the service is actually reachable. The presence of a Vault secret alone is not enough, because the compose stack seeds secrets even when a service is disabled.
External destinations (snowflake, databricks, sqlserver) have no local service to probe, so they are listed when any Platform secret contains a complete set of credentials for that destination. For sqlserver that is host plus every field its authMethod needs (sql, the default: user and password; entraServicePrincipal: clientId, clientSecret and tenantId; entraPassword: user and password; entraManagedIdentity: nothing more; kerberos: principal and password). Credential secret names are user-chosen per pipeline, so every Platform secret is scanned rather than a fixed name looked up.

Response

["mongodb", "postgres", "objectstore", "snowflake", "sqlserver"]

Example

curl http://localhost:8080/api/v1/destinations/available

List Available Vector Stores

GET /api/v1/vector-stores/available

Returns the vector stores that are live and reachable, as a JSON array of store keys. This drives the document-tap pipeline wizard’s store picker and the Search tab’s store dropdown, and is the recommended way to discover which stores can be searched via POST /api/v1/search/{store}. Each candidate store (qdrant, weaviate, pgvector, milvus, chroma) is actively probed using the same connectivity checks as /health/services — only stores whose status is up are returned. A store with a configured Vault secret but an unreachable service is excluded.

Response

["pgvector", "qdrant"]

Example

curl http://localhost:8080/api/v1/vector-stores/available

Doctor Report

GET /api/v1/doctor

Runs the server-side configuration and connectivity checks that datris doctor reports and returns them as JSON. This is the endpoint the datris doctor CLI, the Configuration → Doctor page and the run_doctor MCP tool call. It is authenticated: the report names environment keys, Vault paths and model ids, so when API keys are on the calling key must hold the config:read capability. Host-side checks (Docker volumes, container env drift) are only in the CLI.

Query parameters

Parameter	Type	Default	Description
`mode`	string	`full`	`quick` runs only the cheap, startup-safe checks
`probes`	string		Comma-separated opt-in probe groups. Currently `ai`, which sends a minimal request through each AI slot (spends a model call)
`cli`, `mcp`, `ui`	string		Version of the calling client, echoed under `surface.<name>` and compared with the server for the version-skew check

Response

{
  "doctorVersion": 1,
  "ranAt": "2026-11-08T14:05:00Z",
  "mode": "full",
  "surface": {"server": "1.57.1", "cli": "1.57.1"},
  "summary": {"ok": 11, "warn": 1, "error": 0, "skip": 2},
  "checks": [
    {
      "id": "vault.token_ttl",
      "status": "warn",
      "severity": "warn",
      "detail": "Periodic token TTL 720h is under a tenth of its period",
      "remediation": "Raise max_lease_ttl in the Vault config, recreate the vault container, restart the server",
      "surface": "server",
      "ms": 12
    }
  ]
}

status is one of ok, warn, error, skip. The check ids and what fixes each one are listed in Doctor → The checks.

Example

curl -H "x-api-key: $DATRIS_API_KEY" "http://localhost:8080/api/v1/doctor?mode=quick"

Errors: 401 when the API key is missing or rejected ({"error": ...}); 403 when the key lacks config:read.

​Check Service Health

​Response

​Status Values

​Services Checked

​Example

​List Available Destinations

​Response

​Example

​List Available Vector Stores

​Response

​Example

​Doctor Report

​Query parameters

​Response

​Example

Check Service Health

Response

Status Values

Services Checked

Example

List Available Destinations

Response

Example

List Available Vector Stores

Response

Example

Doctor Report

Query parameters

Response

Example