MikroTik RouterOS icon

MikroTik RouterOS

Complete MikroTik RouterOS automation - PPPoE, Hotspot, Queue, Interface, and Router management

Actions14

Hotspot → Get Active Users

AI-generated

Summary

Retrieve a list of active hotspot users from a specified MikroTik router via middleware API.

Inputs

  • Router Name (required) — Router name as configured in middleware to identify which router's active hotspot sessions to fetch.
  • Limit — Maximum number of active hotspot users to return; optional with a default of 100.
  • Timeout — Request timeout in seconds; defaults to 30 seconds.

Output shape

a list of active hotspot user records as JSON objects

Response includes a 'success' boolean and a 'users' array containing the active hotspot user data up to the specified limit. If errors occur, they are returned in the error envelope if 'continueOnFail' is enabled.

Examples

Example 1: Retrieve up to 50 active hotspot users from router named 'main-router' within 20 seconds timeout.

Set 'Router Name' to 'main-router', 'Limit' to 50, and 'Timeout' to 20.

Links

Discussion