DELETE
/data-streams/user/{streamSlug}Delete Stream
Deletes a user stream by its slug.
Its retained messages are removed and its reserved storage is returned to the organization's allotment; the slug can be used again.
Answers with the slug and status: deleted.
Needs PROJECT_ADMIN.
Audited as data.write.pulse_stream.deleted.
Parameters
| streamSlug * | path | The Pulse Stream's slug. |
| projectSlug * | path | The project's slug: the path segment after It is unique within the org. |
Responses
| HTTP | K9O Code | Description |
|---|---|---|
| 200 | Success | |
| 403 | K9O_IAM_POLICY_DENIED | The bound IAMPolicy ceiling denies streams:delete for this principal. |
| 404 | K9O_NOT_FOUND | The project could not be found, or the caller has no project membership. |
| 404 | K9O_STREAM_NOT_FOUND | No active Pulse Stream with that slug exists in this project. |
Response body (200)
| data * | object | The stream that was deleted. |
| slug * | string | The slug of the stream that was deleted. |
| status * | "deleted" | Always |
| meta * | any |
TypeScript
// const k9o = new K9o({ orgSlug: 'playground', projectSlug: 'storefront', apiKey: 'k9o_…' })
const { data } = await k9o.streams.delete('<streamSlug>')Showing example in TypeScript
Response example (200)
{
"data": {
"slug": "string",
"status": "deleted"
}
}