latestOpenAPI 3.1.0MIT2026-08-226224149.1 KB

613ceff68dc7

Delete a data stream

Permanently deletes a data stream and all associated records and property definitions.

Sync vs async: Streams with at most 10,000 records are deleted synchronously and return 204. Streams above that threshold must be deleted asynchronously by passing ?async=true; otherwise the request fails with 409. Callers may also opt into the async path explicitly for any size. The async path returns 202 with a DataStreamOperation payload; poll GET /data_streams/{key}/operations/{id} for progress.

delete/data_streams/{key}

Path parameters

keystring required

The immutable data stream key

Query parameters

async'true' | 'false'

When "true", run the delete asynchronously and return 202 + a DataStreamOperation. Required for streams with more than 10,000 records.

Response

Async delete accepted. Poll GET /data_streams/{key}/operations/{id} (also set in the Location header) until status is completed or failed.

idinteger
data_stream_idinteger
data_stream_keystring
kind'delete' | 'reset'
status'pending' | 'running' | 'completed' | 'failed'
progressinteger

Percentage 0-100

error_messagestring nullable
started_atstring date-time nullable
completed_atstring date-time nullable
created_atstring date-time
requested_by_user_idinteger nullable