API Reference
Hanzo PubSub API
Hanzo PubSub provides high-performance publish/subscribe messaging with
Hanzo PubSub provides high-performance publish/subscribe messaging with
bearerAuth — HTTP bearerBearerAuth — HTTP bearer
All Hanzo APIs share one bearer credential and common error and pagination conventions. See API conventions.
curl -H "Authorization: Bearer $HANZO_API_KEY" https://pubsub.hanzo.ai
| Method | Endpoint | Description |
|---|
GET | /v1/pubsub/jetstream/streams/{stream}/consumers | List consumers |
POST | /v1/pubsub/jetstream/streams/{stream}/consumers | Create a consumer |
GET | /v1/pubsub/jetstream/streams/{stream}/consumers/{consumer} | Get consumer info |
DELETE | /v1/pubsub/jetstream/streams/{stream}/consumers/{consumer} | Delete a consumer |
| Method | Endpoint | Description |
|---|
GET | /healthz | Health check |
| Method | Endpoint | Description |
|---|
POST | /v1/pubsub/kv/{bucket} | Create a KV bucket |
DELETE | /v1/pubsub/kv/{bucket} | Delete a KV bucket |
GET | /v1/pubsub/kv/{bucket}/{key} | Get a value |
PUT | /v1/pubsub/kv/{bucket}/{key} | Set a value |
DELETE | /v1/pubsub/kv/{bucket}/{key} | Delete a key |
GET | /v1/pubsub/kv/{bucket}/{key}/history | Get key history |
| Method | Endpoint | Description |
|---|
GET | /v1/pubsub/varz | Server statistics |
GET | /v1/pubsub/connz | Connection details |
GET | /v1/pubsub/jsz | JetStream info |
GET | /v1/pubsub/routez | Cluster routes |
GET | /v1/pubsub/gatewayz | Gateway status |
GET | /v1/pubsub/leafz | Leaf node info |
GET | /v1/pubsub/subsz | Subscription info |
| Method | Endpoint | Description |
|---|
GET | /v1/pubsub/objects/{bucket} | List objects in a bucket |
GET | /v1/pubsub/objects/{bucket}/{name} | Download an object |
PUT | /v1/pubsub/objects/{bucket}/{name} | Upload an object |
DELETE | /v1/pubsub/objects/{bucket}/{name} | Delete an object |
| Method | Endpoint | Description |
|---|
POST | /v1/pubsub/publish | Publish a message |
| Method | Endpoint | Description |
|---|
POST | /v1/pubsub/request | Request/reply |
| Method | Endpoint | Description |
|---|
GET | /v1/pubsub/jetstream/streams | List streams |
POST | /v1/pubsub/jetstream/streams | Create a stream |
GET | /v1/pubsub/jetstream/streams/{stream} | Get stream info |
PUT | /v1/pubsub/jetstream/streams/{stream} | Update stream config |
DELETE | /v1/pubsub/jetstream/streams/{stream} | Delete a stream |
| Method | Endpoint | Description |
|---|
GET | /v1/pubsub/subscribe | Subscribe to a subject (SSE) |
Hanzo PubSub API guide · All Hanzo APIs · OpenAPI spec
How is this guide?