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

Documents

rest api /readme.md

- `GET /stream`: [stream API](stream.md), subscribe to the ordered websocket event stream.

crawler management /crawler.md

list all currently active crawler sources. returns a JSON array of `{ "url": string, "mode": "relay" | "by_collection", "persisted": bool }`.

database operations /database.md

null

filter management /filter.md

the `mode` field controls what gets indexed:

firehose management /firehose.md

list all known firehose sources, including offline ones waiting for the retry loop. returns a JSON array of:

ingestion control /ingestion.md

get the current ingestion status. returns `{ "crawler": bool, "firehose": bool, "backfill": bool }`.

jetstream stream /jetstream.md

subscribe to the jetstream websocket stream.

PDS management /pds.md

the per-second limit scales with the number of active accounts on the PDS: `max(per_second_base, accounts × per_second_account_mul)`.

repository management /repos.md

get a list of repositories and their sync status. supports pagination and filtering:

stream /stream.md

`/stream` is not wire- or protocol-compatible with [`tap`](../concepts/vs-tap.md). tap uses a sharded work queue, server-managed acknowledgements, and redelivery; hydrant uses broadcast delivery and client-managed cursors.

hydrant

rest api

public#

management#

Folders

Documents

Media

Files

Search