[PAID] MIKROTIK API (RouterOS v6 & v7)

Extensions
, , , , , , , ,
1

EXTENSION DESCRIPTION

This extension allows your Kodular / App Inventor app to connect and control MikroTik Routers (RouterOS v6 & v7) using the RouterOS API.

With this extension you can:

  • Connect to your MikroTik router using SSL or Plain API
  • Send commands synchronously or asynchronously
  • Receive router responses as human-readable text or JSON
  • Build advanced apps such as network monitoring dashboards, hotspot management, PPPoE manager, or router automation tools

:electric_plug: Connection & Configuration

image
image492×207 8.18 KB

This block connects to the MikroTik router and performs authentication.
Parameters:

  • ip – String, router IP address (e.g., "192.168.88.1")
  • port – Number, API port (8728 for plain, 8729 for SSL)
  • username – String, MikroTik username
  • password – String, MikroTik password
    The connection will follow the selected ConnectionMode (AUTO / SSL_ONLY / PLAIN_ONLY).

Disconnect

image
image364×123 3.86 KB

Disconnects from the router and closes the socket.
No parameters.

IsConnected
image
Returns a Boolean:

  • true → router is connected
  • false → connection lost / not connected

:stopwatch: Timeout Settings

ConnectTimeout

image

Sets the timeout for the connection phase.

Parameters:

  • timeoutMs – Number in milliseconds (default: 8000)

If set to 0 or negative, it falls back to 8000.

ConnectTimeout (getter)

image
Returns the current connection timeout.

ReadTimeout

image

Sets the timeout for reading router responses.

Parameters:

  • timeoutMs – Number in milliseconds (default: 8000)

ReadTimeout (getter)

image
Returns the current read timeout.

:globe_with_meridians: Connection Mode (SSL / Plain)

ConnectionMode

image

Sets the connection mode for the API.

Value Mode
0 AUTO (try SSL then fallback to plain)
1 SSL_ONLY
2 PLAIN_ONLY

AUTO is recommended for most cases.

ConnectionMode (getter)

image

Returns:

  • 0 → AUTO
  • 1 → SSL_ONLY
  • 2 → PLAIN_ONLY

:envelope_with_arrow: Synchronous Commands

Synchronous commands wait for the router response and return the result directly.

Recommended for normal usage when you need to get values immediately.

ResponseSendCommand

image

Sends a RouterOS command and returns a formatted text output.

Parameters:

  • command – String (RouterOS command)
/ip/hotspot/user/print

For multi-line commands:

/ip/hotspot/user/print
?name=user1

Returns: text formatted like this:

[1]
.id: *1
name: user1
profile: default
uptime: 00:10:21

ResponseJsonSendCommand

image

Sends a RouterOS command and returns the output in JSON array format.

Example Response:

[
  {"name":"user1","profile":"default","uptime":"00:10:21"},
  {"name":"user2","profile":"VIP","uptime":"02:11:03"}
]

If the router returns !trap, the block returns "" and triggers OnError.

:high_voltage: Asynchronous Commands

Async commands run in a separate thread (non-blocking).
The result is received via an event callback.

SendCommandAsync

image

Sends a RouterOS command asynchronously.
The result will be returned via:

OnResponseAsync(command, response)

SendJsonCommandAsync

image

Sends a command asynchronously and returns the result as JSON via:

OnJsonResponseAsync(command, jsonResponse)

:bell: Events

OnConnected

image
image583×127 6.44 KB

Triggered when the connection and authentication to the router is successful.

OnError

image
image463×107 5.69 KB

Triggered when an error occurs (connection, login, send, read, router trap).

Returns:

  • errorMessage – String containing the error

OnResponseAsync

image

Triggered when SendCommandAsync returns a response.

Parameters:

  • command – String sent to the router
  • response – Formatted text result

OnJsonResponseAsync

(image)

Triggered when SendJsonCommandAsync returns a JSON output.

Parameters:

  • command
  • jsonResponse

:blue_book: Simple Usage Example

Connect on screen startup

image
image760×311 36.1 KB

:package: What’s included with this extension?

Item Included
MikroTikAPI .aix :white_check_mark:
Documentation (README) :white_check_mark:
Lifetime updates :check_mark: Free
Unlimited app usage :check_mark: No restrictions

:money_bag: Price and License

Price: $5 (one-time payment — lifetime license)

You are allowed to:
:check_mark: Use in unlimited projects
:check_mark: Connect to unlimited routers
:check_mark: Publish apps made using this extension

You are not allowed to:
✘ Resell the .aix file as a standalone product without permission

PM or comment below to buy

:credit_card: Payment Methods

You can purchase this extension using any of the following payment methods:

:check_mark: PayPal
:check_mark: Crypto (USDT, BTC, BNB, etc.)
:check_mark: QRIS (for buyers from Indonesia)

1 Like