# Очистка потока

Очистка сообщений потока.

<!-- -->

## Тема

`$JS.API.STREAM.PURGE.{stream}`

Где `{stream}` — имя потока.

## Запрос

Запрос к API JetStream $JS.API.STREAM.PURGE

filterstring

Ограничить очистку сообщениями указанной темы

seqinteger

Удалить все сообщения до указанного порядкового номера, не включая его. Совместимо с фильтром темы, но не с keep

Беззнаковое 64-битное целое число

Минимум:`0`

Максимум:`18446744073709552000`

keepinteger

Сохраняет указанное число сообщений после очистки. Совместимо с фильтром темы, но не с порядковым номером

Беззнаковое 64-битное целое число

Минимум:`0`

Максимум:`18446744073709552000`

## Ответ

Ответ API JetStream $JS.API.STREAM.PURGE

Развернуть всё

Один из следующих вариантов:

Вариант

<!-- -->

1

<!-- -->

(

<!-- -->

object

<!-- -->

)

▶errorobjectобязательно

Вариант

<!-- -->

2

<!-- -->

(

<!-- -->

object

<!-- -->

)

successbooleanобязательно

purgedintegerобязательно

Число сообщений, удалённых при очистке потока

Беззнаковое 64-битное целое число

Минимум:`0`

Максимум:`18446744073709552000`

typeconst: "io.nats.jetstream.api.v1.stream\_purge\_response"обязательно
