MikroTik API icon

MikroTik API

Community Node for MikroTik RouterOS API

Actions67

Hotspot → Add

AI-generated

Summary

Adds a hotspot entry to the MikroTik router. The hotspotCategory parameter (default: users) selects the category, which dictates the RouterOS command and required parameters. For users: adds a user via /ip/hotspot/user/add consuming name, password, profile, and comment. For servers: adds a hotspot server via /ip/hotspot/add with name, interface, profile, and comment. For user profiles: adds a user profile via /ip/hotspot/user/profile/add with extensive timeout, limit, and proxy settings.

Inputs

  • hotspotCategory (required) — Hotspot category: users, servers, userProfiles, active, hosts, ipBindings, or cookies. Defaults to 'users'.
  • hotspotName (required) — Name of the hotspot entry. Appears for users, servers, and userProfiles categories.
  • hotspotPassword — Password for the hotspot user. Visible when category is 'users'.
  • hotspotProfile — Profile for the hotspot entry. Visible when category is 'users' or 'servers'.
  • hotspotInterface — Interface for the hotspot. Visible when category is 'servers' and operation is 'add'.
  • commentText — Comment added to the hotspot entry. Shown for add/set operations across relevant categories.

Output shape

RouterOS API response from the executed hotspot command. Data keys can be normalized (replace - and / with _) if the 'clean keys' option is enabled.

The exact RouterOS command and parameters depend on the selected hotspotCategory. Connection retry logic (5 attempts, 3-second delay) and optional key cleaning are handled by the node's runtime.

Links

Discussion