Skip to content

Stream endpoints

CRUD for stream definitions on /api/streams.

Stream endpoints manage entries in the meta-stream (config('streams.core.streams_id')) that store stream JSON definitions.

List streams

curl -s "http://localhost/api/streams"

Returns collection in data.

Show stream

curl -s "http://localhost/api/streams/posts"

Create stream

curl -s -X POST "http://localhost/api/streams" \
  -H "Content-Type: application/json" \
  -d '{"id":"posts","name":"Posts","fields":[]}'

Returns 201 with links.location.

Update stream

curl -s -X PUT "http://localhost/api/streams/posts" \
  -H "Content-Type: application/json" \
  -d '{"name":"Blog Posts"}'

PATCH accepts partial updates.

Delete stream

curl -s -X DELETE "http://localhost/api/streams/posts"

Returns 204 No Content.

Related