Skip to main content
GET
/
streams
List streams.
curl --request GET \
  --url https://aws.s2.dev/v1/streams \
  --header 'Authorization: Bearer <token>'
{
  "has_more": true,
  "streams": [
    {
      "created_at": "<string>",
      "name": "<string>",
      "deleted_at": "<string>"
    }
  ]
}
Model paging by specifying start_after as the last stream name that was returned.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your access token.

Query Parameters

​
prefix
string
default:""

Filter to streams whose name begins with this prefix.

​
start_after
string
default:""

Filter to streams whose name begins with this prefix. It must be greater than or equal to the prefix if specified.

​
limit
integer
default:1000

Number of results, up to a maximum of 1000.

Required range: 0 <= x <= 1000

Response

​
has_more
boolean
required

Indicates that there are more results that match the criteria.

​
streams
object[]
required

Matching streams.

Maximum array length: 1000