Skip to main content
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
HTTPK9O CodeDescription
200Success
403K9O_IAM_POLICY_DENIEDThe bound IAMPolicy ceiling denies streams:delete for this principal.
404K9O_NOT_FOUNDThe project could not be found, or the caller has no project membership.
404K9O_STREAM_NOT_FOUNDNo 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 deleted.

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"
  }
}

More in Realtime Feeds & Streams