Skip to main content
GET
/
basins
/
{basin}
Get basin configuration.
curl --request GET \
  --url https://aws.s2.dev/v1/basins/{basin} \
  --header 'Authorization: Bearer <token>'
{
  "create_stream_on_append": false,
  "create_stream_on_read": false,
  "default_stream_config": {
    "delete_on_empty": {
      "min_age_secs": 1
    },
    "retention_policy": {
      "age": 1
    },
    "storage_class": "standard",
    "timestamping": {
      "mode": "client-prefer",
      "uncapped": true
    }
  },
  "stream_cipher": "aegis-256"
}

Documentation Index

Fetch the complete documentation index at: https://s2.dev/docs/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
basin
string
required

Basin name.

Required string length: 8 - 48

Response

​
create_stream_on_append
boolean
default:false

Create stream on append if it doesn't exist, using the default stream configuration.

​
create_stream_on_read
boolean
default:false

Create stream on read if it doesn't exist, using the default stream configuration.

​
default_stream_config
object

Default stream configuration.

​
stream_cipher
null | enum<string>

Encryption algorithm to apply to newly created streams in the basin.

Available options:
aegis-256,
aes-256-gcm