List active WebSocket connections

GET

/api/event-stores/{eventStoreName}/websocket-connections

• Production

Retrieves a list of all active WebSocket connections for an 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

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

clientId

Filter by client ID

string

Filter by client ID

Responses

200

List of active WebSocket connections

object

connections

required

Array<object>

object

connectionId

required

Unique identifier for the WebSocket connection

string

clientId

required

Client-provided identifier

string

connectedAt

required

When this connection was established

string format: date-time

ipAddress

IP address of the client

string

userAgent

User-Agent of the client

string

filter

Event filter pattern the client is subscribed to

string

totalCount

required

Total number of connections

integer

eventStoreName

required

Event store name (automatically scoped to your organization)

string

Examples

{
  "connections": [
    {
      "connectionId": "conn_1234567890",
      "clientId": "user_123",
      "connectedAt": "2023-10-25T15:30:45Z",
      "ipAddress": "192.168.1.1",
      "userAgent": "Mozilla/5.0...",
      "filter": "*"
    },
    {
      "connectionId": "conn_0987654321",
      "clientId": "user_456",
      "connectedAt": "2023-10-26T09:15:30Z",
      "ipAddress": "192.168.1.2",
      "userAgent": "Mozilla/5.0...",
      "filter": "user.*"
    }
  ],
  "totalCount": 2,
  "eventStoreName": "production"
}

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