title: rest api #

hydrant's REST API is split into public endpoints (safe to expose) and management endpoints (keep private). see getting started for guidance on what to expose.

public #

• GET /stream: stream API, subscribe to the ordered websocket event stream.
• GET /subscribe: jetstream API, subscribe to a filtered, jetstream-compatible websocket event stream.
• GET /stats: get stats about the database (counts of repos, records, events; sizes of keyspaces on disk).
• GET /health / GET /_health: health check.

management #

• filter: NSID filter configuration
• ingestion: enable/disable crawler, firehose, backfill at runtime
• crawler: crawler source management
• firehose: firehose source management
• pds: bans and rate-limit tier assignments
• repos: explicit repository tracking, resyncing, untracking
• database: compression training, compaction