Skip to main content
Version: 2.12

Restore Stream

Restores a stream from a snapshot.

Subject

$JS.API.STREAM.RESTORE.{stream}

Where {stream} is the name of the stream.

Request

A response from the JetStream $JS.API.STREAM.RESTORE API

configobjectrequired
stateobjectrequired

Response

A response from the JetStream $JS.API.STREAM.RESTORE API

One of the following:
Option 1 (object)
errorobjectrequired
Option 2 (object)
deliver_subjectstringrequired
The Subject to send restore chunks to
Min length:1
typeconst: "io.nats.jetstream.api.v1.stream_restore_response"