Get event store details

GET

/api/event-stores/{eventStoreName}

• Production

Retrieves detailed information about a specific event store

Authorizations

• Bearer

Parameters

Path Parameters

eventStoreName

required

Event store name (automatically scoped to your organization)

string

Event store name (automatically scoped to your organization)

Query Parameters

includeStreamStats

Include statistics about streams and events

string

Include statistics about streams and events

includeDatabaseSizes

Include database size information

string

Include database size information

Responses

200

Event store details

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

streams

object

count

required

Number of streams in this event store

integer

totalEvents

required

Total number of events across all streams

integer

databaseSizes

object

eventStoreDatabaseSize

required

Size of the event store database in bytes

integer

eventBusDatabaseSize

required

Size of the event bus database in bytes

integer

totalSize

required

Total size of all databases for this event store in bytes

integer

Examples

{
  "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_1234567890",
  "eventStoreName": "my-application",
  "eventStoreDurableObjectID": "do_eventstore_1234567890",
  "eventBusDurableObjectID": "do_eventbus_1234567890",
  "eventGlobalIndexDurableObjectID": "do_eventglobalindex_1234567890",
  "created": "2023-10-25T15:30:45Z",
  "streams": {
    "count": 42,
    "totalEvents": 1234
  },
  "databaseSizes": {
    "eventStoreDatabaseSize": 5242880,
    "eventBusDatabaseSize": 1048576,
    "eventGlobalIndexDatabaseSize": 2097152,
    "totalSize": 8388608
  }
}

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",
  "details": {
    "eventStoreId": "es_nonexistent"
  }
}