Skip to main content
DELETE
/
data_streams
/
{key}
Delete a data stream
curl --request DELETE \
  --url https://api.endclose.com/v1/data_streams/{key} \
  --header 'X-API-KEY: <api-key>'
{
  "id": 123,
  "data_stream_id": 123,
  "data_stream_key": "<string>",
  "progress": 123,
  "error_message": "<string>",
  "started_at": "2023-11-07T05:31:56Z",
  "completed_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "requested_by_user_id": 123
}

Authorizations

​
X-API-KEY
string
header
required

Path Parameters

​
key
string
required

The immutable data stream key

Query Parameters

​
async
enum<string>

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

Available options:
true,
false

Response

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

Async operation against a data stream (delete or reset). Poll via GET /data_streams/{key}/operations/{id}.

​
id
integer
​
data_stream_id
integer
​
data_stream_key
string
​
kind
enum<string>
Available options:
delete,
reset
​
status
enum<string>
Available options:
pending,
running,
completed,
failed
​
progress
integer

Percentage 0-100

​
error_message
string | null
​
started_at
string<date-time> | null
​
completed_at
string<date-time> | null
​
created_at
string<date-time>
​
requested_by_user_id
integer | null