List event stores

GET

/api/event-stores

• Production

Retrieves a list of all event stores in the system

Authorizations

• Bearer

Parameters

Query Parameters

limit

Maximum number of results to return

string

Maximum number of results to return

offset

Number of results to skip

string

Number of results to skip

namePrefix

Filter results by event store name prefix

string

Filter results by event store name prefix

Responses

200

List of event stores

object

eventStores

required

Array<object>

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

Configuration settings for the event store

object

retentionPeriodDays

Number of days to retain events before automatic deletion

integer

maxStreamSizeBytes

Maximum size limit for a stream in bytes

integer

created

required

When this event store was created

string format: date-time

totalCount

required

Total number of event stores

integer

Examples

{
  "eventStores": [
    {
      "eventStoreId": "es_1234567890",
      "eventStoreName": "my-application",
      "eventStoreDurableObjectID": "do_eventstore_1234567890",
      "eventBusDurableObjectID": "do_eventbus_1234567890",
      "eventGlobalIndexDurableObjectID": "do_eventglobalindex_1234567890",
      "created": "2023-10-25T15:30:45Z"
    },
    {
      "eventStoreId": "es_0987654321",
      "eventStoreName": "analytics-events",
      "eventStoreDurableObjectID": "do_eventstore_0987654321",
      "eventBusDurableObjectID": "do_eventbus_0987654321",
      "eventGlobalIndexDurableObjectID": "do_eventglobalindex_0987654321",
      "created": "2023-10-26T09:15:30Z"
    }
  ],
  "totalCount": 2
}

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

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

Examples

{
  "error": "UNAUTHORIZED",
  "message": "Organization ID not found in authentication context"
}