MikroTik API icon

MikroTik API

Community Node for MikroTik RouterOS API

Actions67

Hotspot → Disconnect

AI-generated

Summary

Disconnect an active hotspot user session on a MikroTik router by specifying the session's unique ID or name within the active hotspot category.

Inputs

  • Category — Select 'active' to disconnect active user sessions in the hotspot resource.
  • Target ID / Name (required) — The unique identifier (e.g., '*1', '*2') or name of the active hotspot session to disconnect.
  • Options — Optional connection parameters including connectionAttempts (number of connection retries), connectionDelay (seconds between retries), cleanKeys (boolean to replace - and / with _ in response keys), and tag (custom command tag).

Output shape

a single record containing the result of the disconnect command executed on the MikroTik router hotspot active session

If the disconnect command is successful, the output includes the resource name ('hotspot'), operation ('remove'), a count of affected entries (usually 1), and the data response from the router. In case of failure, error information is returned. Connection attempts and delays affect execution robustness.

Examples

Example 1: Disconnect a specific active hotspot user session

Set Resource to 'Hotspot', Category to 'Active', Operation to 'Remove', provide the Target ID/Name of the session to disconnect, and optionally configure connection options for retry behavior.

Links

Discussion