MikroTik API icon

MikroTik API

Community Node for MikroTik RouterOS API

Actions67

Hotspot → Get All

AI-generated

Summary

Get all entries from a Mikrotik Hotspot category, with optional filtering for Users and User Profiles.

Inputs

  • hotspotCategory (required) — Hotspot category to query: Servers, Users, User Profiles, Active, Hosts, IP Bindings, or Cookies. Defaults to Users.
  • filterName — Exact name to filter (shown for Users and User Profiles).
  • filterProfile — Profile to filter (shown for Users only).
  • filterComment — Comment regex to filter (shown for Users and User Profiles).
  • options — Advanced connection options applied to all requests in the node execution. Sub‑fields: connectionAttempts (number, default 5), connectionDelay (seconds, default 3), cleanKeys (boolean, default false), tag (number, default 0).

Output shape

Array with a single object containing the query result under the json property.

The object includes: resource ('hotspot'), operation ('getAll'), count (number of returned items), and data (array of Mikrotik hotspot entries). If the cleanKeys option is true, response keys have - and / replaced with _.

Examples

Example 1: Retrieve all hotspot users named 'alice'.

hotspotCategory=Users, filterName=alice

Links

Discussion