Connection Commands

Invalidate all connections

Invalidates all user sessions in all rooms. Active clients will immediately try to reconnect and auth.

🔑

API key permission connections:invalidate

Request

POST https://api.reflect-server.net/v1/apps/{app-id}/connections/all:invalidate

Example

curl -X POST 'https://api.reflect-server.net/v1/apps/{app-id}/connections/all:invalidate' \     -H 'Authorization: Basic {api-key}'

Response

type InvalidateConnectionsResult = {};

Full response type: SuccessResponse<InvalidateConnectionsResult>

Invalidate room connections

Invalidates all user sessions in a room. Affected active clients will immediately try to reconnect and auth.

🔑

API key permission connections:invalidate

Request

POST https://api.reflect-server.net/v1/apps/{app-id}/connections/rooms:invalidate?roomID={room-id}

Example

curl -X POST 'https://api.reflect-server.net/v1/apps/{app-id}/connections/rooms:invalidate?roomID={room-id}' \     -H 'Authorization: Basic {api-key}'

Response

type InvalidateConnectionsResult = {};

Full response type: SuccessResponse<InvalidateConnectionsResult>

Invalidate user connections

Invalidates all of a user's sessions. Affected active clients will immediately try to reconnect and auth.

🔑

API key permission connections:invalidate

Request

POST https://api.reflect-server.net/v1/apps/{app-id}/connections/users:invalidate?userID={user-id}

Example

curl -X POST 'https://api.reflect-server.net/v1/apps/{app-id}/connections/users:invalidate?userID={user-id}' \     -H 'Authorization: Basic {api-key}'

Response

type InvalidateConnectionsResult = {};

Full response type: SuccessResponse<InvalidateConnectionsResult>

Rooms Articles