ENendclose

Delete a data stream

Changed on

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}

Request

  • Base URL
    https://api.endclose.com/v1
  • Auth
    API key in header X-API-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.

idstring uuid
data_stream_idstring uuid
data_stream_keystring
kind'delete' | 'reset'
status'pending' | 'running' | 'completed' | 'failed'
progressinteger

Percentage 0-100

error_messagestring nullable
records_remaininginteger nullable

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.

started_atstring date-time nullable
completed_atstring date-time nullable
created_atstring date-time
requested_by_user_idstring uuid nullable

Changes

  • 159f9ed3dbf4Revision changes
    • breaking

      the response's property type changed from integer to string, and format from no format to uuid for status

    • breaking

      the response's property type changed from integer to string, and format from no format to uuid for status

    • breaking

      the response's property type changed from integer to string, and format from no format to uuid for status

  • c9135e894f51Revision changes
    • info

      added the optional property to the response with the status