API Links

janisk · Tue Feb 22, 2011 10:34 am

on what board you try to run this and on what RouterOS version?

Tried this on RB1000 with 5.0rc10

first, separate commands, removed quotation from =contents="some text" as that is not required to be there in rsc file.
[edit] wanted to add a bit about the protocol and how this works.
so you send in length and string, that in this case is formed this way:
=contents=blah..blah

API will read length, if it is not too long, it will read the string and see that argument is =contents= the rest of the string is value for the argument. Because of all this, you can set contents to whatever you like, even if you set it to "= contents=" it will be no concern for API.

Same thing happens when API returns some stuff, like script, you get =source=<whole script>

[/edit]

second ran it some other C++ code that did these commands

$ time ./TestAPI 
ret: !done
ret: !done

ret: !done

ret: !done


real    0m0.270s
user    0m0.000s
sys     0m0.000s

p.s. since i am paranoid of sorts, did not run your code.

danikf · Mon Mar 14, 2011 9:05 am

Hi,
please add this link to wiki:
.NET (C#) high-level api solution: http://code.google.com/p/mikrotik4net/

thx, danik

sw0rdf1sh · Tue Mar 22, 2011 1:42 pm

Please add this as well:

http://wiki.mikrotik.com/wiki/Api_php_template
Thanx

Chupaka · Wed Mar 23, 2011 12:20 am

Please add this as well:

http://wiki.mikrotik.com/wiki/Api_php_template

are these examples of PHP API Class usage?..

sw0rdf1sh · Wed Mar 23, 2011 12:54 am

Please add this as well:

http://wiki.mikrotik.com/wiki/Api_php_template
are these examples of PHP API Class usage?..

Chupaka I searched before building and posting in the wiki and I didn't find any example using this php api.So I did. If you believe they don't belong in the wiki then please delete so.

As for the use I believe it's a simple way of displaying info into a more readable form for a website rather than the respond from the api in an array format.

Chupaka · Wed Mar 23, 2011 2:01 am

sure, they should be in Wiki, just correct the text: it's not "based on the PHP API Class", it "uses PHP API Class" - you deceive people a bit...

all the rest is fine =)

janisk · Wed Mar 23, 2011 10:31 am

linked php api to these templates, thx.

sw0rdf1sh · Wed Mar 23, 2011 1:28 pm

sure, they should be in Wiki, just correct the text: it's not "based on the PHP API Class", it "uses PHP API Class" - you deceive people a bit...

all the rest is fine =)

Sorry for that.My mistake.It's corrected now.

chapeupreto · Wed Mar 23, 2011 4:06 pm

Hi folks.
First, thanks for those links.
By talking in PHP API, I've downloaded the php class mikrotik api posted here

http://forum.mikrotik.com/viewtopic.php?f=9&t=50176

by sw0rdf1sh and I'm using it in some of my projects.
After executing a script that uses that routeros_api.class.php class, I got this message:

Notice: Undefined variable: _ in ... on line 313

Then, I would like to ask you guys a question:
First, consider the following piece of code which exists in that php class (lines 300 up to 320)

// If we have got more characters to read, read them in.
         if ($LENGTH > 0) {
            $_ = "";
            $retlen=0;
            while ($retlen < $LENGTH) {
               $toread = $LENGTH - $retlen ;
               $_ .= fread($this->socket, $toread);
               $retlen = strlen($_);
            }
            $RESPONSE[] = $_ ;
            $this->debug('>>> [' . $retlen . '/' . $LENGTH . ' bytes read.');
         }

         // If we get a !done, make a note of it.
         if ($_ == "!done")
            $receiveddone=true;

         $STATUS = socket_get_status($this->socket);

         
         if ($LENGTH > 0)
            $this->debug('>>> [' . $LENGTH . ', ' . $STATUS['unread_bytes'] . '] ' . $_);

So, there is this PHP variable $_ on it.
Besides the code above, I've glanced the entire class and saw no other mentions for that $_
I suppose my script don't execute those instructions inside that first conditional, i.e., if ($LENGTH > 0) ...
Therefore, when the script reachs that second conditional, i.e., if ($_ == "!done"), the PHP produces the notice message

undefined variable: _

, just because the $_ variable had never been initialized.
Although it's just a simple notice message, is that code right? I mean, don't you guys think the $_ variable should be initialized somewhere before the execution of those IF's?
I tried to contact the author of that API class, but got no success.
That's it.
Thanks for any reply and suggestions.

rod~

trakkasure · Wed May 18, 2011 8:49 pm

Just wanted to add my new API to the list of available:

Written in NodeJS: https://github.com/Trakkasure/mikronode

Installable with NPM

npm install mikronode

Features:

* 100% Javascript. (with NodeJS)
* Channel based communication
* Multiple channels can be used at once.
* Synchronous execution of commands issued on the same channel.
* Asynchrounous execution of commands issued on different channels.
* Focus on high performance

... Now if only it would end up in the list on the Wiki ...

janisk · Thu May 19, 2011 9:51 am

it would be nice if you could make wiki page for your implementation. With more explanations or example.

trakkasure · Thu May 19, 2011 7:41 pm

it would be nice if you could make wiki page for your implementation. With more explanations or example.

I didn't know I had access to create a wiki page. I'll figure it out.

The GitHub page, https://github.com/trakkasure/mikronode, has full source and examples.

And it can be installed using npm (For those who use it):

npm install mikronode

It works very well. And I have plans to further develop and support it.

trakkasure · Thu May 19, 2011 8:25 pm

I didn't know I had access to create a wiki page. I'll figure it out.

Ok. So.. I created a wiki page (http://wiki.mikrotik.com/wiki/User_talk:Trakkasure).. It's under my "talks page".
So.. how do I create one outside of my talks one? (or does someone else do that?)

Still trying to figure it out.

Chupaka · Fri May 20, 2011 2:26 am

So.. how do I create one outside of my talks one? (or does someone else do that?)

Still trying to figure it out.

yeah, with Google search it's a bit tricky...

http://wiki.mikrotik.com/index.php?titl ... ction=edit - replace "MyNewPageTitle" with necessary string... or just put http://wiki.mikrotik.com/wiki/MyNewPageTitle to the Address bar and then press "Create" link

trakkasure · Fri May 20, 2011 3:54 am

put http://wiki.mikrotik.com/wiki/MyNewPageTitle to the Address bar and then press "Create" link

Ok.. Done.

http://wiki.mikrotik.com/wiki/MikroNode

I don't have permission to edit the Manual::API page. So....

janisk · Fri Jun 03, 2011 8:53 am

added link from API page to your creation and back

trakkasure · Fri Jun 03, 2011 11:17 pm

Thanks you.

saaremaa · Mon Aug 01, 2011 5:06 pm

Need Help. Python API from Wiki does not work in Python 3.2.xxx.? Please share a working API.

janisk · Wed Aug 03, 2011 3:10 pm

yes, python API client example from API manual page was written some time ago and is working only with Python 2.7.x or older.

However I have created example (based on Python2 example) for Python3

saaremaa · Wed Aug 03, 2011 6:20 pm

yes, python API client example from API manual page was written some time ago and is working only with Python 2.7.x or older.

However I have created example (based on Python2 example) for Python3

You can upload API for Python 3.x.x ?

Chupaka · Wed Aug 03, 2011 11:18 pm

it was already here: http://wiki.mikrotik.com/wiki/Manual:API_Python3

saaremaa · Wed Aug 03, 2011 11:32 pm

it was already here: http://wiki.mikrotik.com/wiki/Manual:API_Python3

Imho, api ( http://wiki.mikrotik.com/wiki/Manual:API_Python3) contains syntax errors. Or am I mistaken?

janisk · Thu Aug 04, 2011 8:25 am

well i was successful running it

, running commands etc.

and python does not complain

saaremaa · Thu Aug 04, 2011 8:32 am

well i was successful running it , running commands etc.

and python does not complain

OS: Ubuntu Server + Python 3.2

File "./api.py", line 33
attrs[w] =
^
SyntaxError: invalid syntax

janisk · Thu Aug 04, 2011 8:37 am

wiki spacing could be the problem. File added to wiki. Just have to rename it to py from txt it is saved on the wiki.

this is how it runs:

$ python3 api.py tst admin ''
<<< /login
<<<
>>> !done
>>> =ret=39fe3aa4385c1820b5df799739b50761
>>>
<<< /login
<<< =name=admin
<<< =response=000ef1c4c0919129902827644fe9c65efb
<<<
>>> !done
>>>

edit:
did changes to article and made sure that wiki spacing does not interfere with python

downloaded from python.org && compiled

$ python3 --version
Python 3.2.1

saaremaa · Thu Aug 04, 2011 8:47 am

Thank you for your help. The problem is not only in the gaps Wiki. In Ubuntu it was set to simultaneously release Python v2 and v3. Removed Python v2 and everything started.

janisk · Thu Aug 04, 2011 10:12 am

reading post elsewhere in the forum realised that python3 example is not capable to connect to ipv6 hosts, so i did small update to correct that.

saaremaa · Thu Aug 04, 2011 10:54 pm

Python3 API crashed if comment contain symbol`s different from the English symbol`s.

<<< /login
<<<
>>> !done
>>> =ret=a341a4f9r5b81fadfr40w29y04c2d8c4
>>>
<<< /login
<<< =name=asdfgh
<<< =response=00a919e4rd2795wqdfc036brc8ay19a9911
<<<
>>> !done
>>>
/ip/firewall/address-list/getall

<<< /ip/firewall/address-list/getall
<<<
>>> !re
>>> =.id=*11
>>> =list=local-net
>>> =address=192.168.39.0/24
>>> =dynamic=false
>>> =disabled=false
>>> =comment=test0
>>>
>>> !re
>>> =.id=*4F
>>> =list=l-2048-2048
>>> =address=192.168.39.0/24
>>> =dynamic=false
>>> =disabled=false
>>> =comment=Unauth custommers speed
>>>
>>> !re
>>> =.id=*114
>>> =list=l-1536-1536
>>> =address=192.168.38.0/24
>>> =dynamic=false
>>> =disabled=true
Traceback (most recent call last):
File "api.py", line 164, in <module>
main()
File "api.py", line 148, in main
x = apiros.readSentence()
File "api.py", line 50, in readSentence
w = self.readWord()
File "api.py", line 60, in readWord
ret = self.readStr(self.readLen())
File "api.py", line 131, in readStr
s = self.sk.recv(length - len(ret)).decode('UTF-8')
UnicodeDecodeError: 'utf8' codec can't decode byte 0xc4 in position 9: invalid continuation byte

janisk · Mon Aug 08, 2011 12:28 pm

similar to cli it will show weird symbol. as generally it is not known what value is paced there and what it should mean.

Mon Aug 29, 2011 11:52 pm

Hi.

Please add this to the Wiki:
https://sourceforge.net/projects/netrouteros/

It's for PHP, but unlike the previous ones, it's heavily OOP and requires PHP 5.3 (for the sake of namespaces), and this in an effort to make it look like a more "natural" extension to PHP, rather than a "bolt on" (and also to simplify some stuff that if you want to use with the other APIs, you really need to know what you're doing).

I'd appreciate any feedback, both here, and on the project page.

ormg770 · Tue Oct 18, 2011 7:18 pm

Wish someone could help me with an asp API.

Thanks in advance

Tue Oct 18, 2011 8:37 pm

Wish someone could help me with an asp API.

Thanks in advance

On the bottom of the API's wiki page, you can see 3 .NET clients - in C#, VB.NET, and an external C# project.

Assuming that by "ASP", you're talking about "ASP.NET", you can use any one of these clients (IMHO, mikrotik4net looks like the most sophisticated client, and as such, the one I'd pick). If by "ASP", you really mean "ASP", as in "ASP classic", I must ask... why? Why not upgrade to ASP.NET?

If you mean you're actually using one of these clients and are having problems... post a new topic about it or something.

vthinkteam · Sun Nov 20, 2011 7:45 am

We have developing Mikrotik RouterOS API Library from Denis Basta (denis.basta@gmail.com) routeros_api class and we change it to our core class with name Mapi_Core. We have been tested with RouterOS version 3 and above. This spark library allow your Mikrotik RouterOS via CodeIgniter Framework for PHP, and we have make it easier than before for access and manipulating Mikrotik RouterOS API with specific method.

If you are CodeIgniter Framework Programmer, you can get Library for CodeIgniter Spark in this link :

Spark Library : http://getsparks.org/packages/mikrotik_api/show
Spark Repository : https://github.com/vthink/mikrotik_api
Documentation : http://doc.vthink.web.id
Updates Info : http://vthink.web.id/index.php/content/categories/21

if you have codeigniter but doesn't have a spark management package you can install it via terminal with this command :

php -r "$(curl -fsSL http://getsparks.org/go-sparks)"

more information about what is CodeIgniter Spark PHP Framework, please open this link:
http://getsparks.org/install

ve3nbe · Thu Dec 01, 2011 12:02 pm

Thank you very much

vthinkteam · Fri Dec 02, 2011 11:57 am

By the way how about Mikrotik API Java that janisk created... how it licensed???
I was read in wiki, license said that

Code is provided as is and can be freely used freely. I, as a writer of code, am not responsible for anything that may arise from use of this code.

But I can't see that licensed on GPL or MIT or BSD or something else???
I was developing library that I plan for license on GPL 3. My Core library using MikroTik API Java that was created by Janisk, and I'm doing some modification for adapting with My Library. How do I license janisk work to be part of my library, and how to say that I was doing modification on that class.

If janisk here please respond me...

vthinkteam · Fri Dec 02, 2011 11:58 am

And one things I'm new on Licensing... soo, help me to understand it..

janisk · Fri Dec 02, 2011 2:21 pm

i see all of these licenses restrictive for this peace of code. So, the code is provided AS-IS, you can freely use it as a whole or parts of it, edit it to suit your needs and your project. If you see errors in the code and want them fixed you can contact me and notify about those. If you are going to publish source of your code under some license, just make sure that nobody is going to write me saying that i have some licensed code on the page that i either have to license under same license and write down who the real author is.

vthinkteam · Fri Dec 02, 2011 5:31 pm

Thankz for reply my post...

Can I get your email? cause when I want to contact you, I cannot see email or any other contact for communicating with you.
send me message to vthinkteam@gmail.com

I analyze what you said in this.

If you are going to publish source of your code under some license, just make sure that nobody is going to write me saying that i have some licensed code on the page that i either have to license under same license and write down who the real author is.

first thing, I want to publish my source code with the your source code inside some package of my source code. I will make library called JRouterOS and I want use GPL 3 license on it.

This the situation :
Your code using AS-IS or in other words "unlicensed" (this my opinion).
My Code using license GPL 3.
I want to distribute jar , javadoc, and src in one bundle, that your code in that bundle too.
Your code will be inside JRouterOS.jar in some package on classpath of this jar.

With this situation my question is :
1. Does the license GPL with unlicensed will compatible in one bundle...
2. or, Do my code cannot licensed to GPL 3, so I have to use AS-IS too...

janisk · Thu Dec 08, 2011 1:37 pm

AFAIK you can use my code, just in header add notice that where this code was taken from. That should suffice.

legrang · Mon Dec 30, 2013 2:12 pm

I have written a Java client library for the Mikrotik API.

The library, source code and examples can be found here: https://github.com/GideonLeGrange/mikrotik-java

Current version is 1.0, with 1.1 - which will support TLS encryption - due shortly.

I appreciate all questions and comments.

-
Gideon

janisk · Mon Mar 24, 2014 1:46 pm

somehow i missed your post. Added your java link to the wiki.

comtihon · Fri Jun 13, 2014 3:47 am

I made api for Erlang, please add it to your wiki -> https://github.com/comtihon/erotik

Chupaka · Fri Jun 13, 2014 12:51 pm

I made api for Erlang, please add it to your wiki -> https://github.com/comtihon/erotik

ahhh, I'm in love with than name!..

serthan · Wed Jul 09, 2014 5:30 pm

/ip/hotspot/user/remove
=numbers=123

username:123
password:123

api kod doesnt work, mikrotik removing another user which have id=123
can we use =name= or anything instead of =numbers=
thx

Wed Jul 09, 2014 6:19 pm

You can get ID by name
/ip/hotspot/user/print
?name=123
=.proplist=.id

and tehn run remove command

Chupaka · Wed Jul 09, 2014 7:11 pm

/ip/hotspot/user/remove
=numbers=123

username:123
password:123

api kod doesnt work, mikrotik removing another user which have id=123
can we use =name= or anything instead of =numbers=
thx

well, not 'numbers' but '.id', I think. also, .id is in '*number' format, so if '123' is username, then you can use it as .id (need to be checked, but in other places you can use unique name for .id) without worrying that user with .id equal to *123 will be deleted

janisk · Tue Aug 05, 2014 3:09 pm

I made api for Erlang, please add it to your wiki -> https://github.com/comtihon/erotik

thanks for example, added to wiki.

ibrahim10101 · Wed Oct 29, 2014 5:13 pm

how to read data with c# ????

Chupaka · Thu Oct 30, 2014 12:25 pm

how to read data with c# ????

http://wiki.mikrotik.com/wiki/API_in_C_Sharp

luan · Mon Jun 01, 2015 1:26 am

Hi folks.
I need to print on a table id and the name of the hostpot users.
and remove the User by his id.
Can anyone help me.

luan · Mon Jun 01, 2015 1:29 am

Hi folks.
I need to print on a table id and the name of the hostpot users.
and remove the User by his id.
Can anyone help me.
I use C Sharp

Chupaka · Mon Jun 01, 2015 2:02 pm

Hi folks.
I need to print on a table id and the name of the hostpot users.
and remove the User by his id.
Can anyone help me.

/ip/hotspot/user/print
=.proplist=.id,name

then

/ip/hotspot/user/remove
=.id=ID_HERE

I use C Sharp

http://wiki.mikrotik.com/wiki/API_in_C_Sharp

kgninfos · Sat Jun 13, 2015 6:11 pm

can anyone post a sample project with source on how to use the api in Android app
a simple /ip/address/print with parsing and show the result in textfeild/ table would be enough

Thanks

danikf · Fri Aug 28, 2015 1:01 am

Hi all,

please redirect link for tik4net (.NET (C#) - external by danikf) to new location (both in this thread and in wiki links).

New location of tik4net project: https://github.com/danikf/tik4net
And newly created thread here: http://forum.mikrotik.com/viewtopic.php?f=9&t=99954

Thanks,
D

nuclide · Thu Nov 05, 2015 9:02 pm

Can anybody make the API for VB (for VB projects and ASP pages)?!

Thanks,
Mladen

It will be wonderful

danikf · Sun Nov 08, 2015 6:41 pm

Hi,

why not use C# (.NET) dlls in VB (also .NET) code?

D

andredossantos · Thu Jul 21, 2016 11:34 pm

Implementation in Go (Golang):
https://github.com/go-routeros/routeros

To install, run: go get gopkg.in/routeros.v1

andredossantos · Fri Jul 22, 2016 1:55 pm

Added Go implementation page to the wiki.
Could someone link to it from the API page?

http://wiki.mikrotik.com/wiki/API_in_Go

janisk · Fri Jan 20, 2017 4:06 pm

Added Go implementation page to the wiki.
Could someone link to it from the API page?

http://wiki.mikrotik.com/wiki/API_in_Go

Added,

we really appreciate your input. Hopefully, a lot of our users will find this useful.

igorvukotic · Sun Nov 26, 2017 6:50 pm

Hi guys, need help with API/Python27
i follow: https://wiki.mikrotik.com/wiki/Manual:A ... d_examples

can someone show how to pass this terminal command true API:

/ip firewall filter
add action=drop chain=input dst-port=53 in-interface=ether1_WAN protocol=udp

i tried ( with many variations ):

apiros.runCommand("/ip/firewall/filter/add","=chain=input\n=action=drop\n=dst-port=53\n=in-interface=ether1_WAN\n=protocol=udp","")

Chupaka · Mon Nov 27, 2017 8:36 am

.runCommand? I can't find this on the page you linked to...

igorvukotic · Mon Nov 27, 2017 11:04 am

class APIError(Exception):
	def __init__(self, message, category = -1):
		self.message = message
		self.category = category
	def __str__(self):
		return repr(self.message)
		
class ApiRos:
	"""
	Routeros api
	"""
	def __init__(self, ip):
		sk = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
		sk.connect((ip, 8728))
		self.sk = sk
		self.currenttag = 0
	def login(self, username, pwd):
		for _, attrs in self.talk(["/login"]):
			chal = binascii.unhexlify(attrs['=ret'])
		md = md5.new()
		md.update('\x00')
		md.update(pwd)
		md.update(chal)
		self.talk(["/login", "=name=" + username,
			"=response=00" + binascii.hexlify(md.digest())])
	def talk(self, words):
		if self.writeSentence(words) == 0:
			return
		r = []
		while 1:
			i = self.readSentence();
			if len(i) == 0:
				continue
			reply = i[0]
			attrs = {}
			for w in i[1:]:
				j = w.find('=', 1)
				if (j == -1):
					attrs[w] = ''
				else:
					attrs[w[:j]] = w[j + 1:]
			r.append((reply, attrs))
			if reply == '!done':
				return r
	def writeSentence(self, words):
		ret = 0
		for w in words:
			self.writeWord(w)
			ret += 1
		self.writeWord('')
		return ret
	def readSentence(self):
		r = []
		while 1:
			w = self.readWord()
			if w == '':
				return r
			r.append(w)
	def writeWord(self, w):
		# print "<<< " + w
		self.writeLen(len(w))
		self.writeStr(w)
	def readWord(self):
		ret = self.readStr(self.readLen())
		# print ">>> " + ret
		return ret
	def writeLen(self, l):
		if l < 0x80:
			self.writeStr(chr(l))
		elif l < 0x4000:
			l |= 0x8000
			self.writeStr(chr((l >> 8) & 0xFF))
			self.writeStr(chr(l & 0xFF))
		elif l < 0x200000:
			l |= 0xC00000
			self.writeStr(chr((l >> 16) & 0xFF))
			self.writeStr(chr((l >> 8) & 0xFF))
			self.writeStr(chr(l & 0xFF))
		elif l < 0x10000000:
			l |= 0xE0000000
			self.writeStr(chr((l >> 24) & 0xFF))
			self.writeStr(chr((l >> 16) & 0xFF))
			self.writeStr(chr((l >> 8) & 0xFF))
			self.writeStr(chr(l & 0xFF))
		else:
			self.writeStr(chr(0xF0))
			self.writeStr(chr((l >> 24) & 0xFF))
			self.writeStr(chr((l >> 16) & 0xFF))
			self.writeStr(chr((l >> 8) & 0xFF))
			self.writeStr(chr(l & 0xFF))
	def readLen(self):
		c = ord(self.readStr(1))
		if (c & 0x80) == 0x00:
			pass
		elif (c & 0xC0) == 0x80:
			c &= ~0xC0
			c <<= 8
			c += ord(self.readStr(1))
		elif (c & 0xE0) == 0xC0:
			c &= ~0xE0
			c <<= 8
			c += ord(self.readStr(1))
			c <<= 8
			c += ord(self.readStr(1))
		elif (c & 0xF0) == 0xE0:
			c &= ~0xF0
			c <<= 8
			c += ord(self.readStr(1))
			c <<= 8
			c += ord(self.readStr(1))
			c <<= 8
			c += ord(self.readStr(1))
		elif (c & 0xF8) == 0xF0:
			c = ord(self.readStr(1))
			c <<= 8
			c += ord(self.readStr(1))
			c <<= 8
			c += ord(self.readStr(1))
			c <<= 8
			c += ord(self.readStr(1))
		return c
	def writeStr(self, str):
		n = 0;
		while n < len(str):
			r = self.sk.send(str[n:])
			if r == 0: raise RuntimeError, "connection closed by remote end"
			n += r
	def readStr(self, length):
		ret = ''
		while len(ret) < length:
			s = self.sk.recv(length - len(ret))
			if s == '': raise RuntimeError, "connection closed by remote end"
			ret += s
		return ret
	def getSocket(self):
		return self.sk
	def runCommand(self, command, cmd2, cmd3, **arguments):
		'''
		Run a command attempting to keep as close to the command line version,
		while maintaining an easy to use library.
		'''
		apiMessage = [command, cmd2, cmd3]
		if arguments != None:
			apiMessage += ["={0}={1}".format(k.replace('__', '-'), v) for k, v in arguments.items()]
		rez = self.talk(apiMessage)
		# print rez
		# Remove the !done at the end of the list.
		if rez[len(rez) - 1][0] == '!done':
			doneVal = rez.pop()
 		# Check for error conditions (Need to make this more efficient).
		trapVal = filter(lambda x: x[0] == '!trap', rez)
		if trapVal != []:
			trapVal = trapVal.pop()
			if 'category' in trapVal:
				category = trapVal[1]['=category']
			else:
				category = -1
			# print "TrapVal = {0}".format(trapVal[1])
			raise APIError(trapVal[1]['=message'], category)
		# Extract the data itself
		data = map(lambda x: x[1], rez)
		if data == []:
			if doneVal[1] != {}:
				data = doneVal[1]['=ret']
		return data

Chupaka · Mon Nov 27, 2017 12:31 pm

Try "dst__port=53\n=in__interface=ether1_WAN" (replace 'minus' sign with double underscore)

igorvukotic · Mon Nov 27, 2017 4:48 pm

no help..

Screen Shot 2017-11-27 at 15.46.31.jpg

Chupaka · Tue Nov 28, 2017 12:35 pm

I'm not familiar with Py, check this: viewtopic.php?p=392367

lniconet · Fri Jun 22, 2018 8:10 pm

Hello,

For those interested, my python module to use the API:

https://github.com/lnicolas83/routeros-api

SergeS · Fri Jul 13, 2018 12:50 am

Does anybody need Labview code for Mikrotik API support?
If yes - I could share it. I wrote it and was using already for few years with good results.
If nobody - I will not bother...

Pulido · Tue Aug 14, 2018 11:07 pm

I'm definitely interested in seeing this. Thanks.

BlackVS · Fri Mar 29, 2019 12:49 pm

One more Python API (still beta but functional) :
https://github.com/BlackVS/smartROS (some description in Russian)
Is developed for my own needs.
Main features:

TLS+ADH / TLS+certificates connection supported

routers' credentials stored in config file

human readable conditions (see below)

logging

test script "console" included

Conditions in commands:
in console:

/ip/firewall/address-list/print where="list==Blacklist and address==8.8.8.8"

or in Python ( style 1):

import smartROS
router = smartROS.getRouter("Main")
print( router.ip.firewall.address__list.print (where="list==Blacklist and address==8.8.8.8") )

or in Python ( style 2):

import smartROS
router = smartROS.getRouter("Main")
print( router.do("/ip/firewall/address-list/print", where="list==Blacklist and address==8.8.8.8") )

Madnessy · Wed May 15, 2019 9:50 pm

Not really api related , nor scripting related.

But is there an ansible playbook somewhere we can use to configure our devices ?
(Already started building my own cause i could'nt find one on the ansible galaxy nor on the forum)

nar6du14 · Thu May 23, 2019 11:20 pm

This a link to a python 3 asynchronous version of mikrotik api feel free to share it https://bitbucket.org/wambedu14/splynxp ... krotik_api

Madnessy · Wed May 29, 2019 11:01 am

made a first commit of the ansible role / playbook
https://github.com/Madnessy/ansible-mikrotik

feel free to use / test / share / suggest improvements etc

arielf · Fri Sep 06, 2019 1:09 pm

Hello, does anyone know or have any php, that helps me to add, delete, block, leasess of the dhcp-server mikrotik?

Longsdale · Fri Jan 03, 2020 7:31 pm

I have written a C++ API connector/wrapper: https://github.com/zx2512/MikrotikPlus
It would be nice if this gets added to these lists as there is no other good C++ connector available.

Chupaka · Sat Jan 04, 2020 1:54 pm

I have written a C++ API connector/wrapper: https://github.com/zx2512/MikrotikPlus

It supports only RouterOS versions 6.43 and later, right?

Longsdale · Sat Jan 04, 2020 4:01 pm

It supports only RouterOS versions 6.43 and later, right?

That is correct. I didn't want to bother with the outdated authentication method which is removed in the latest versions.

legrang · Sat Jan 04, 2020 6:43 pm

Supporting both is not difficult

Longsdale · Sat Jan 04, 2020 6:46 pm

Supporting both is not difficult

I didn't really want to spend additional time on it. Updating consumes less time.

vasilevkirill · Sat Apr 11, 2020 4:46 pm

hi,
this simple GUI for testing RouterOS API, based in web browser.
need running binary and open http://localhost:8081
source https://github.com/vasilevkirill/RouterOSAPIGUI
binary for all platforms https://github.com/vasilevkirill/Router ... I/releases

arsalansiddiqui · Mon Jul 27, 2020 4:49 pm

I want to get logs in pagination and dhcp lease in pagination what should i do to make output to a certain limit, example 1 to 10 or 67 to 87.
I'm using PHP api of Denis Basta

Chupaka · Fri Jul 31, 2020 11:16 am

You just get full list via API and then sort/paginate as you want.

arsalansiddiqui · Sat Aug 01, 2020 9:04 pm

If i fetch full page than what's use of pagination then, pagination helps to load only certain records thats what i want. i dont want to load all records its no use, i want to minimize the delay time faced during full fetched data

Mon Aug 03, 2020 10:01 am

API does not support such feature. You can only use queries to filter returned items by specific criteria, but no paging.

James56 · Sat Aug 29, 2020 11:56 am

Note: The PHP links in the top post don't work.

Chupaka · Mon Aug 31, 2020 4:02 pm

13:51, 3 January 2019 Normis (talk | contribs) deleted page RouterOS PHP class
13:51, 3 January 2019 Normis (talk | contribs) deleted page API PHP class

But some other API articles are still in Wiki... Normis?..

I'll update the first post with a link to https://github.com/BenMenking/routeros-api and will wait for the answer in viewtopic.php?p=814209#p814209 - the repo there is not available for me now.

alqadhi · Fri Oct 02, 2020 6:59 pm

How do I submit a library to be included in the Wiki?

Here is a library that I wrote a few months ago. It is written in C++17, and uses Boost.Asio (will be included in the C++23 standard).
https://github.com/aymanalqadhi/tikpp

alqadhi · Sat Oct 17, 2020 8:23 pm

API implementations in different programming languages from users of this forum:

in Perl - forum thread by cheesegrits
in Delphi - forum thread and wiki by rodolfo
in Delphi #2 - forum thread by Chupaka
in PHP - external by Denis Basta and contributors
Java sample methods - forum post
in Python - wiki link by Mikrotik staff
in C# - wiki link by wiki user Gregy
Ruby on rails wiki and discussion on forum(v1.9) - by astounding
in Adobe Flash - wiki by haakon
in C - wiki by webasdf
in C (GPL2 license) -wiki by octo
.NET (C#) discussion on forum - external by danikf
in NodeJS - by trakkasure

API related information links:
http://wiki.mikrotik.com/wiki/API
http://wiki.mikrotik.com/wiki/API_command_notes

Please update the post with the last library in the Wiki API page.

Chupaka · Sun Oct 18, 2020 10:58 pm

Added a link to the first post

Manfi99 · Fri Mar 19, 2021 12:07 pm

Does anybody need Labview code for Mikrotik API support?
If yes - I could share it. I wrote it and was using already for few years with good results.
If nobody - I will not bother...

Hello,

I am interested in your LabVIEW code. Could you share it to me, please?
Thank you very much.

jeppu31 · Sun Apr 25, 2021 10:29 am

Looking for Mikrotik api for Arduino using esp32, esp8266 please share it to me or email me jeffcastaneda31@ gmail. com

Thanks.. Godbless

Chupaka · Sat May 01, 2021 1:34 am

There are clients for C and C++ - just use them?..

Electrogics · Thu Aug 12, 2021 5:08 pm

Hi, where is the wiki for API C? it seems to be moved, I can't access, thank you!

Larsa · Wed May 04, 2022 6:22 pm

Anyone who knows a API framework that supports command concatenation or command substitution aka “[]” or "()" ? We've tried some frameworks for python, perl, php and javascript but found nada so far.

Could it be the implementations that is limited or even worse a restriction in the core API itself?

Chupaka · Tue May 10, 2022 4:02 pm

What exactly do you want to do by "command concatenation or substitution"?..

msatter · Sun May 22, 2022 2:18 pm

https://github.com/aluisiora NodeJS

wesllycode · Wed Aug 17, 2022 11:26 pm

Be able to use with laravel

https://github.com/EvilFreelancer/routeros-api-php

anav · Fri Aug 19, 2022 5:18 pm

Question from a non techie..... What is an API...
APIs let your product or service communicate with other products and services without having to know how they’re implemented.

Okay, so not much further ahead other than its some sort of, in my experience, ICD (interface control document which details the inputs and outputs of data and their formats at an interface so that two systems communicating can be programmed to accept and provide data in the agreed to formats).

This appears similar to API, so what are all the APIs being used for by folks here? Is it simply to program the MT routers from some other software?

rextended · Fri Aug 19, 2022 5:23 pm

Is just another protocol like HTTP...
No matter if IIS, Apache, nginx, etc., no matter if is etscape, opera, firefox, internet explorer...

saintmg · Sat Aug 20, 2022 3:19 pm

Hi, any API for PHP, JS or Python for hAP lite TC RB941-2nD-TC?

I wanted to create a hotspot management system so I can rent my Internet connection via WiFi. Thanks!

Sun Aug 21, 2022 11:54 am

Have you read https://wiki.mikrotik.com/wiki/Manual:API ? Is it so hard to find that page? If yes, what could be done do make searching forum better instead of search.php?keywords=api+links ? What's wrong with the topic itself viewtopic.php?t=29073 ?

atuxnull · Tue Aug 23, 2022 8:57 am

i have a few queues and i would like to create a shortcurt to my desktop PC (Win 10) so i could enable/disable a particular queue, without user interaction.
I have basic programming training, nothing special. So even a bat file would do the trick. Is there a way to do this please?

Chupaka · Sat Sep 17, 2022 2:47 pm

i have a few queues and i would like to create a shortcurt to my desktop PC (Win 10) so i could enable/disable a particular queue, without user interaction.
I have basic programming training, nothing special. So even a bat file would do the trick. Is there a way to do this please?

SSH. Simply setup SSH access with key (instead of password, so you don't need to type it) - and you can run any command from .bat by simply executing something like

ssh admin@router_IP "/queue simple disable queue1"

FIBRANETPLUS · Sat Jan 14, 2023 9:29 pm

Hello, I need enable disable L2TP-Server
Any idea?
$API->write("/ppp/l2tp/disable",true); not work!

rextended · Sat Jan 14, 2023 10:50 pm

i do not know if /ppp/l2tp/ exist, but the command on terminal are:
/interface l2tp-server server set enabled=no
/interface l2tp-server server set enabled=yes

FIBRANETPLUS · Sun Jan 15, 2023 6:12 pm

i do not know if /ppp/l2tp/ exist, but the command on terminal are:
/interface l2tp-server server set enabled=no
/interface l2tp-server server set enabled=yes

thanks

$API->write("/interface/l2tp-server/server/getall",true);

response

<<< [36] /interface/l2tp-server/server/getall >>> [3/3] bytes read. >>> [3, 304]!re >>> [13/13] bytes read. >>> [13, 290]=enabled=true >>> [13/13] bytes read. >>> [13, 276]=max-mtu=1450 >>> [13/13] bytes read. >>> [13, 262]=max-mru=1450 >>> [14/14] bytes read. >>> [14, 247]=mrru=disabled >>> [36/36] bytes read. >>> [36, 210]=authentication=chap,mschap1,mschap2 >>> [21/21] bytes read. >>> [21, 188]=keepalive-timeout=30 >>> [23/23] bytes read. >>> [23, 164]=max-sessions=unlimited >>> [35/35] bytes read. >>> [35, 128]=default-profile=default-encryption >>> [14/14] bytes read. >>> [14, 113]=use-ipsec=yes >>> [26/26] bytes read. >>> [26, 86]=ipsec-secret=xxxxxxxxxx >>> [26/26] bytes read. >>> [26, 59]=caller-id-type=ip-address >>> [27/27] bytes read. >>> [27, 31]=one-session-per-host=false >>> [22/22] bytes read. >>> [22, 8]=allow-fast-path=false >>> [5/5] bytes read. >>> [5, 1]!done OkDisconnected...

I try

Disable

$API->write("/interface/l2tp-server/server/set",false);
$API->write("=enabled=false",true);

Enable

$API->write("/interface/l2tp-server/server/set",false);
$API->write("=enabled=true",true);

Work Fine, thanks

rextended · Sun Jan 15, 2023 8:52 pm

Work Fine, thanks

Who is online