Reset a data stream
Asynchronously wipes all records on the stream while preserving stream config, property definitions, and reconciliation links. Always async. Poll the returned operation.
Completion is verified. The operation reaches completed only after the stream is confirmed empty in the primary database, with records_remaining set to 0. Records that land while the reset is running are swept up a bounded number of times; if any survive, the operation ends failed with records_remaining greater than 0 and an error_message asking you to stop ingestion and retry. Do not reload data onto the stream until you observe completed.
Authorizations
Path Parameters
The immutable data stream key
Response
Reset accepted. Poll GET /data_streams/{key}/operations/{id} (also set in the Location header).
Async operation against a data stream (delete or reset). Poll via GET /data_streams/{key}/operations/{id}. An operation only reaches completed once the stream is verified empty in the primary database; if records outlive the wipe (for example, ingestion landing mid-reset), it ends failed with records_remaining > 0 and an error_message asking you to retry.
delete, reset pending, running, completed, failed Percentage 0-100
Number of records still on the stream when the operation reached a terminal state, counted in the primary database (not the analytics mirror behind records_count, which can lag). 0 on completed; greater than 0 on a failed operation that left records behind; null while pending or running. After a reset, trust this field rather than re-listing /records.