Removes messages from a stream, leaving its consumers in place.
Removes messages from a stream, leaving its consumers in place.
POST /v1/mq/stream/{name}/purge
| Address | https://api.hanzo.ai/v1/mq/stream/{name}/purge |
| Method | POST |
| Operation | post_mq_stream_by_name_purge |
| Auth | Authorization: Bearer $HANZO_API_KEY |
Removes messages from a stream, leaving its consumers in place.
Request
4 fields, body application/json (required).
| Field | In | Type | Required | Description |
|---|---|---|---|---|
name | path | string | yes | Name is the stream name, from the path. |
filter | body | string | — | Filter purges only messages on this org-relative subject (wildcards supported). |
keep | body | integer | — | Keep retains that many newest messages. |
name | body | string | — | Name is the stream name, from the path. |
Response
| Status | Body | Meaning |
|---|---|---|
200 | purgeOut | ok |
200 body — 1 field.
| Field | In | Type | Always | Description |
|---|---|---|---|---|
purged | body | integer | — | Purged is the number of messages removed. |
Failure carries the platform error shape — see Errors.
Examples
hanzo has no subcommand for this operation — the CLI serves only what cloud's live route table confirms. Use HTTP or an SDK.
import { Configuration, MqApi } from 'hanzoai';
const api = new MqApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.postMqStreamByNamePurge({ name: 'name', filter: "<filter>", keep: 0 });from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import MqApi
client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = MqApi(client).post_mq_stream_by_name_purge(name='name', filter="<filter>", keep=0)cfg := cloud.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := cloud.NewAPIClient(cfg)
resp, _, err := client.MqAPI.PostMqStreamByNamePurge(context.Background()).Execute()
if err != nil {
return err
}use hanzo_cloud::apis::{configuration::Configuration, mq_api};
let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();
let result = mq_api::post_mq_stream_by_name_purge(&cfg, Default::default()).await?;import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.MqApi;
ApiClient client = new ApiClient();
client.setRequestInterceptor(b -> b.header("Authorization", "Bearer " + System.getenv("HANZO_API_KEY")));
var result = new MqApi(client).postMqStreamByNamePurge();The method above is the one at the current release of the document. [email protected] (npm) and [email protected] (PyPI) were generated from an earlier release, where this operation carried a different id, so it spells the method differently — regenerating the clients is what makes the two agree. SDKs →
curl -X POST https://api.hanzo.ai/v1/mq/stream/<name>/purge \
-H "Authorization: Bearer $HANZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"filter": "<filter>",
"keep": 0
}'The door reaches mq through the mq tool, which names its 15 operations with its own verbs — this one among them, under a name only the door declares. describe explains any of them:
curl -X POST https://api.hanzo.ai/v1/mcp \
-H "Content-Type: application/json" \
-d '{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "describe",
"arguments": {
"op": "get_mq_health"
}
}
}'How is this guide?