Skip to main content

System Endpoints

System endpoints expose runtime health, readiness, metrics, storage status, cluster links, maintenance actions, and protocol metadata.

Probe Endpoints​

GET /health​

Health check endpoint. This route is intended for load balancers and uptime checks.

curl http://localhost:9200/health

GET /ready​

Readiness check endpoint. Use this when a process manager needs to know whether hlquery is ready to accept normal traffic.

curl http://localhost:9200/ready

GET /ping​

Lightweight ping endpoint.

curl http://localhost:9200/ping

Status and Startup​

GET /​

Root maps to the same route action as /status.

curl http://localhost:9200/

GET /status​

Basic server status.

curl http://localhost:9200/status

GET /query​

Compatibility alias for status.

curl http://localhost:9200/query

GET /startup​

Startup and boot information.

curl http://localhost:9200/startup

GET /boot-status​

Alias for /startup.

curl http://localhost:9200/boot-status

Metrics and Counters​

GET /stats​

Runtime statistics and storage details where available.

curl http://localhost:9200/stats

GET /metrics​

JSON metrics payload.

curl http://localhost:9200/metrics

GET /metrics.json​

Alias for /metrics.

curl http://localhost:9200/metrics.json

GET /metrics/history​

Historical metrics where available.

curl http://localhost:9200/metrics/history

GET /metrics-history​

Alias for /metrics/history.

curl http://localhost:9200/metrics-history

GET /connections​

Active connection count.

curl http://localhost:9200/connections

GET /doctotal​

Total document and collection counters.

curl http://localhost:9200/doctotal

GET /cache​

Search/cache status endpoint.

curl http://localhost:9200/cache

GET /search-config​

Search configuration summary.

curl http://localhost:9200/search-config

GET /config-files​

Runtime configuration file metadata.

curl http://localhost:9200/config-files

GET/POST /update-counters​

Recompute document counters.

curl -X POST http://localhost:9200/update-counters

GET /debug/counters​

Counter diagnostics.

curl http://localhost:9200/debug/counters

Storage​

GET /rocksdb​

RocksDB status and storage information where available.

curl http://localhost:9200/rocksdb

GET /_rocksdb​

Alias for /rocksdb.

curl http://localhost:9200/_rocksdb

GET /admin/storage_status​

Admin-only storage status endpoint.

curl -H "X-API-Key: admin-token" http://localhost:9200/admin/storage_status

Maintenance​

GET /integrity​

Run integrity checks.

curl http://localhost:9200/integrity

GET /consistency​

Alias for /integrity.

curl http://localhost:9200/consistency

GET /self-check​

Runtime self-check report.

curl http://localhost:9200/self-check

GET/POST /repair​

Run repair checks.

curl -X POST http://localhost:9200/repair

POST /flush​

Flush all data. This route is destructive and admin-only.

curl -X POST -H "X-API-Key: admin-token" http://localhost:9200/flush

Presets​

GET /presets​

List saved presets.

curl http://localhost:9200/presets

POST/PUT /presets/{preset}​

Create or update a preset.

curl -X PUT http://localhost:9200/presets/default-search \
  -H "Content-Type: application/json" \
  -d '{"query_by":"title,content","limit":10}'

GET /presets/{preset}​

Get a preset by name.

curl http://localhost:9200/presets/default-search

DELETE /presets/{preset}​

Delete a preset.

curl -X DELETE http://localhost:9200/presets/default-search

List configured cluster links and reachability.

curl http://localhost:9200/links

GET /links/ping​

Ping configured links and return link state.

curl http://localhost:9200/links/ping

POST /links/connect​

Add a runtime link. This change is in-memory unless your deployment persists it separately.

curl -X POST http://localhost:9200/links/connect \
  -H "Content-Type: application/json" \
  -d '{"endpoint":"127.0.0.1:9201"}'

POST /links/disconnect​

Remove a runtime link.

curl -X POST http://localhost:9200/links/disconnect \
  -H "Content-Type: application/json" \
  -d '{"endpoint":"127.0.0.1:9201"}'

GET /collections/distributed​

List collections across the local node and configured links.

curl http://localhost:9200/collections/distributed

Runtime Metadata​

GET /etc​

Protocol metadata used by clients and tooling.

curl http://localhost:9200/etc

GET /search-config​

Search configuration summary.

curl http://localhost:9200/search-config