Native HTTP API
This inventory is generated from api/openapi.yaml. Operation IDs, methods,
paths, summaries, authentication policy, and response codes change here in the
same pull request as the contract.
Administration
| Method | Path | Purpose | Auth |
|---|---|---|---|
GET | /admin/v1/backfill-subscriptions | List backfill subscriptions | optional bearer |
POST | /admin/v1/backfill-subscriptions | Create a backfill subscription | optional bearer |
GET | /admin/v1/backfill-subscriptions/{id} | Inspect a backfill subscription | optional bearer |
DELETE | /admin/v1/backfill-subscriptions/{id} | Delete a terminal backfill subscription | optional bearer |
POST | /admin/v1/backfill-subscriptions/{id}/cancel | Cancel a backfill subscription | optional bearer |
GET | /admin/v1/materialization-jobs | List materialization jobs | optional bearer |
POST | /admin/v1/materialization-jobs | Create a materialization job | optional bearer |
GET | /admin/v1/materialization-jobs/{id} | Inspect a materialization job | optional bearer |
DELETE | /admin/v1/materialization-jobs/{id} | Delete a terminal materialization job | optional bearer |
POST | /admin/v1/materialization-jobs/{id}/cancel | Cancel a materialization job | optional bearer |
DELETE | /admin/v1/processors/{processor}/artifacts | Delete retained processor artifacts | optional bearer |
POST | /admin/v1/processors/{processor}/artifacts/replay | Replay retained processor artifacts | optional bearer |
POST | /admin/v1/processors/{processor}/lanes/live/reset | Reset a processor live lane for replay | optional bearer |
GET | /admin/v1/raw-history-jobs | List raw-history jobs | optional bearer |
POST | /admin/v1/raw-history-jobs | Create a raw-history job | optional bearer |
GET | /admin/v1/raw-history-jobs/{id} | Inspect a raw-history job | optional bearer |
DELETE | /admin/v1/raw-history-jobs/{id} | Delete a terminal raw-history job | optional bearer |
POST | /admin/v1/raw-history-jobs/{id}/cancel | Cancel a raw-history job | optional bearer |
Other
| Method | Path | Purpose | Auth |
|---|---|---|---|
GET | /debug/network | Render the dependency-free network dashboard | public |
Health and observability
| Method | Path | Purpose | Auth |
|---|---|---|---|
GET | /health/live | Check process liveness | public |
GET | /health/ready | Check node readiness | public |
GET | /metrics | Read Prometheus metrics | public |
Node
| Method | Path | Purpose | Auth |
|---|---|---|---|
POST | /v1/backfill-subscriptions/{subscription}/consumers/{consumer}/ack | Acknowledge a backfill subscription batch | optional bearer |
GET | /v1/backfill-subscriptions/{subscription}/consumers/{consumer}/changes | Poll changes from one backfill subscription | optional bearer |
POST | /v1/backfill-subscriptions/{subscription}/consumers/{consumer}/lease | Renew a backfill consumer lease | optional bearer |
DELETE | /v1/backfill-subscriptions/{subscription}/consumers/{consumer}/lease | Release a backfill consumer lease | optional bearer |
GET | /v1/backfill-subscriptions/{subscription}/consumers/{consumer}/stream | Stream changes from one backfill subscription | optional bearer |
GET | /v1/capabilities | Discover node capabilities | optional bearer |
GET | /v1/network/status | Read execution network manager status | public |
GET | /v1/processors | List configured processors | optional bearer |
GET | /v1/status | Read node and processor status | optional bearer |
Processor data and delivery
| Method | Path | Purpose | Auth |
|---|---|---|---|
GET | /v1/processors/{processor}/artifacts/{block} | Read one retained processor artifact | optional bearer |
GET | /v1/processors/{processor}/artifacts/export | Export a retained processor artifact range | optional bearer |
GET | /v1/processors/{processor}/artifacts/status | Read retained processor artifact coverage | optional bearer |
GET | /v1/processors/{processor}/changes | List processor changes | optional bearer |
GET | /v1/processors/{processor}/changes/head | Read the processor change head | optional bearer |
GET | /v1/processors/{processor}/checkpoints | List processor recovery checkpoints | optional bearer |
POST | /v1/processors/{processor}/checkpoints/{checkpoint}/restore | Restore a processor recovery checkpoint | optional bearer |
GET | /v1/processors/{processor}/collections | List processor collections | optional bearer |
GET | /v1/processors/{processor}/collections/{collection}/entities | Query processor entities | optional bearer |
GET | /v1/processors/{processor}/collections/{collection}/entities/{key} | Read a processor entity | optional bearer |
POST | /v1/processors/{processor}/collections/{collection}/query-and-follow | Query a collection and open a race-free follow boundary | optional bearer |
GET | /v1/processors/{processor}/consumers | List durable consumers | optional bearer |
POST | /v1/processors/{processor}/consumers | Create a durable consumer | optional bearer |
GET | /v1/processors/{processor}/consumers/{consumer} | Read a durable consumer | optional bearer |
DELETE | /v1/processors/{processor}/consumers/{consumer} | Revoke a durable consumer | optional bearer |
POST | /v1/processors/{processor}/consumers/{consumer}/ack | Acknowledge durable consumer changes | optional bearer |
GET | /v1/processors/{processor}/consumers/{consumer}/changes | List durable consumer changes | optional bearer |
POST | /v1/processors/{processor}/consumers/{consumer}/lease | Renew a durable consumer lease | optional bearer |
DELETE | /v1/processors/{processor}/query-snapshots/{snapshot} | Release a processor query snapshot | optional bearer |
GET | /v1/processors/{processor}/query/blocks/{number} | Read an indexed Ethereum block summary by block number | optional bearer |
GET | /v1/processors/{processor}/query/latest | Read the latest indexed Ethereum block summary | optional bearer |
GET | /v1/processors/{processor}/query/pools | List pools configured for a Uniswap observation processor | optional bearer |
GET | /v1/processors/{processor}/query/pools/{address}/latest | Read the latest observation for one configured Uniswap pool | optional bearer |
GET | /v1/processors/{processor}/savepoints | List processor savepoints | optional bearer |
POST | /v1/processors/{processor}/savepoints | Create a processor savepoint | optional bearer |
GET | /v1/processors/{processor}/savepoints/{savepoint} | Export a processor savepoint | optional bearer |
DELETE | /v1/processors/{processor}/savepoints/{savepoint} | Delete a processor savepoint | optional bearer |
GET | /v1/processors/{processor}/schema | Read a processor schema | optional bearer |
GET | /v1/processors/{processor}/status | Read processor status | optional bearer |
GET | /v1/processors/{processor}/stream | Stream processor changes | optional bearer |
POST | /v1/processors/{processor}/streams/live/consumers/{consumer}/ack | Acknowledge a live-lane consumer batch | optional bearer |
POST | /v1/processors/{processor}/streams/live/consumers/{consumer}/lease | Renew a live-lane consumer lease | optional bearer |
DELETE | /v1/processors/{processor}/streams/live/consumers/{consumer}/lease | Release a live-lane consumer lease | optional bearer |
GET | /v1/processors/{processor}/streams/live/consumers/{consumer}/stream | Stream the dedicated live lane for a durable consumer | optional bearer |
Typed query extensions
| Method | Path | Purpose | Auth |
|---|---|---|---|
GET | /v1/q/blobs/blocks | List indexed blob blocks | optional bearer |
GET | /v1/q/blobs/blocks/{number} | Read an indexed blob block | optional bearer |
GET | /v1/q/blobs/schedule | Read the active blob schedule | optional bearer |
GET | /v1/q/blobs/snapshot | Read an atomic blob block snapshot | optional bearer |
GET | /v1/q/blobs/transactions | List indexed blob transactions | optional bearer |
GET | /v1/q/blobs/transactions/{hash} | Read an indexed blob transaction | optional bearer |
GET | /v1/q/erc20/balances/{token}/{address} | Read an indexed ERC-20 balance | optional bearer |
GET | /v1/q/uniswap/pools/{address} | Read an indexed Uniswap pool | optional bearer |