Reconfigure a basin.
curl --request PATCH \
--url https://a.s2.dev/v1/basins/{basin} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{}'{
"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": "<string>",
"timestamping": {
"mode": "client-prefer",
"uncapped": true
}
},
"stream_cipher": "aegis-256"
}{
"code": "<string>",
"message": "<string>"
}{
"code": "<string>",
"message": "<string>"
}{
"code": "<string>",
"message": "<string>"
}{
"code": "<string>",
"message": "<string>"
}basins
Reconfigure a basin.
Update only provided fields in an S2 basin’s configuration; omitted fields are left unchanged.
PATCH
/
basins
/
{basin}
Reconfigure a basin.
curl --request PATCH \
--url https://a.s2.dev/v1/basins/{basin} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{}'{
"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": "<string>",
"timestamping": {
"mode": "client-prefer",
"uncapped": true
}
},
"stream_cipher": "aegis-256"
}{
"code": "<string>",
"message": "<string>"
}{
"code": "<string>",
"message": "<string>"
}{
"code": "<string>",
"message": "<string>"
}{
"code": "<string>",
"message": "<string>"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your access token.
Path Parameters
Basin name.
Required string length:
8 - 48Body
application/json
Create a stream on append.
Create a stream on read.
Basin configuration.
Show child attributes
Show child attributes
Encryption algorithm to apply to newly created streams in the basin.
Available options:
aegis-256, aes-256-gcm Response
Create stream on append if it doesn't exist, using the default stream configuration.
Create stream on read if it doesn't exist, using the default stream configuration.
Default stream configuration.
Show child attributes
Show child attributes
Encryption algorithm to apply to newly created streams in the basin.
Available options:
aegis-256, aes-256-gcm