# Create purge

URL: https://docs.hanzo.ai/docs/openapi/mq/post-mq-stream-by-name-purge

> Removes messages from a stream, leaving its consumers in place.

`POST /v1/mq/stream/{name}/purge`

> [MQ →](https://docs.hanzo.ai/docs/openapi/mq) · [All API references →](https://docs.hanzo.ai/docs/openapi) · [Get started →](https://docs.hanzo.ai/docs/guides)

|               |                                                  |
| ------------- | ------------------------------------------------ |
| **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 (uint64) | —        | Keep retains that many newest messages.                                         |
| `name`   | body | string           | —        | Name is the stream name, from the path.                                         |

## Response

| Status    | Body            | Meaning |
| --------- | --------------- | ------- |
| `200`     | mq.purgeOut     | ok      |
| `default` | problem-details | refused |

`200` body — 1 field.

| Field    | In   | Type             | Always | Description                               |
| -------- | ---- | ---------------- | ------ | ----------------------------------------- |
| `purged` | body | integer (uint64) | —      | Purged is the number of messages removed. |

Failure carries the platform error shape — see [Errors](https://docs.hanzo.ai/docs/errors).

## Examples

**CLI**

```bash
hanzo mq stream purge <name>
```

**SDK**

**.ts**

```ts
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 });
```

**.py**

```python
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)
```

**.go**

```go
cfg := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)

resp, _, err := client.MqAPI.PostMqStreamByNamePurge(context.Background()).Execute()
if err != nil {
	return err
}
```

**.rs**

```rust
use hanzo_client::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?;
```

**.java**

```java
import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.MqApi;

ApiClient client = new ApiClient();
client.setBearerToken(System.getenv("HANZO_API_KEY"));

var result = new MqApi(client).postMqStreamByNamePurge();
```

**HTTP**

```bash
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
     }'
```

**MCP**

MCP reaches **mq** through the `mq` tool, which names its 15 operations with its own verbs — this one among them, under a name only MCP declares. `describe` explains any of them:

```bash
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"
         }
       }
     }'
```

---

[MQ API](https://docs.hanzo.ai/docs/openapi/mq) · [All Hanzo APIs](https://docs.hanzo.ai/docs/openapi) · [Interactive reference](https://docs.hanzo.ai/docs/openapi/reference)