Get Stream Config

Retrieve the configuration of a stream

GET /streams/{stream}/config

Get Stream Config

cURL

curl --request GET \
  --url https://api.example.com/streams/{stream}/config

200

{
  "storage_class": "<string>",
  "retention_policy": {},
  "timestamping": {
    "mode": "<string>",
    "uncapped": true
  },
  "delete_on_empty": {
    "min_age_secs": 123
  }
}

Overview

Retrieve the current configuration settings for a stream, including storage class, retention policy, timestamping behavior, and delete-on-empty settings.

Authentication

This endpoint requires authentication via the S2-Basin header containing your basin name.

Path Parameters

stream · string · required

The name of the stream.

Example: logs/application

Response

storage_class · string

Storage class for recent writes:

• standard - Append tail latency under 400ms
• express - Append tail latency under 40ms

retention_policy · object

Retention policy for the stream.

Show RetentionPolicy

One of:

• {"age": <seconds>} - Automatic trimming of records older than this age in seconds
• {"infinite": {}} - Retain records unless explicitly trimmed

timestamping · object

Timestamping behavior configuration.

Show TimestampingConfig

mode · string

Timestamping mode:

• client-prefer - Prefer client timestamp if present, otherwise use arrival time
• client-require - Require client timestamp, reject if missing
• arrival - Use arrival time, ignore client timestamp

uncapped · boolean

Whether client timestamps can exceed arrival time. If false, client timestamps are capped at arrival time.

delete_on_empty · object

Automatic deletion configuration for empty streams.

Show DeleteOnEmptyConfig

min_age_secs · number

Minimum age in seconds before an empty stream can be deleted. If 0, automatic deletion is disabled.

Example Request

cURL

curl -X GET 'https://{basin}.b.aws.s2.dev/v1/streams/logs%2Fapplication/config' \
  -H 'S2-Basin: my-basin' \
  -H 'Authorization: Bearer YOUR_TOKEN'

Stream names in the URL must be properly URL-encoded. For example, logs/application becomes logs%2Fapplication.

Example Response

{
  "storage_class": "standard",
  "retention_policy": {
    "age": 604800
  },
  "timestamping": {
    "mode": "client-prefer",
    "uncapped": false
  },
  "delete_on_empty": {
    "min_age_secs": 0
  }
}

Error Responses

• 404 Not Found - Stream does not exist
• 400 Bad Request - Invalid stream name
• 403 Forbidden - Insufficient permissions to view the configuration