Mikrotik MCP Server — 297 tools
The Mikrotik DADL turns Mikrotik's API into an MCP server that Claude, GPT or any MCP-compatible agent can consume directly. One YAML file declares all 297 tools — firewall, system, ipsec, dhcp, ip, ipv6, and more — and ToolMesh serves them at runtime. No Python boilerplate, no per-endpoint code, no separate MCP server process.
Below: the endpoint coverage matrix, a two-block ToolMesh setup, the full tool reference grouped by Mikrotik feature area, required credential scopes.
Source: MikroTik RouterOS REST API
Which Mikrotik endpoints are covered?
65% (297 of ~450 endpoints)
Focus: system (resource, identity, clock, health, license, package, script, scheduler, reboot/shutdown, backup, note, logging rules + actions with /set twin), interfaces (generic set, list/CRUD, ethernet + atomic /set + switch chip + switch port, bridge + /set + port /set + VLAN CRUD + /set + /remove + host/FDB table, vlan, bonding CRUD, wireless legacy, wifi, lte + /set, wireguard + interface CRUD + peers, list/member + list CRUD), IP (address, route, ARP, neighbor, service set/enable/disable, pool, cloud + /set), DNS (settings, static, cache), DHCP server (CRUD + /set + delete, lease, network CRUD, make-static, client CRUD + release/renew), firewall (filter, NAT, mangle full CRUD + move, raw full CRUD + move, address-list update, connection tracking), IPv6 (address full CRUD, route CRUD, firewall filter CRUD + move, ND, settings /set), PPP (secret, active, profile CRUD), routing (BGP connection CRUD, BGP templates/sessions, OSPF instance + area CRUD, interface-templates, neighbors, routing-filter rules CRUD), queues (simple full, tree, type), tools (ping, traceroute, bandwidth-test, netwatch CRUD, email SMTP settings get/set + send), users (user, group CRUD, ssh-keys, active sessions), logs, certificates, files, SNMP, VPN servers (L2TP/SSTP/PPTP/OVPN singleton get/set), IPsec (peer, identity, policy, profile, proposal full CRUD; active-peers, installed-sa, flush, settings), container (RouterOS 7), MPLS basics
Missing: CAPsMAN controller endpoints (out of scope: CRS354 is Ethernet-only), RADIUS server config, hotspot user profiles/walled garden, /interface/wireless deep config (legacy stack; tooling focuses on the modern /interface/wifi stack), BGP VPN/VPLS, OSPFv3 (instance.version=3 supported but no separate tooling), MPLS LDP detail, RIPv2, traffic-flow exporter, traffic monitor, GPS, ROMON, dude integration, dot1x, w60g, modem deep config, /tool/fetch (file upload/download via REST), file repository sync, certificate ACME plugin, /caps-man for new wifi stack (intentional: per-device wifi-config exposes set already). Limited until ToolMesh stops percent-encoding the asterisk of RouterOS .ids in URL paths (2026-11): update_*/delete_* tools for records without a name (addresses, routes, firewall rules, address lists, DHCP leases/networks/clients, DNS static entries, bridge ports and VLANs, WireGuard peers, IPsec identities/policies, routing filters, logging rules, netwatch) return HTTP 400; named records work when addressed by name, and POST /xxx/set + /xxx/remove twins with 'numbers' are unaffected -- see the top-of-file note.
How do you configure the Mikrotik DADL?
- Log in to your MikroTik device via Winbox, SSH, or WebFig as an admin
- Enable the REST API service: /ip/service> set www-ssl disabled=no (HTTPS) or set www disabled=no (HTTP, NOT recommended for production)
- Ensure www-ssl has a valid certificate: /ip/service> set www-ssl certificate=<cert-name>
- Create a dedicated API user: /user/add name=api-user password=<strong-password> group=read (or 'full' / a custom group)
- For least-privilege custom groups: /user/group/add name=api-readonly policy=api,read,test,winbox
- Verify access: curl -k -u api-user:<password> https://<router-ip>/rest/system/resource
- Store the credentials: CREDENTIAL_MIKROTIK_USERNAME=api-user and CREDENTIAL_MIKROTIK_PASSWORD=<password>
Environment variable: CREDENTIAL_MIKROTIK_USERNAME and CREDENTIAL_MIKROTIK_PASSWORD
RouterOS v7.1+ required (v7.9+ recommended). Most MikroTik devices ship with self-signed certificates -- ToolMesh must skip TLS verification or you must install a trusted certificate via /certificate/import. The 'api' policy is REQUIRED on the user's group for any REST access. For read-only monitoring, use group with policy=api,read,test,winbox; for full management add write,policy,reboot,ftp,sensitive. Known ToolMesh limitations (2026-11): (1) tools with an {id} path (update_*, delete_*, get_interface, get_user, get_system_script) fail with HTTP 400 when given a .id such as '*1', because ToolMesh percent-encodes the asterisk -- pass the record's name instead (interfaces, users, scripts, ...) or use a POST /xxx/set or /xxx/remove twin with 'numbers' (e.g. set_ethernet_interface, set_bridge_vlan, remove_bridge_vlan). (2) set_bridge_port 'numbers' must be the bridge-port .id, not interface name. (3) JSON null is dropped by the wrapper — use empty string '' to clear fields. Full detail in the comment block at the top of this file.
How do you install the Mikrotik MCP server with ToolMesh?
Add to your backends.yaml:
- name: mikrotik
transport: rest
dadl: mikrotik.dadl
url: "https://10.0.0.1/rest" # HTTPS (recommended) -- requires www-ssl service
# url: "http://10.0.0.1/rest" # plain HTTP -- requires www service (RouterOS v7.9+)
Set the credential:
CREDENTIAL_MIKROTIK_USERNAME and CREDENTIAL_MIKROTIK_PASSWORD=your-token-hereWhat 297 tools does the Mikrotik DADL expose?
GETget_system_resourceGet the device's hardware and runtime resource summary: architecture (mipsbe/arm/arm64/x86_64/tile), board-name, CPU model and count, CPU load, RAM (free/total), HDD (free/total), uptime, RouterOS version, build-time. Returns a single JSON object (NOT an array).
GETget_system_identityGet the device's identity (hostname shown in Winbox, neighbor discovery, and the CLI prompt). Returns a single-field object: {"name":"<hostname>"}.
POSTset_system_identitySet the device's hostname/identity. Send {name: '<new-name>'}.GETget_system_clockGet the current date, time, timezone, and DST setting on the device. Useful for verifying NTP sync and timezone configuration.
POSTset_system_clockSet the device clock. Useful fields: time-zone-name (e.g. 'Europe/Berlin'), time-zone-autodetect ('yes'/'no'), date ('YYYY-MM-DD'), time ('HH:MM:SS').
GETget_ntp_clientGet NTP client config and live sync state. Key fields: enabled ('true'/'false'), mode (unicast|broadcast|multicast|manycast), servers (comma-separated upstream NTP server IPs/FQDNs), vrf. Read-only status fields: status (started|stopped| synchronized|using-local-clock|error|search), synced-server, synced-stratum, system-offset (e.g. '0.5ms'), freq-diff. If 'status' is anything other than 'synchronized', the device clock is drifting on its own RTC/quartz.
POSTset_ntp_clientUpdate the NTP client. Most common change: provide a comma-separated list of trusted NTP servers and enable the client. Example body: {enabled:'yes', servers:'time.cloudflare.com,ptbtime1.ptb.de', mode:'unicast'}. Apply takes effect immediately; allow a few seconds for first sync attempt.
GETget_ntp_serverGet the device's NTP SERVER config (whether this router serves time to other clients). Fields: enabled, broadcast, multicast, manycast, use-local-clock, local-clock-stratum, vrf, broadcast-addresses. Most edge devices keep this disabled and rely solely on the client.
POSTset_ntp_serverUpdate the NTP server config (enable broadcast/multicast/manycast NTP serving).GETget_system_healthGet hardware sensor readings: CPU temperature, board temperature, fan speeds, voltage, PSU state. Available sensors vary by hardware model; small devices (hAP lite, hEX lite) expose only a subset.
GETget_system_health_settingsGet the cooling/fan control settings (separate from the read-only sensor values in /system/health). Typical fields: fan-mode (auto|manual), fan-min-speed-percent (PWM floor, e.g. 30), fan-target-temperature (target CPU/board temp for PWM control, e.g. 55), and PSU-related toggles (use-fan, fan-failure-trigger). Available only on devices with controllable fans (CCR, CRS3xx with PWM headers, RB5009, etc.). On fan-less hardware (cAP, hAP, hEX, CHR) this endpoint typically returns an empty object.
POSTset_system_health_settingsConfigure cooling/fan behavior. Common changes -- quieter idle: {fan-mode:'auto', fan-min-speed-percent:'20', fan-target-temperature:'55'}. Force constant high RPM (e.g. dusty environment): {fan-mode:'manual', fan-min-speed-percent:'100'}. CAUTION: setting fan-target-temperature too high (>70C) or fan-min-speed-percent too low on a thermally constrained chassis can cause throttling or shutdown. Verify with get_system_health afterwards.
GETget_system_licenseGet the RouterOS license level (0-6), software-id, and CHR upgrade state. Level 6 = CHR/x86, levels 4-5 = WISP/Controller.GETget_routerboardGet RouterBOARD hardware info: model, serial-number, firmware-type, factory-firmware (the firmware that shipped from the factory), current-firmware (running), upgrade-firmware (latest available bundled with the running RouterOS package), routerboot version. The 'routerboard' flag is 'true' on physical MikroTik hardware and 'false' on CHR/x86 (where this endpoint typically returns empty). For CRS3xx switches this is the canonical source for the factory firmware revision and the bootloader (RouterBOOT) version that the device shipped with.
POSTupgrade_routerboard_firmwareTrigger a RouterBOOT firmware upgrade to the version reported in 'upgrade-firmware'. The new firmware is staged for the next boot -- the device MUST be rebooted (POST /system/reboot) for the upgrade to take effect. Different from RouterOS package upgrades (see install_package_updates) -- this updates ONLY the bootloader/CPLD/SoC firmware bundled with the running RouterOS package. Returns no body on success; check get_routerboard afterwards to confirm current-firmware matches upgrade-firmware.
POSTdowngrade_routerboard_firmwareDowngrade RouterBOOT firmware to the factory firmware. Same reboot requirement as upgrade. Rarely needed; use only when a RouterBOOT upgrade caused issues and you need to revert.
GETlist_system_packagesList all installed RouterOS packages with version, build time, and disabled state. Standard package set: system, wireless, ipv6, advanced-tools, routing, security, wifi-qcom-ac, etc. Disabled packages remain on flash but are not loaded.
POSTenable_system_packageEnable a package by name. Requires reboot to take effect.POSTdisable_system_packageDisable a package by name. Requires reboot to unload.POSTcheck_for_package_updatesCheck the MikroTik update server for available RouterOS updates. Returns installed-version, latest-version, status ('System is already up to date', 'New version is available'). Does NOT install -- use install_package_updates.
POSTinstall_package_updatesDownload and install RouterOS updates from MikroTik servers. The device WILL reboot after install. Channel must be set first via set channel (stable, long-term, testing, development).
GETlist_system_scriptsList all stored scripts on the device with name, source code, run-count, last-started, owner, and policies.GETget_system_scriptGet a single script by name. Returns the full source field. A .id such as '*1' fails with HTTP 400 through ToolMesh (percent-encoded asterisk).PUTadd_system_scriptCreate a new script. Provide name and source (RouterOS scripting language).PATCHupdate_system_scriptUpdate an existing script's source, policies, or comment. Pass the record's name as id; a .id such as '*1' fails with HTTP 400 through ToolMesh (percent-encoded asterisk).DELETEdelete_system_scriptDelete a script by name. A .id such as '*1' fails with HTTP 400 through ToolMesh (percent-encoded asterisk).POSTrun_system_scriptExecute a stored script by .id. Output (if any) is appended to the system log.GETlist_system_schedulerList scheduled tasks (cron-like). Each has name, start-date, start-time, interval, on-event (script to run), policy, run-count, next-run.PUTadd_system_schedulerSchedule a script to run at a specific time or interval.PATCHupdate_system_schedulerUpdate a scheduled task (name, on-event, start-date/time, interval, policy, comment, disabled). Pass the record's name as id; a .id such as '*1' fails with HTTP 400 through ToolMesh (percent-encoded asterisk).DELETEdelete_system_schedulerDelete a scheduled task by name. A .id such as '*1' fails with HTTP 400 through ToolMesh (percent-encoded asterisk).POSTreboot_systemReboot the device immediately. Disconnects ALL sessions; device will be offline for 30-90 seconds. There is no undo. Confirm intent before calling.
POSTshutdown_systemPower-off the device immediately. Device requires physical power-cycle to come back online. Use only when you have on-site access.
POSTcreate_backupCreate a binary backup of the running configuration. Stored on device flash as <name>.backup. Retrieve via FTP/SFTP -- the REST API does not stream file contents.
POSTload_backupRestore configuration from a backup file. Device WILL reboot. Backup must already exist in /file (uploaded via FTP/SFTP or made via create_backup).
POSTexport_configExport the running configuration as an RSC script. If 'file' is provided, writes to /file/<name>.rsc on the device; otherwise returns the script text inline. 'compact' (yes/no) and 'verbose' (yes/no) control verbosity.
GETget_system_noteGet the login banner / system note shown on console login. Often used for ownership/contact info.POSTset_system_noteSet the login banner / system note.GETlist_interfacesList all interfaces (physical and virtual) with name, type, MTU, MAC address, running/disabled state, rx/tx-byte counters, last-link-up/down. Type values: ether, vlan, bridge, wireless, wifi, wireguard, lte, ppp-client, ovpn-server, ovpn-client, l2tp-server, sstp-server, pptp-server, eoip, ipip, gre, vrrp, etc.
GETget_interfaceGet a single interface by name (e.g. 'ether1', 'bridge1'). A .id such as '*1' fails with HTTP 400 through ToolMesh (percent-encoded asterisk).PATCHupdate_interfaceUpdate common interface properties: name, comment, mtu (L3), l2mtu (L2), disabled, arp mode. NOTE on jumbo frames: RouterOS clamps L3 'mtu' to l2mtu - 14 bytes. To run mtu=9000 you must FIRST raise 'l2mtu' to at least 9014 (or use the max-l2mtu the hardware reports). On CRS3xx switch-chips the per-port l2mtu IS writable and changes the chip's accepted frame size on that port. Pass the record's name as id; a .id such as '*1' fails with HTTP 400 through ToolMesh (percent-encoded asterisk).
POSTenable_interfaceEnable one or more interfaces by .id or name (comma-separated in 'numbers').POSTdisable_interfaceDisable one or more interfaces.POSTmonitor_interface_trafficSample rx/tx rates for an interface. ALWAYS pass once='' to avoid the 60s timeout, otherwise the API streams indefinitely.
POSTset_interfaceAtomically update one or more interfaces (any type) via the CLI-style '/interface set'. Use this when you need to change name/comment/mtu/disabled across MIXED interface types in one transaction (CLI: '/interface set [find ...] mtu=9000'). For ether-specific atomic edits (l2mtu, speed, duplex) use set_ethernet_interface; for cellular APN/mode use set_lte_interface. The generic /interface/set only touches L3 mtu and cannot raise l2mtu on Ethernet ports.
GETlist_ethernet_interfacesList physical Ethernet ports with name, default-name, MAC, MTU, speed, auto-negotiation, full-duplex, SFP details.POSTset_ethernet_interfaceAtomically update one or more Ethernet ports via the CLI-style '/interface/ethernet set' command. Reference ports via 'numbers' (comma-separated names or .ids); 'numbers' travels in the JSON body, so .ids work here, unlike in URL paths through ToolMesh. PREFERRED for jumbo-frame setup on switches: it sets l2mtu and mtu in one transaction, so RouterOS validates the new pair together (mtu <= l2mtu - 14). For a single-port change of other fields, update_ethernet_interface with the port name works as well; bridge membership (slave='true') does not block it.
PATCHupdate_ethernet_interfaceUpdate one Ethernet port (name, comment, disabled, speed, advertise, full-duplex, auto-negotiation, mtu, l2mtu, mac-address). Pass the port NAME as id (e.g. 'ether1'): RouterOS accepts the name in the URL path, while a .id such as '*1A' fails with HTTP 400 because ToolMesh percent-encodes the asterisk. Verified 2026-11 with a comment-only change on a bridge-member port (slave='true'): bridge membership does not block this PATCH. Send '' to clear a field (comment:''). Returns the updated port record. Jumbo frames: RouterOS requires mtu <= l2mtu - 14, so raise l2mtu before mtu, or use set_ethernet_interface, which sets both in one atomic call and can change several ports at once (mtu/l2mtu via this PATCH not re-tested).
GETlist_ethernet_switchesList hardware switch chips (CRS3xx-series and similar). Each chip has name (e.g. 'switch1'), type, mirror-source, mirror-target, cpu-flow-control. On boxes with no switch chip (RB4011, hAP family) this returns an empty array.
GETlist_ethernet_switch_portsList per-port switch-chip configuration (separate from /interface/ethernet L2/L3 view). Fields: name (chip-port id like 'switch1-cpu' or 'ether1'), l2mtu, vlan-mode, vlan-header, default-vlan-id, mirror, mirror-egress. On CRS3xx the chip enforces its own per-port l2mtu — this is the cap that /interface/ethernet l2mtu is clamped against. For end-to-end jumbo you usually need set_ethernet_interface (raises ether l2mtu) AND, on older firmwares, set_ethernet_switch_port (raises chip-port l2mtu).
POSTset_ethernet_switchAtomically update one or more switch chips. Reference via 'numbers' (chip name or .id). Use for changing mirror-source/mirror-target, cpu-flow-control. Rarely needed on a 'just give me jumbo frames' workflow — try set_ethernet_interface first.
POSTset_ethernet_switch_portAtomically update one or more switch-chip ports. Reference via 'numbers' (port name like 'ether1' or chip-port .id). Most relevant field is 'l2mtu' on older RouterOS releases where the chip cap needs explicit bumping for jumbo. On RouterOS 7.10+ the chip auto-tracks /interface/ethernet l2mtu; this endpoint is the fallback if your hardware does not.
GETlist_bridgesList bridge interfaces (Layer-2 software switches). Returns name, mtu, protocol-mode (none|rstp|stp|mstp), vlan-filtering, igmp-snooping, fast-forward.PUTadd_bridgeCreate a new bridge interface. At minimum provide name; common options: protocol-mode (rstp), vlan-filtering ('yes' for VLAN-aware bridge).PATCHupdate_bridgeUpdate bridge properties (name, protocol-mode, vlan-filtering, igmp-snooping, fast-forward, mtu, admin-mac, comment). Pass the record's name as id; a .id such as '*1' fails with HTTP 400 through ToolMesh (percent-encoded asterisk).POSTset_bridgeAtomically update one or more bridges via CLI-style '/interface/bridge set'. Useful when you need to flip vlan-filtering or protocol-mode on multiple bridges in one transaction. Reference via 'numbers' (bridge name or .id).
DELETEdelete_bridgeDelete a bridge by name. Removes all port memberships. A .id such as '*1' fails with HTTP 400 through ToolMesh (percent-encoded asterisk).GETlist_bridge_portsList bridge port memberships (which interfaces are members of which bridges). Key fields: bridge, interface, pvid, frame-types, ingress-filtering.PUTadd_bridge_portAdd an interface to a bridge.DELETEdelete_bridge_portRemove a port from a bridge. KNOWN BROKEN through ToolMesh (2026-11): the URL path needs the record's .id, and the percent-encoded .id is answered with HTTP 400.POSTset_bridge_portAtomically update one or more bridge ports via CLI-style '/interface/bridge/port set'. Use this instead of PATCH when you need to flip pvid/frame-types/ingress-filtering on many ports together; PATCH on individual bridge-port records can interact awkwardly with hardware offload and slave validation.
IMPORTANT (verified 2026-05-25, RouterOS 7.x): 'numbers' MUST be the bridge-port record's .id (e.g. '*2E'). Passing the interface name (e.g. 'ether47') returns HTTP 404 — unlike the CLI, the REST endpoint does NOT resolve interface→bridge-port. Lookup pattern: call list_bridge_ports, find the row where .interface matches the port you want, take its .id, then pass that as 'numbers'.
GETlist_bridge_hostsList the bridge forwarding database (FDB) — every MAC the bridge has learned, plus where (which port). Fields: mac-address, on-interface, bridge, age, local (yes=our own MAC), external (yes=learned from another switch), dynamic. Essential for debugging "host disappeared" issues — confirms whether the bridge ever saw the MAC.
GETlist_bridge_vlansList bridge VLAN configurations (which VLAN IDs are tagged/untagged on which bridge ports). Used with vlan-filtering=yes bridges.PUTadd_bridge_vlanConfigure VLAN tagging on a bridge.PATCHupdate_bridge_vlanUpdate an existing bridge-vlan record (tagged/untagged port lists, comment, disabled).
KNOWN BROKEN through ToolMesh (2026-11): bridge-vlan records have no name, so the URL path needs the .id, and ToolMesh percent-encodes its asterisk ('*6' is sent as '%2A6'), which RouterOS answers with HTTP 400. Reproduced on a freshly-added empty test VLAN with a trivial comment change. WORKAROUND: use set_bridge_vlan (POST /interface/bridge/vlan/set with 'numbers') instead — it passes the .id in the body and is not affected.
DELETEdelete_bridge_vlanRemove a bridge-vlan record.
KNOWN BROKEN through ToolMesh (2026-11): this DELETE returns HTTP 400 — same .id path-encoding limitation as update_bridge_vlan. WORKAROUND: use remove_bridge_vlan (POST /interface/bridge/vlan/remove with 'numbers') instead.
POSTset_bridge_vlanUpdate a bridge-vlan record via CLI-style '/interface/bridge/vlan set'. Reference via 'numbers' = the .id of the bridge-vlan record (e.g. '*6'). PREFERRED over update_bridge_vlan, which fails through ToolMesh because the .id in its URL path is sent percent-encoded. Lookup the .id with list_bridge_vlans first.
Note: although the CLI accepts multi-record selectors (e.g. `[find vlan-ids=10,20]`), the REST docs only show single-.id examples for /set. Treat this endpoint as one .id per call; loop in a composite if you need batch.
POSTremove_bridge_vlanRemove a bridge-vlan record via CLI-style '/interface/bridge/vlan remove'. Reference via 'numbers' = the .id of the bridge-vlan record. PREFERRED over delete_bridge_vlan, which fails through ToolMesh because the .id in its URL path is sent percent-encoded. Lookup the .id with list_bridge_vlans first. Single .id per call (see set_bridge_vlan note).
GETlist_vlan_interfacesList VLAN interfaces (802.1Q sub-interfaces). Each has name, vlan-id, interface (parent), mtu.PUTadd_vlan_interfaceCreate a VLAN sub-interface on a physical or bridge interface.DELETEdelete_vlan_interfaceDelete a VLAN interface. Pass the record's name as id; a .id such as '*1' fails with HTTP 400 through ToolMesh (percent-encoded asterisk).GETlist_bonding_interfacesList bonding (link aggregation) interfaces. Modes: 802.3ad (LACP), balance-rr, balance-xor, broadcast, active-backup, etc.PUTadd_bonding_interfaceCreate a bonding interface that aggregates physical Ethernet ports. For switch-side LACP both sides must speak 802.3ad.PATCHupdate_bonding_interfaceUpdate a bonding interface (slaves, mode, lacp-rate, hash policy, comment). Pass the record's name as id; a .id such as '*1' fails with HTTP 400 through ToolMesh (percent-encoded asterisk).DELETEdelete_bonding_interfaceDelete a bonding interface. Member ports return to individual L2 state. Pass the record's name as id; a .id such as '*1' fails with HTTP 400 through ToolMesh (percent-encoded asterisk).GETlist_interface_listsList interface lists (named groups of interfaces, used in firewall rules as 'in-interface-list' / 'out-interface-list'). Default lists: WAN, LAN.PUTadd_interface_listCreate a new interface list. Use to group interfaces for firewall in-/out-interface-list matching.DELETEdelete_interface_listDelete an interface list. Firewall rules referencing it will break — audit first. Pass the record's name as id; a .id such as '*1' fails with HTTP 400 through ToolMesh (percent-encoded asterisk).GETlist_interface_list_membersList members of all interface lists. Key fields: list, interface.PUTadd_interface_list_memberAdd an interface to an interface list.DELETEdelete_interface_list_memberRemove an interface from an interface list. KNOWN BROKEN through ToolMesh (2026-11): the URL path needs the record's .id, and the percent-encoded .id is answered with HTTP 400.GETlist_wireless_interfacesList legacy wireless interfaces (cAP, hAP ac, RB devices). Each has ssid, mode (ap-bridge|station|station-bridge|bridge), band, channel-width, frequency, security-profile, radio-name, master-interface. Use list_wifi_interfaces for newer cAP ax / hAP ax / Audience devices.
GETlist_wireless_security_profilesList wireless security profiles (WPA/WPA2/WPA3 PSK and EAP). Key fields: name, mode, authentication-types, wpa2-pre-shared-key, group-ciphers, unicast-ciphers.GETlist_wireless_registrationsList currently associated wireless clients (CAPsMAN/wireless). Returns mac-address, interface, signal-strength, tx-rate, rx-rate, uptime.GETlist_wifi_interfacesList newer 802.11ax wifi interfaces (cAP ax, hAP ax, Audience family). Newer stack than /interface/wireless.GETlist_wifi_registrationsList clients connected to the new wifi stack interfaces.POSTmonitor_wifiSample current wifi interface state (channel, tx-rate, noise floor). ALWAYS pass once=''.GETlist_lte_interfacesList LTE/cellular modem interfaces. Each has name, apn, pin, network-mode, status, imei.POSTset_lte_interfaceUpdate an LTE modem interface (APN, network selection, PIN, name). Reference via 'numbers' (lte interface name). Carrier change normally triggers a brief re-attach (5-10s). For per-APN profile work see /interface/lte/apn (singleton APN list is queryable via the modem itself).
POSTmonitor_lteSample LTE modem state (signal RSSI/RSRP/RSRQ, technology, current-operator, cell-id). ALWAYS pass once=''.GETlist_wireguard_interfacesList WireGuard VPN interfaces. Each has name, public-key, private-key (hidden unless 'sensitive' policy), listen-port, mtu.PUTadd_wireguard_interfaceCreate a WireGuard interface. RouterOS auto-generates a key pair if private-key is omitted.PATCHupdate_wireguard_interfaceUpdate a WireGuard interface (listen-port, private-key, mtu, comment, disabled). Rotating private-key requires re-distributing the resulting public-key to every peer — handle with care. Pass the record's name as id; a .id such as '*1' fails with HTTP 400 through ToolMesh (percent-encoded asterisk).
DELETEdelete_wireguard_interfaceDelete a WireGuard interface. ALL associated peers are removed implicitly. Pass the record's name as id; a .id such as '*1' fails with HTTP 400 through ToolMesh (percent-encoded asterisk).GETlist_wireguard_peersList configured WireGuard peers. Key fields: interface, public-key, endpoint-address, endpoint-port, allowed-address, last-handshake, rx, tx, current-endpoint-address.PUTadd_wireguard_peerAdd a WireGuard peer to an interface.PATCHupdate_wireguard_peerUpdate a WireGuard peer (allowed-address, endpoint, keepalive, comment, disabled). KNOWN BROKEN through ToolMesh (2026-11): the URL path needs the record's .id, and the percent-encoded .id is answered with HTTP 400.DELETEdelete_wireguard_peerRemove a WireGuard peer. KNOWN BROKEN through ToolMesh (2026-11): the URL path needs the record's .id, and the percent-encoded .id is answered with HTTP 400.GETlist_ip_addressesList all configured IPv4 addresses with address (CIDR), network, interface, dynamic (yes for DHCP-acquired), disabled, comment.PUTadd_ip_addressAssign an IPv4 address to an interface.PATCHupdate_ip_addressUpdate an IP address record (address, interface, comment, disabled). KNOWN BROKEN through ToolMesh (2026-11): the URL path needs the record's .id, and the percent-encoded .id is answered with HTTP 400.DELETEdelete_ip_addressRemove an IPv4 address. May disconnect remote sessions if the deleted address is the management IP. KNOWN BROKEN through ToolMesh (2026-11): the URL path needs the record's .id, and the percent-encoded .id is answered with HTTP 400.GETlist_ip_routesList the IPv4 routing table. Each route has dst-address (CIDR), gateway, distance, scope, target-scope, routing-mark, active, dynamic, suppress-hw-offload. Filter active=true to see only currently used routes.
PUTadd_ip_routeAdd a static IPv4 route. Default route: dst-address='0.0.0.0/0' with a gateway.PATCHupdate_ip_routeUpdate a static route. KNOWN BROKEN through ToolMesh (2026-11): the URL path needs the record's .id, and the percent-encoded .id is answered with HTTP 400.DELETEdelete_ip_routeDelete a static route. KNOWN BROKEN through ToolMesh (2026-11): the URL path needs the record's .id, and the percent-encoded .id is answered with HTTP 400.GETlist_ip_arpList the ARP (IPv4-to-MAC) table. Includes static and dynamic entries with address, mac-address, interface, complete (yes/no), dynamic.PUTadd_ip_arpAdd a static ARP entry (useful for ARP reply-only mode).DELETEdelete_ip_arpRemove an ARP entry. KNOWN BROKEN through ToolMesh (2026-11): the URL path needs the record's .id, and the percent-encoded .id is answered with HTTP 400.GETlist_ip_neighborsList devices discovered via MNDP/CDP/LLDP on directly connected interfaces. Useful for topology discovery.GETlist_ip_servicesList the management services and their state: api, api-ssl, ftp, ssh, telnet, winbox, www (HTTP), www-ssl (HTTPS REST). Each has port, address (allowed source CIDR), disabled, certificate, tls-version.
POSTset_ip_serviceUpdate a management service (enable/disable, change port, restrict source 'address' list, bind to certificate). NOTE: /ip/service is one of the few RouterOS endpoints that does NOT support PATCH -- use this POST /set form (mirrors the CLI '/ip/service set ...' command). Reference services via 'numbers' as the service name (e.g. 'telnet', 'www-ssl') or .id ('*0'). Be careful disabling the service you are currently connected through.
POSTdisable_ip_serviceConvenience wrapper to disable one or more services. Pass service name(s) or .id(s) as comma-separated 'numbers'.POSTenable_ip_serviceConvenience wrapper to enable one or more services. Pass service name(s) or .id(s) as comma-separated 'numbers'.GETlist_ip_poolsList IP address pools (used by DHCP server, PPP server, etc.). Each has name, ranges (CIDR or IP range), next-pool.GETget_ip_cloudGet MikroTik IP Cloud (dynamic DNS) status: ddns-enabled, dns-name (xxxxx.sn.mynetname.net), public-address, status.POSTset_ip_cloudUpdate MikroTik IP Cloud (dynamic DNS) settings. Singleton — toggle ddns-enabled='yes' to register the device's WAN IP with mynetname.net. Disable update-time='yes' if you do NOT want IP Cloud to push device time (e.g. when you have your own NTP servers).
GETget_dns_settingsGet DNS resolver settings: servers (upstream), dynamic-servers, allow-remote-requests, cache-size, max-concurrent-queries.POSTupdate_dns_settingsUpdate DNS resolver settings.GETlist_dns_staticList static DNS entries (local DNS records). Each has name, type (A|AAAA|CNAME|NS|MX|SRV|TXT), address/cname/target, ttl.PUTadd_dns_staticAdd a static DNS entry. Use either name+address (A record) or name+cname.PATCHupdate_dns_staticUpdate a static DNS entry. KNOWN BROKEN through ToolMesh (2026-11): the URL path needs the record's .id, and the percent-encoded .id is answered with HTTP 400.DELETEdelete_dns_staticRemove a static DNS entry. KNOWN BROKEN through ToolMesh (2026-11): the URL path needs the record's .id, and the percent-encoded .id is answered with HTTP 400.GETlist_dns_cacheList currently cached DNS resolutions on the device.POSTflush_dns_cacheClear the DNS resolver cache.GETlist_dhcp_serversList DHCP server instances. Each has name, interface, address-pool, lease-time, authoritative, disabled.PUTadd_dhcp_serverCreate a DHCP server. Requires interface and address-pool.PATCHupdate_dhcp_serverUpdate a DHCP server. Pass the record's name as id; a .id such as '*1' fails with HTTP 400 through ToolMesh (percent-encoded asterisk).POSTset_dhcp_serverAtomically update one or more DHCP server instances via CLI-style '/ip/dhcp-server set'. Reference via 'numbers' (server name or .id). Use this when changing lease-time / authoritative across multiple servers in one go.
DELETEdelete_dhcp_serverDelete a DHCP server instance. Clients will fail to renew leases. Pass the record's name as id; a .id such as '*1' fails with HTTP 400 through ToolMesh (percent-encoded asterisk).GETlist_dhcp_leasesList DHCP leases (both dynamic and static reservations). Key fields: address, mac-address, server, host-name, dynamic (yes/no), status (bound | waiting | offered | expired), last-seen, comment.
PUTadd_dhcp_leaseCreate a static DHCP reservation.DELETEdelete_dhcp_leaseDelete a DHCP lease/reservation. KNOWN BROKEN through ToolMesh (2026-11): the URL path needs the record's .id, and the percent-encoded .id is answered with HTTP 400.POSTmake_dhcp_lease_staticConvert a dynamic DHCP lease into a static reservation. Most common workflow for reserving an IP for a known device.GETlist_dhcp_networksList DHCP network options (subnet, gateway, dns-server, ntp-server, domain) advertised to clients.PUTadd_dhcp_networkAdd DHCP network options for a subnet.PATCHupdate_dhcp_networkUpdate a DHCP server network (gateway, dns, ntp, domain, comment). KNOWN BROKEN through ToolMesh (2026-11): the URL path needs the record's .id, and the percent-encoded .id is answered with HTTP 400.DELETEdelete_dhcp_networkRemove a DHCP server network. Existing leases remain but new clients will get no options. KNOWN BROKEN through ToolMesh (2026-11): the URL path needs the record's .id, and the percent-encoded .id is answered with HTTP 400.GETlist_dhcp_clientsList DHCP client instances. Each has interface, status (bound|searching|stopped), address, gateway, primary-dns, secondary-dns, expires-after.PUTadd_dhcp_clientEnable a DHCP client on an interface (typical WAN setup).PATCHupdate_dhcp_clientUpdate a DHCP client (interface, add-default-route, use-peer-dns, etc.). KNOWN BROKEN through ToolMesh (2026-11): the URL path needs the record's .id, and the percent-encoded .id is answered with HTTP 400.DELETEdelete_dhcp_clientDelete a DHCP client. WAN-side delete may sever connectivity — confirm before invoking. KNOWN BROKEN through ToolMesh (2026-11): the URL path needs the record's .id, and the percent-encoded .id is answered with HTTP 400.POSTrelease_dhcp_clientRelease the current lease on a DHCP client and re-discover. Brief connectivity drop expected.POSTrenew_dhcp_clientForce a DHCP renew on a client. Useful when DNS/gateway info has changed on the upstream server.GETlist_firewall_filterList IPv4 firewall filter rules. Each rule has chain (input|forward|output|<custom>), action (accept|drop|reject|jump|log|...), protocol, src-address, dst-address, src-port, dst-port, in-interface, out-interface, connection-state, comment. Rules are evaluated TOP-TO-BOTTOM per chain.
PUTadd_firewall_filterAdd an IPv4 firewall filter rule. Required: chain and action. New rules are appended to the END of the chain -- use move_firewall_filter to reorder.
PATCHupdate_firewall_filterUpdate an existing filter rule (any field). KNOWN BROKEN through ToolMesh (2026-11): the URL path needs the record's .id, and the percent-encoded .id is answered with HTTP 400.DELETEdelete_firewall_filterDelete a filter rule. Removing an accept rule can lock you out -- check before deleting. KNOWN BROKEN through ToolMesh (2026-11): the URL path needs the record's .id, and the percent-encoded .id is answered with HTTP 400.POSTmove_firewall_filterReorder filter rules. Move rule(s) in 'numbers' to position before 'destination'.GETlist_firewall_natList IPv4 NAT rules (srcnat/dstnat). Common actions: masquerade (srcnat to outgoing interface), dst-nat (port forward), src-nat, redirect.PUTadd_firewall_natAdd a NAT rule. Common patterns -- Masquerade (LAN to WAN): {chain:'srcnat',action:'masquerade',out-interface-list:'WAN'}. Port forward (DNAT): {chain:'dstnat',action:'dst-nat',protocol:'tcp',dst-port:'80',in-interface:'ether1',to-addresses:'192.168.1.10',to-ports:'8080'}.
PATCHupdate_firewall_natUpdate a NAT rule. KNOWN BROKEN through ToolMesh (2026-11): the URL path needs the record's .id, and the percent-encoded .id is answered with HTTP 400.DELETEdelete_firewall_natDelete a NAT rule. Removing masquerade can break LAN-to-WAN traffic. KNOWN BROKEN through ToolMesh (2026-11): the URL path needs the record's .id, and the percent-encoded .id is answered with HTTP 400.POSTmove_firewall_natReorder NAT rules. Move rule(s) in 'numbers' to position before 'destination'.GETlist_firewall_mangleList mangle rules (packet marking, MSS clamping, TTL, DSCP). Chains: prerouting, postrouting, input, forward, output.PUTadd_firewall_mangleAdd a mangle rule (mark-packet, mark-connection, change-mss, change-ttl, change-dscp, ...).PATCHupdate_firewall_mangleUpdate a mangle rule (any field). KNOWN BROKEN through ToolMesh (2026-11): the URL path needs the record's .id, and the percent-encoded .id is answered with HTTP 400.DELETEdelete_firewall_mangleDelete a mangle rule. Removing mark-routing rules can break policy routing. KNOWN BROKEN through ToolMesh (2026-11): the URL path needs the record's .id, and the percent-encoded .id is answered with HTTP 400.POSTmove_firewall_mangleReorder mangle rules. Move rule(s) in 'numbers' to position before 'destination'.GETlist_firewall_rawList firewall raw rules (pre-conntrack, used for DDoS mitigation and bypassing connection tracking).PUTadd_firewall_rawAdd a raw firewall rule. Raw rules run BEFORE connection-tracking and are evaluated for every packet — keep them lean. Common patterns: notrack for high-volume known-good traffic, drop for known-bad source IPs, ICMP rate-limit pre-conntrack.
PATCHupdate_firewall_rawUpdate a raw firewall rule. KNOWN BROKEN through ToolMesh (2026-11): the URL path needs the record's .id, and the percent-encoded .id is answered with HTTP 400.DELETEdelete_firewall_rawDelete a raw firewall rule. KNOWN BROKEN through ToolMesh (2026-11): the URL path needs the record's .id, and the percent-encoded .id is answered with HTTP 400.POSTmove_firewall_rawReorder raw firewall rules. Move rule(s) in 'numbers' to position before 'destination'.GETlist_firewall_address_listsList firewall address-list entries (named groups of IPs/CIDRs used by other firewall rules).PUTadd_firewall_address_listAdd an entry to a firewall address-list.PATCHupdate_firewall_address_listUpdate an existing address-list entry (address, list, timeout, comment). KNOWN BROKEN through ToolMesh (2026-11): the URL path needs the record's .id, and the percent-encoded .id is answered with HTTP 400.DELETEdelete_firewall_address_listRemove an entry from an address-list. KNOWN BROKEN through ToolMesh (2026-11): the URL path needs the record's .id, and the percent-encoded .id is answered with HTTP 400.GETlist_firewall_connectionsList currently tracked connections (connection-tracking table). Key fields: src-address, dst-address, protocol, tcp-state, timeout, orig-bytes, repl-bytes, reply-src-address (for NAT), reply-dst-address.
GETlist_ipv6_addressesList configured IPv6 addresses. Includes link-local (FE80::/10), GUA, and ULA addresses.PUTadd_ipv6_addressAssign an IPv6 address to an interface.PATCHupdate_ipv6_addressUpdate an IPv6 address record. KNOWN BROKEN through ToolMesh (2026-11): the URL path needs the record's .id, and the percent-encoded .id is answered with HTTP 400.DELETEdelete_ipv6_addressRemove an IPv6 address. KNOWN BROKEN through ToolMesh (2026-11): the URL path needs the record's .id, and the percent-encoded .id is answered with HTTP 400.GETlist_ipv6_routesList the IPv6 routing table.PUTadd_ipv6_routeAdd a static IPv6 route. Default route: dst-address='::/0' with a gateway.PATCHupdate_ipv6_routeUpdate a static IPv6 route. KNOWN BROKEN through ToolMesh (2026-11): the URL path needs the record's .id, and the percent-encoded .id is answered with HTTP 400.DELETEdelete_ipv6_routeDelete a static IPv6 route. KNOWN BROKEN through ToolMesh (2026-11): the URL path needs the record's .id, and the percent-encoded .id is answered with HTTP 400.GETlist_ipv6_firewall_filterList IPv6 firewall filter rules. Same chain/action semantics as IPv4.PUTadd_ipv6_firewall_filterAdd an IPv6 firewall filter rule. Required: chain and action.PATCHupdate_ipv6_firewall_filterUpdate an IPv6 firewall filter rule. KNOWN BROKEN through ToolMesh (2026-11): the URL path needs the record's .id, and the percent-encoded .id is answered with HTTP 400.DELETEdelete_ipv6_firewall_filterDelete an IPv6 firewall filter rule. KNOWN BROKEN through ToolMesh (2026-11): the URL path needs the record's .id, and the percent-encoded .id is answered with HTTP 400.POSTmove_ipv6_firewall_filterReorder IPv6 filter rules. Move rule(s) in 'numbers' to position before 'destination'.GETlist_ipv6_neighborsList the IPv6 neighbor table (NDP, equivalent to ARP for IPv6).GETlist_ipv6_ndList IPv6 Neighbor Discovery / Router Advertisement settings per interface (M, O flags, RA interval, RA lifetime, MTU). This controls RA SENDING (the device acting as an IPv6 router for its LAN), not RA receiving (SLAAC client behavior). For SLAAC client behavior, see get_ipv6_settings / set_ipv6_settings.GETget_ipv6_settingsGet the global IPv6 stack settings. Key fields: disable-ipv6 (yes/no), forward (yes/no -- 'yes' makes the device a router; 'no' a host), accept-router-advertisements (yes | no | yes-if-forwarding-disabled -- the last is the default and means the device accepts RAs only when acting as a host), accept-redirects, max-neighbor-entries, soft-headers, multipath-hash-policy. SLAAC client behavior requires forward='no' AND accept-router-advertisements in {yes, yes-if-forwarding-disabled}.
POSTset_ipv6_settingsUpdate global IPv6 settings. To enable SLAAC on a host/L2-switch: {forward:'no', accept-router-advertisements:'yes'}. Note: changing 'forward' may affect routing behavior across all interfaces -- do this only on devices that should NOT route IPv6 (e.g. switches, end hosts).
GETlist_ipv6_dhcp_clientsList DHCPv6 clients (stateful IPv6 address/prefix from a DHCPv6 server). SLAAC (RA-only) does NOT show up here -- only DHCPv6 client instances do. Each entry has interface, request (address|prefix), status, address, prefix.
GETlist_ppp_secretsList PPP user accounts (used for PPPoE/L2TP/SSTP/PPTP/OVPN servers). Each has name, password (hidden), profile, service, local-address, remote-address.PUTadd_ppp_secretCreate a PPP user account.PATCHupdate_ppp_secretUpdate a PPP user (password, profile, service, addresses, comment, disabled). Pass the record's name as id; a .id such as '*1' fails with HTTP 400 through ToolMesh (percent-encoded asterisk).DELETEdelete_ppp_secretDelete a PPP user account. Pass the record's name as id; a .id such as '*1' fails with HTTP 400 through ToolMesh (percent-encoded asterisk).GETlist_ppp_activeList currently connected PPP sessions (active PPPoE/L2TP/SSTP/PPTP/OVPN clients). Includes name, service, address, uptime, encoding, caller-id.GETlist_ppp_profilesList PPP profiles (templates for sessions: local-address, remote-address pool, dns-server, rate-limit, encryption).PUTadd_ppp_profileCreate a PPP profile. Use to template L2TP/SSTP/PPTP/OVPN session settings (DNS, address pool, rate-limit, encryption).PATCHupdate_ppp_profileUpdate a PPP profile. Pass the record's name as id; a .id such as '*1' fails with HTTP 400 through ToolMesh (percent-encoded asterisk).DELETEdelete_ppp_profileDelete a PPP profile. Cannot delete 'default' or 'default-encryption' built-in profiles. Pass the record's name as id; a .id such as '*1' fails with HTTP 400 through ToolMesh (percent-encoded asterisk).GETlist_routing_tableList routing tables (multi-table support in RouterOS 7). Default is 'main'; custom tables used with routing-mark.GETlist_bgp_peersList BGP peer connections (RouterOS 7 BGP). Each has name, remote.address, remote.as, local.address, local.role, established.PUTadd_bgp_connectionAdd a BGP peer connection (RouterOS 7 BGP). Required: name and remote.address. Use templates for common AS/role config and reference via 'template='.
PATCHupdate_bgp_connectionUpdate a BGP peer connection. Pass the record's name as id; a .id such as '*1' fails with HTTP 400 through ToolMesh (percent-encoded asterisk).DELETEdelete_bgp_connectionDelete a BGP peer connection. Will tear down the BGP session immediately. Pass the record's name as id; a .id such as '*1' fails with HTTP 400 through ToolMesh (percent-encoded asterisk).GETlist_bgp_sessionsList currently established BGP sessions with state, uptime, prefix-count, last-error.GETlist_bgp_templatesList BGP templates (reusable peer-config bundles). RouterOS 7 BGP requires at least one template — usually 'default'.GETlist_ospf_instancesList OSPF instances. Each has name, version, router-id, vrf.PUTadd_ospf_instanceCreate an OSPF instance (RouterOS 7). Required: name, router-id, version (default '2' for OSPFv2).DELETEdelete_ospf_instanceDelete an OSPF instance. All adjacencies in this instance go down. Pass the record's name as id; a .id such as '*1' fails with HTTP 400 through ToolMesh (percent-encoded asterisk).GETlist_ospf_areasList OSPF areas. Each binds an instance to an area-id and type (default | stub | nssa | backbone).PUTadd_ospf_areaCreate an OSPF area (RouterOS 7).DELETEdelete_ospf_areaDelete an OSPF area. Pass the record's name as id; a .id such as '*1' fails with HTTP 400 through ToolMesh (percent-encoded asterisk).GETlist_ospf_interface_templatesList OSPF interface templates (which interfaces speak OSPF, in which area, with which cost/network type).GETlist_ospf_neighborsList OSPF neighbors with router-id, address, area, state (Down|Init|2-Way|ExStart|Exchange|Loading|Full), priority.GETlist_routing_filtersList routing-filter rules (RouterOS 7 unified filter system). Each rule belongs to a chain (referenced from BGP/OSPF in/out filter-chain fields). Fields: chain, rule (filter DSL: 'if (...) {...}'), comment, disabled.
PUTadd_routing_filterAdd a routing-filter rule. RouterOS 7 uses a unified rule DSL across all protocols. Example: chain='bgp-in', rule='if (dst in 0.0.0.0/0) { accept } reject'. Rules in a chain are evaluated top-to-bottom.
PATCHupdate_routing_filterUpdate a routing-filter rule. KNOWN BROKEN through ToolMesh (2026-11): the URL path needs the record's .id, and the percent-encoded .id is answered with HTTP 400.DELETEdelete_routing_filterDelete a routing-filter rule. Removing a deny-all leaf can flood the route table — audit first. KNOWN BROKEN through ToolMesh (2026-11): the URL path needs the record's .id, and the percent-encoded .id is answered with HTTP 400.GETlist_simple_queuesList simple queues (per-IP/per-subnet bandwidth limits). Each has name, target (IP/CIDR/interface), max-limit, burst-limit, parent, queue (queue-type).PUTadd_simple_queueAdd a simple queue for bandwidth shaping.PATCHupdate_simple_queueUpdate a simple queue. Pass the record's name as id; a .id such as '*1' fails with HTTP 400 through ToolMesh (percent-encoded asterisk).DELETEdelete_simple_queueRemove a simple queue. Pass the record's name as id; a .id such as '*1' fails with HTTP 400 through ToolMesh (percent-encoded asterisk).GETlist_queue_treeList queue tree entries (HTB-based hierarchical shaping using packet marks from mangle).GETlist_queue_typesList queue disciplines (default-small, default, ethernet-default, wireless-default, fq-codel, cake, pcq, sfq, red, pfifo, bfifo).POSTpingSend ICMP echo requests to a target. CRITICAL: always pass count (1-10) to bound runtime -- the REST API has a 60s hard timeout. Each iteration is returned as one object in the response array.
POSTtracerouteTrace the network path to a target. ALWAYS set count and timeout to bound runtime. Returns one row per hop with address, loss, sent, last, avg, best, worst.
POSTbandwidth_testRun a bandwidth test against another MikroTik device (target must run bandwidth-server). ALWAYS pass duration to bound runtime. Resource-intensive.
GETlist_netwatchList netwatch monitors (ICMP/TCP/HTTP/HTTPS uptime checks against external hosts). Each has host, status (up|unknown|down), type, since.PUTadd_netwatchCreate a netwatch monitor.PATCHupdate_netwatchUpdate a netwatch monitor (host, type, interval, scripts, port, http-codes, comment, disabled). KNOWN BROKEN through ToolMesh (2026-11): the URL path needs the record's .id, and the percent-encoded .id is answered with HTTP 400.DELETEdelete_netwatchRemove a netwatch monitor. KNOWN BROKEN through ToolMesh (2026-11): the URL path needs the record's .id, and the percent-encoded .id is answered with HTTP 400.GETget_email_settingsGet the SMTP client settings. Singleton — required for send_email and for the 'email' /system/logging/action. Fields: server, port, start-tls, user, password (hidden), from, vrf.
POSTset_email_settingsUpdate the SMTP client settings. RouterOS 7.13+ uses the field 'tls' (no | starttls | tls-only); older releases used 'start-tls' as a boolean — both are accepted on 7.13+ for backward compatibility but prefer 'tls'. STARTTLS submission (port 587): {server:'smtp.example.com', port:'587', tls:'starttls', user:'noreply@x', password:'<pwd>', from:'router@x'}. Implicit TLS (port 465): tls='tls-only'. Cleartext (port 25): tls='no'.
POSTsend_emailSend an email via the configured /tool/e-mail SMTP settings. Useful for alerting from scripts/scheduler.GETlist_usersList local user accounts. Each has name, group, address (allowed source CIDR), last-logged-in, disabled.GETget_userGet a single user by name. A .id such as '*1' fails with HTTP 400 through ToolMesh (percent-encoded asterisk).PUTadd_userCreate a local user.PATCHupdate_userUpdate a user (password, group, source restriction, comment, disabled). Pass the record's name as id; a .id such as '*1' fails with HTTP 400 through ToolMesh (percent-encoded asterisk).DELETEdelete_userDelete a user. Cannot delete the user you're authenticated as. Pass the record's name as id; a .id such as '*1' fails with HTTP 400 through ToolMesh (percent-encoded asterisk).GETlist_user_groupsList user groups (named bundles of policies). Default groups: read, write, full. Each has name and policy field (comma-separated).PUTadd_user_groupCreate a custom user group with specific policies.PATCHupdate_user_groupUpdate an existing user group's policies, skin, or comment. Cannot rename built-in 'read', 'write', 'full' groups. Pass the record's name as id; a .id such as '*1' fails with HTTP 400 through ToolMesh (percent-encoded asterisk).DELETEdelete_user_groupDelete a custom user group. Built-in groups (read/write/full) cannot be deleted. Users assigned to a deleted group are orphaned — re-assign first. Pass the record's name as id; a .id such as '*1' fails with HTTP 400 through ToolMesh (percent-encoded asterisk).GETlist_active_usersList currently authenticated user sessions. Includes name, address (source IP), via (ssh|winbox|webfig|api|rest|console), when.GETlist_user_ssh_keysList installed SSH public keys for user authentication.POSTimport_user_ssh_keyImport an SSH public key from a file in /file for a user.GETlist_certificatesList installed certificates and CAs. Each has name, common-name, subject-alt-name, issuer, expires-after, days-valid, fingerprint, private-key (yes/no).POSTsign_certificateSign a certificate request with a CA certificate. Used in PKI workflows.POSTimport_certificateImport a certificate from a file in /file (PEM or PKCS#12).GETlist_filesList files stored on the device flash. Includes name, type (file|directory|disk|.backup|.rsc|.crt|.key|.umb), size, creation-time.DELETEdelete_fileDelete a file from device flash. Cannot delete in-use files. Pass the record's name as id; a .id such as '*1' fails with HTTP 400 through ToolMesh (percent-encoded asterisk).GETlist_logsList system log entries. Each has time, topics (e.g. 'system,info'), message. Logs are circular -- old entries are overwritten. Filter by topics= via query for targeted lookups.
GETlist_logging_rulesList logging rules — each routes a topic pattern to an action. Fields: topics (comma-separated AND-list, '!' to negate), action (action name, e.g. 'memory', 'remote', 'graylog'), prefix, regex, disabled. Rules are evaluated for every log line; matching is a logical OR across multiple rules.
PUTadd_logging_ruleAdd a logging rule. Most common pattern for remote forwarding: {topics:'', action:'remote'} forwards EVERY topic to the remote action. Narrower: {topics:'system,info', action:'graylog'} forwards only system-info lines. Negation: {topics:'firewall,!debug', ...} excludes debug-severity firewall messages.
PATCHupdate_logging_ruleUpdate a logging rule (topics, action, prefix, regex, comment, disabled). KNOWN BROKEN through ToolMesh (2026-11): the URL path needs the record's .id, and the percent-encoded .id is answered with HTTP 400.DELETEdelete_logging_ruleDelete a logging rule. The 5 default actions remain available; only your custom rules are removed. KNOWN BROKEN through ToolMesh (2026-11): the URL path needs the record's .id, and the percent-encoded .id is answered with HTTP 400.GETlist_logging_actionsList logging actions — destinations for log lines. RouterOS ships with 5 default actions that CANNOT be deleted or renamed: memory, disk, echo, remote, email. Add new actions for additional targets (multiple Graylog inputs, secondary syslog, etc.).
PUTadd_logging_actionAdd a logging action (destination). Common pattern for Graylog (CEF over TCP): {name:'graylog', target:'remote', remote:'192.0.2.15', remote-port:'514', remote-protocol:'tcp', remote-log-format:'cef', syslog-time-format:'iso8601'}. For a second memory ring buffer: {name:'audit', target:'memory', memory-lines:'5000'}.
PATCHupdate_logging_actionUpdate a custom logging action. NOTE: for the 5 built-in actions (memory, disk, echo, remote, email) PATCH on the path is unreliable — use set_logging_action with numbers='remote' (etc.) instead. Pass the record's name as id; a .id such as '*1' fails with HTTP 400 through ToolMesh (percent-encoded asterisk).
POSTset_logging_actionAtomically update one or more logging actions via CLI-style '/system/logging/action set'. THIS IS THE WAY to re-aim the built-in 'remote' or 'email' actions: {numbers:'remote', remote:'10.0.0.5', remote-protocol:'tcp', remote-log-format:'cef'} — the built-ins can be re-configured but not renamed/deleted. Reference via 'numbers' (action name or .id).
DELETEdelete_logging_actionDelete a custom logging action. The 5 default actions (memory/disk/echo/remote/email) cannot be deleted. Pass the record's name as id; a .id such as '*1' fails with HTTP 400 through ToolMesh (percent-encoded asterisk).GETget_snmp_settingsGet SNMP agent settings: enabled, contact, location, engine-id, src-address, trap-target.POSTupdate_snmp_settingsUpdate SNMP agent settings.GETlist_snmp_communitiesList SNMP v1/v2c communities and v3 users. Includes name, addresses (source CIDRs), security, read-access, write-access.GETget_l2tp_serverGet L2TP server config (singleton). Fields: enabled, max-mtu, max-mru, mrru, authentication (comma list of mschap2,mschap1,chap,pap), default-profile, use-ipsec ('no'|'yes'|'required'), ipsec-secret, caller-id-type, allow-fast-path.POSTset_l2tp_serverUpdate L2TP server config. To enable plain L2TP: {enabled:'yes', authentication:'mschap2', default-profile:'default-encryption'}. For L2TP/IPsec: {enabled:'yes', use-ipsec:'required', ipsec-secret:'<psk>'}. Per-user accounts live in /ppp/secret with service='l2tp'.
GETget_sstp_serverGet SSTP server config (singleton). Fields: enabled, port, certificate, authentication, default-profile, max-mtu, max-mru, mrru, tls-version, verify-client-certificate, force-aes.POSTset_sstp_serverUpdate SSTP server config. Required: a TLS certificate (certificate=<name>). Default port is 443 — make sure it does NOT collide with www-ssl (REST API). Common: {enabled:'yes', certificate:'sstp-cert', port:'8443', authentication:'mschap2', default-profile:'default-encryption'}.
GETget_pptp_serverGet PPTP server config (singleton). Fields: enabled, max-mtu, max-mru, mrru, authentication, default-profile, keepalive-timeout. NOTE: PPTP is cryptographically broken — use L2TP/IPsec, SSTP, or WireGuard for new deployments.POSTset_pptp_serverUpdate PPTP server config. Discouraged for new deployments.GETget_ovpn_serverGet OpenVPN server config (singleton). Fields: enabled, port, mode, netmask, mac-address, max-mtu, certificate, require-client-certificate, auth (md5|sha1|sha256|sha512), cipher (blowfish128|aes128-cbc|aes192-cbc|aes256-cbc|aes128-gcm|aes192-gcm|aes256-gcm), default-profile, tls-version, redirect-gateway.POSTset_ovpn_serverUpdate OpenVPN server config. RouterOS supports TCP only (no UDP). Modern interop: {enabled:'yes', mode:'ip', port:'1194', certificate:'ovpn-cert', require-client-certificate:'yes', auth:'sha256', cipher:'aes256-gcm,aes256-cbc', default-profile:'default-encryption'}.
GETlist_ipsec_peersList IPsec peers. Each peer = remote endpoint + auth method + exchange-mode. Fields: name, address, profile, exchange-mode (ike2 recommended), passive, send-initial-contact, comment, disabled.PUTadd_ipsec_peerAdd an IPsec peer. For IKEv2 modern setup: {name:'site-a', address:'203.0.113.5/32', profile:'default', exchange-mode:'ike2'}.PATCHupdate_ipsec_peerUpdate an IPsec peer. Pass the record's name as id; a .id such as '*1' fails with HTTP 400 through ToolMesh (percent-encoded asterisk).DELETEdelete_ipsec_peerDelete an IPsec peer. Tears down all SAs to that peer. Pass the record's name as id; a .id such as '*1' fails with HTTP 400 through ToolMesh (percent-encoded asterisk).GETlist_ipsec_identitiesList IPsec identities — bind peers to auth credentials + mode-config + policy template.PUTadd_ipsec_identityAdd an IPsec identity (peer + auth credentials). For PSK: {peer:'site-a', auth-method:'pre-shared-key', secret:'<psk>'}. For IKEv2 EAP: {peer:'rw', auth-method:'eap', eap-methods:'eap-mschapv2', username:'alice', password:'<pwd>'}.PATCHupdate_ipsec_identityUpdate an IPsec identity. KNOWN BROKEN through ToolMesh (2026-11): the URL path needs the record's .id, and the percent-encoded .id is answered with HTTP 400.DELETEdelete_ipsec_identityDelete an IPsec identity. KNOWN BROKEN through ToolMesh (2026-11): the URL path needs the record's .id, and the percent-encoded .id is answered with HTTP 400.GETlist_ipsec_profilesList IPsec IKE profiles (Phase-1 / IKE_SA_INIT proposals). Each has name, hash-algorithm, enc-algorithm, dh-group, lifetime, nat-traversal.PUTadd_ipsec_profileAdd an IPsec profile. Modern IKEv2: {name:'strong', hash-algorithm:'sha256', enc-algorithm:'aes-256', dh-group:'modp2048,ecp256', lifetime:'1d', nat-traversal:'yes'}.PATCHupdate_ipsec_profileUpdate an IPsec profile. Pass the record's name as id; a .id such as '*1' fails with HTTP 400 through ToolMesh (percent-encoded asterisk).DELETEdelete_ipsec_profileDelete an IPsec profile. Cannot delete 'default'. Pass the record's name as id; a .id such as '*1' fails with HTTP 400 through ToolMesh (percent-encoded asterisk).GETlist_ipsec_proposalsList IPsec ESP/AH proposals (Phase-2 / CHILD_SA crypto). Each has name, auth-algorithms, enc-algorithms, pfs-group, lifetime.PUTadd_ipsec_proposalAdd an IPsec ESP/AH proposal.PATCHupdate_ipsec_proposalUpdate an IPsec proposal. Pass the record's name as id; a .id such as '*1' fails with HTTP 400 through ToolMesh (percent-encoded asterisk).DELETEdelete_ipsec_proposalDelete an IPsec proposal. Cannot delete 'default'. Pass the record's name as id; a .id such as '*1' fails with HTTP 400 through ToolMesh (percent-encoded asterisk).GETlist_ipsec_policiesList IPsec policies. Each policy = src/dst selector + action (encrypt|none|discard) + proposal + peer.PUTadd_ipsec_policyAdd an IPsec policy. Static site-to-site: {peer:'site-a', src-address:'10.0.0.0/24', dst-address:'10.1.0.0/24', action:'encrypt', tunnel:'yes', proposal:'default', sa-src-address:'<local>', sa-dst-address:'<peer>'}. Road-warrior dynamic template: {peer:'rw', template:'yes', dst-address:'0.0.0.0/0', action:'encrypt'}.
PATCHupdate_ipsec_policyUpdate an IPsec policy. KNOWN BROKEN through ToolMesh (2026-11): the URL path needs the record's .id, and the percent-encoded .id is answered with HTTP 400.DELETEdelete_ipsec_policyDelete an IPsec policy. Active SAs are torn down. KNOWN BROKEN through ToolMesh (2026-11): the URL path needs the record's .id, and the percent-encoded .id is answered with HTTP 400.GETlist_ipsec_active_peersList currently negotiated IPsec peers. Fields: id, state (established | half-open | ...), uptime, side, remote-address, dynamic-address.GETlist_ipsec_installed_saList currently installed IPsec SAs (Phase-2 ESP/AH security associations). Useful for debugging which selectors negotiated and how much data has flowed.POSTflush_ipsec_saTear down all currently installed IPsec SAs. They will renegotiate on next traffic. Use to recover from stuck SA state.GETget_ipsec_settingsGet global IPsec settings (singleton). Fields: accept-redirects, interim-update, max-events-per-second, xauth-use-radius.POSTset_ipsec_settingsUpdate global IPsec settings.GETlist_containersList Docker-like containers configured on RouterOS (v7.4+ on supported hardware). Each has name, root-dir, mounts, interface, status, dns.GETlist_container_envsList container environment variables defined for use across containers.GETlist_container_mountsList defined container mount points (host directory to container path mappings).