Skip to main content
POST

Overview

Kick/disconnect a specific connection for a specified user. Similar to removing connections, but typically used for actively disconnecting live connections.

Request Body

Required Parameters

string
required
User ID
integer
required
Connection ID

Optional Parameters

integer
Node ID, specifies connection on a specific node

Response Fields

string
required
Operation status, returns "ok" on success

Status Codes

Difference from Remove Connection

Use Cases

User Session Management

Force User Logout:
Session Timeout Management:

Security Management

Suspicious Activity Response:

Administrative Control

Bulk Connection Management:

Maintenance Operations

Graceful Node Shutdown:

Connection Quality Management

Poor Connection Cleanup:

Best Practices

  1. Graceful Notification: Send notifications to users before kicking connections when possible
  2. Logging: Log all kick operations with reasons for audit purposes
  3. Rate Limiting: Avoid kicking too many connections simultaneously
  4. Error Handling: Handle kick failures gracefully
  5. User Experience: Provide clear reconnection instructions to affected users
  6. Security: Use kick operations as part of security incident response
  7. Monitoring: Monitor kick operations to identify patterns or issues