Close a client WebSocket connection
DELETE /api/event-stores/{eventStoreName}/websocket-connections/{clientId}
DELETE
/api/event-stores/{eventStoreName}/websocket-connections/{clientId}
Closes all active WebSocket connections for a specific client ID
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)
clientId
required
Client ID to disconnect
string
Client ID to disconnect
Query Parameters
Section titled “Query Parameters ” reason
Optional reason for closing the connection
string
Optional reason for closing the connection
Responses
Section titled “ Responses ”Connection closed successfully
object
success
required
boolean
message
required
string
connectionsClosedCount
required
Number of connections that were closed
integer
Examples
{ "success": true, "message": "Client connections closed successfully", "connectionsClosedCount": 2}Event store or client not found
object
error
required
Error type
string
message
required
Human-readable error message
string
details
Additional error details
object
key
additional properties