Skip to content
delta-base docs

Update event store settings

PATCH
/api/event-stores/{eventStoreName}/settings

Updates the configuration settings for an event store

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
eventStoreName
required

Event store name (automatically scoped to your organization)

string

Event store name (automatically scoped to your organization)

Request Body

Section titled “Request Body ”
object
description

Updated description for the event store

string
<= 255 characters
settings
object
retentionPeriodDays

Number of days to retain events

integer
maxStreamSizeBytes

Maximum size limit for a stream

integer
Examples
{
  "description": "Updated description for my event store"
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Event store settings updated successfully

object
eventStoreId
required

Composite identifier (orgId:name) - use eventStoreName for API calls

string
eventStoreName
required

Simple event store name for use in API calls

string
eventStoreDurableObjectId
required

Durable Object ID for the event store

string
eventBusDurableObjectId
required

Durable Object ID for the event bus

string
description

Description of the event store

string
settings
object
retentionPeriodDays
integer
maxStreamSizeBytes
integer
created
required

When this event store was created

string format: date-time
Examples
{
  "eventStoreID": "es_1234567890",
  "eventStoreName": "my-application",
  "eventStoreDurableObjectID": "do_eventstore_1234567890",
  "eventBusDurableObjectID": "do_eventbus_1234567890",
  "created": "2023-10-25T15:30:45Z",
  "settings": {
    "retentionPeriodDays": 180,
    "maxStreamSizeBytes": 2147483648
  }
}

400

Section titled “400 ”

Invalid request parameters

object
error
required

Error type

string
message
required

Human-readable error message

string
details

Additional error details

object
key
additional properties
nullable
Examples
{
  "error": "NO_UPDATES",
  "message": "No updates were provided",
  "details": {
    "eventStoreId": "es_1234567890"
  }
}

401

Section titled “401 ”

Unauthorized - Organization ID not found in authentication context

object
error
required

Error type

string
message
required

Human-readable error message

string
details

Additional error details

object
key
additional properties
nullable

404

Section titled “404 ”

Event store not found

object
error
required

Error type

string
message
required

Human-readable error message

string
details

Additional error details

object
key
additional properties
nullable
Examples
{
  "error": "EVENT_STORE_NOT_FOUND",
  "message": "The specified event store does not exist or has been deleted",
  "details": {
    "eventStoreId": "es_nonexistent"
  }
}

500

Section titled “500 ”

Internal server error

object
error
required

Error type

string
message
required

Human-readable error message

string
details

Additional error details

object
key
additional properties
nullable