Retrieve stream

Retrieve a stream by its identifier.

Securityoidc-token or oauth2-client-credentials or oauth2-open-industrial-data or oauth2-auth-code
Request
path Parameters
streamId
required
string [ 1 .. 100 ] characters ^[a-z]([a-z0-9_-]{0,98}[a-z0-9])?$

An identifier of the stream where the records are stored.

Example: test1
query Parameters
includeStatistics
boolean

If set to true, usage statistics will be returned together with stream settings.

Responses
200

Stream retrieved.

400

The response for a failed request.

get/streams/{streamId}
Request samples 
Response samples 
application/json
{
  • "externalId": "test1",
  • "createdTime": 1730204346000,
  • "createdFromTemplate": "ImmutableTestStream",
  • "type": "Immutable",
  • "settings": {
    • "lifecycle": {
      },
    • "limits": {
      }
    }
}
➔ Next to Records