Administrator: Created page with "==Summary== Application Programmable Interface (API) allows users to create custom software solutions to communicate with RadioOS to gather information, adjust configuration..."

2015-12-10T10:16:45Z

Created page with "==Summary== Application Programmable Interface (API) allows users to create custom software solutions to communicate with RadioOS to gather information, adjust configuration..."

New page

==Summary==

Application Programmable Interface (API) allows users to create custom software solutions to communicate with RadioOS to gather information, adjust configuration and manage router. API closely follows syntax from command line interface (CLI). It can be used to create translated or custom configuration tools to aid ease of use running and managing routers with RadioOS.

To use API RadioOS version 3.x or newer is required.

By default API uses port #''8728'' and service is disabled. More on service management see in corresponding [[Manual:IP/Services | manual section]]. Corresponding service name is '''api'''

== Protocol ==

Communication with router is done by sending sentences to the router and receiving one or more sentences in return. Sentence is sequence of words terminated by zero length word. Word is part of sentence encoded in certain way - encoded length and data. Communication happen by sending sentences to the router and receiving replies to sent sentences. Each sentence sent to router using API should contain command as a first word followed by words in no particular order, end of sentence is marked by zero length word. When router receives full sentence (command word, no or more attribute words and zero length word) it is evaluated and executed, then reply is formed and returned.

===API words===

Words are part of sentence. Each word has to be encoded in certain way - length of the word followed by word content. Length of the word should be given as count of bytes that are going to be sent.

Length of the word is encoded as follows:

{| cellpadding="2"
!width="200px" style="background:#cccccc; border-bottom:1px solid gray;"| Value of length
!width="100px" style="background:#cccccc; border-bottom:1px solid gray;"|# of bytes
!width="250px" style="background:#cccccc; border-bottom:1px solid gray;"|Encoding
|-
|style="border-bottom:1px solid gray;" valign="top"| 0 <= len <= 0x7F
|style="border-bottom:1px solid gray;" valign="top"| 1
|style="border-bottom:1px solid gray;" valign="top"| len, lowest byte
|-
|style="border-bottom:1px solid gray;" valign="top"| 0x80 <= len <= 0x3FFF
|style="border-bottom:1px solid gray;" valign="top"| 2
|style="border-bottom:1px solid gray;" valign="top"| <nowiki>len | 0x8000, two lower bytes</nowiki>
|-
|style="border-bottom:1px solid gray;" valign="top"| 0x4000 <= len <= 0x1FFFFF
|style="border-bottom:1px solid gray;" valign="top"| 3
|style="border-bottom:1px solid gray;" valign="top"| <nowiki>len | 0xC00000, three lower bytes</nowiki>
|-
|style="border-bottom:1px solid gray;" valign="top"| 0x200000 <= len <= 0xFFFFFFF
|style="border-bottom:1px solid gray;" valign="top"| 4
|style="border-bottom:1px solid gray;" valign="top"| <nowiki>len | 0xE0000000</nowiki>
|-
|style="border-bottom:1px solid gray;" valign="top"| len >= 0x10000000
|style="border-bottom:1px solid gray;" valign="top"| 5
|style="border-bottom:1px solid gray;" valign="top"| 0xF0 and len as four bytes
|}

* Each word is encoded as length, followed by that many bytes of content;
* Words are grouped into sentences. End of sentence is terminated by zero length word;
* Scheme allows encoding of length up to '''0x7FFFFFFFFF''', only four byte length is supported;
* Bytes of '''len''' are sent most significant first (network order);
* If first byte of word is '''>= 0xF8''', then it is a reserved control byte. After receiving unknown control byte API client cannot proceed, because it cannot know how to interpret following bytes;
* Currently control bytes are not used;

In general ''words'' can be described like this <<''encoded word length''><''word content''>>. ''Word content'' can be separated in 5 parts: ''[[Manual:API#Command_word| command word]]'', ''[[Manual:API#Attribute_word |attribute word]]'', ''[[Manual:API#API_attribute_word|API attribute word]]''. ''[[Manual:API#Query_word|query word]]'' and ''[[Manual:API#Reply_word|reply word]]''

====Command word====
First word in sentence has to be command followed by attribute words and zero length word or terminating word. Name of command word should begin with '/'. Names of commands closely follow CLI, with spaces replaced with '/'. There are commands that are specific to API;

Command word structure in strict order:
* encoded length
* content prefix ''/''
* CLI converted command

API specific commands:
login
cancel

Command word concent examples:
/login

/user/active/listen

/interface/vlan/remove

/system/reboot

====Attribute word====
Each ''command word''have its own list of ''attribute words'' depending on content.

''Atribute word'' structure consists of 5 parts in this order:
* encoded length
* content prefix equals sigh - ''=''
* attribute name
* separating equals sign - ''=''
* value of attribute if there is one. It is possible that attribute does not have a value

{{Note|Value can hold multiple ''equal'' signs in the value of ''attribute word'' since the way word is encoded}}

{{Note| Value can be empty}}

Examples without encoded length prefix:
=address=10.0.0.1

=name=iu=c3Eeg

=disable-running-check=yes

{{Warning | Order of attribute words and API parameters is not important and should not be relied on}}

====API attribute word====

API attribute word structure is in strict order:
* encoded length
* content prefix with dot ''.''
*attribute name
*name postfixed with equals ''=''sign
*attribute value

Currently the only such API attribute is ''tag''.

{{Note| If sentence contain ''API attribute word '' tag then each returned sentence in reply from router to that tagged sentence will be tagged with same tag.}}

====Query word====
Senteces can have additional query paramteres that restrict their scope. They are explained in detail [[API#Queries|in separate section]].

Example of sentence using query word attributes:
/interface/print
?type=ether
?type=vlan
?#|!

* Query words begin with '?'.
* Currently only ''print'' command handles query words.

{{Warning| Order of query words is significant}}

====Reply word====

It is sent only by the router. It is only sent in response to full sentence send by the client.

* First word of reply begins with '!';
* Each sentence sent generates at least one reply (if connection does not get terminated);
* Last reply for every sentence is reply that has first word <tt>!done</tt>;
* Errors and exceptional conditions begin with <tt>!trap</tt>;
* Data replies begin with <tt>!re</tt>
* If API connection is closed, RadioOS sends <tt>!fatal</tt> with reason as reply and then closes the connection;

=== API sentences ===

API sentence is main object of communication using API.

* Empty sentences are ignored.
* Sentence is processed after receiving zero length word.
* There is a limit on number and size of sentences client can send before it has logged in.
* Order of attribute words should not be relied on. As order and count is changeable by ''.proplist'' attribute.
* Sentence structure is as follows:
** First word should contain ''command word'';
** Should contain ''zero length word'' to terminate the sentence;
** Can contain none or several ''attribute words''. There is no particular order at what attribute words has to be sent in the sentence, order is not important for ''attribute words'';
** Can contain none or several ''query words''. Order of ''query words'' in the sentence is important.

{{Note| ''Zero length word'' terminates the sentence. If it is not provided router will not start to evaluate sent words and will consider all the input as part of the same sentence.}}

== Initial login ==

<tt>
{| style="width: 500px"
{{apic|/login}}
{{apic|}}
{{apis|!done}}
{{apis|1==ret=ebddd18303a54111e2dea05a92ab46b4}}
{{apis|}}
{{apic|/login}}
{{apic|1==name=admin}}
{{apic|1==response=001ea726ed53ae38520c8334f82d44c9f2}}
{{apic|}}
{{apis|!done}}
{{apis|}}
|}
</tt>

{{Note| that each command and response ends with an empty word.}}

* First, clients sends <tt>/login</tt> command.
* Reply contains <tt>=ret=''challenge''</tt> argument.
* Client sends second <tt>/login</tt> command, with <tt>=name=''username''</tt> and <tt>=response=''response''</tt>.
* In case of error, reply contains <tt>=ret=''error message''</tt>.
* In case of successful login client can start to issue commands.

== Tags ==

* It is possible to run several commands simultaneously, without waiting for previous one to complete. If API client is doing this and needs to differentiate command responses, it can use 'tag' API parameter in command sentences.
* If you include 'tag' parameter with non-empty value in command sentence, then 'tag' parameter with exactly the same value will be included in all responses generated by this command.
* If you do not include 'tag' parameter or it's value is empty, then all responses for this command will not have 'tag' parameter.

== Command description ==

* <tt>/cancel</tt>
** optional argument: <tt>=tag=<i>tag of command to cancel</i></tt>, without it cancels all running commands
** does not cancel itself
** all canceled commands are interruped and in the usual case generate '!trap' and '!done' responses
** please note that <tt>/cancel</tt> is separate command and can have it's own unique '.tag' parameter, that is not related to '=tag' argument of this command

* <tt>listen</tt>
** <tt>listen</tt> command is avaliable where console print command is available, but it does not have expected effect everywhere (i.e. may not work)
** <tt>!re</tt> sentences are generated as something changes in particular item list
** when item is deleted or dissapears in any other way, the '!re' sentence includes value '=.dead=yes'
** This command does not terminate. To terminate it use <tt>/cancel</tt> command.

* <tt>getall</tt>
** <tt>getall</tt> command is available where console print command is available. Since version 3.21 <tt>getall</tt> is an alias for <tt>print</tt>.
** replies contain <tt>=.id=''Item internal number''</tt> property.

* <tt>print</tt>
** API <tt>print</tt> command differs from the console counterpart in the following ways:
*** <tt>where</tt> argument is not supported. Items can be filtered using query words (see below).
*** <tt>.proplist</tt> argument is a comma separated list of property names that should be included for the returned items.
**** returned items may have additional properties.
**** order of returned properties is not defined.
**** if list contains duplicate entries, handling of such entries is not defined.
**** if propery is present in <tt>.proplist</tt>, but absent from the item, then that item does not have this property value (?name will evaluate to false for that item).
**** if <tt>.proplist</tt> is absent, all properties are included as requested by print command, even those that have slow access time (such as file contents and perfomance counters). Thus use of <tt>.proplist</tt> is encouraged. Omission of <tt>.proplist</tt> may have high perfomance penalty if =detail= argument is set.

=== Queries ===

<tt>print</tt> command accepts query words that limit set of returned sentences. This feature is available since RadioOS 3.21.
* Query words begin with '?'.
* Order of query words is significant. Query is evaluated starting from the first word.
* Query is evaluated for each item in the list. If query succeeds, item is processed, if query fails, item is ignored.
* Query is evaluated using a stack of boolean values. Initially stack contains infinite amount of 'true' values. At the end of evaluation, if stack contains at least one 'false' value, query fails.
* Query words operate according to the following rules:
{| cellpadding="2"
!width="300px" style="background:#cccccc; border-bottom:1px solid gray;"| Query
!width="450px" style="background:#cccccc; border-bottom:1px solid gray;"| Desciption
|-
|style="border-bottom:1px solid gray;" valign="top"| '''?name'''
|style="border-bottom:1px solid gray;" valign="top"|pushes 'true' if item has value of property ''name'', 'false' if it does not.
|-
|style="border-bottom:1px solid gray;" valign="top"|'''?-name'''
|style="border-bottom:1px solid gray;" valign="top"| pushes 'true' if item does not have value of property ''name'', 'false' otherwise.
|-
|style="border-bottom:1px solid gray;" valign="top"|'''?''name''=''x'''''<br>'''?=''name''=''x'''''
|style="border-bottom:1px solid gray;" valign="top"| pushes 'true' if property ''name'' has value equal to ''x'', 'false' otherwise.
|-
|style="border-bottom:1px solid gray;" valign="top"|'''?<name=''x'''''
|style="border-bottom:1px solid gray;" valign="top"| pushes 'true' if property ''name'' has value less than ''x'', 'false' otherwise.
|-
|style="border-bottom:1px solid gray;" valign="top"|'''?>name=''x'''''
|style="border-bottom:1px solid gray;" valign="top"| pushes 'true' if property ''name'' has value greater than ''x'', 'false' otherwise.
|-
|style="border-bottom:1px solid gray;" valign="top"|'''?#''operations'''''
|style="border-bottom:1px solid gray;" valign="top"| applies operations to the values in the stack.
* operation string is evaluated left to right.
* sequence of decimal digits followed by any other character or end of word is interpreted as a stack index. top value has index 0.
* index that is followed by a character pushes copy of value at that index.
* index that is followed by the end of word replaces all values with the value at that index.
* '''<tt>!</tt> ''' character replaces top value with the opposite.
* '''<tt>&</tt>''' pops two values and pushes result of logical 'and' operation.
* '''<tt>|</tt>''' pops two values and pushes result of logical 'or' operation.
* '''<tt>.</tt>''' after an index does nothing.
* '''<tt>.</tt>''' after another character pushes copy of top value.
|}

Examples:
* Get all ethernet and VLAN interfaces:
/interface/print
?type=ether
?type=vlan
?#|
* Get all routes that have non-empty comment:
/ip/route/print
?>comment=

* [http://forum.CableFree.com/viewtopic.php?f=2&t=72298 Forum thread with detailed explanation of use of queries]

=== OID ===

<tt>print</tt> command can return OID values for properties that are available in SNMP. This feature appeared in 3.23 version.

In console, OID values can be seen by running 'print oid' command. In API, these properties have name that ends with ".oid", and can be retrieved by adding their name to the value of '.proplist'. An example:

<tt>
{| style="width: 500px"
{{apic|/system/resource/print}}
{{apic|1==.proplist=uptime,cpu-load,uptime.oid,cpu-load.oid}}
{{apic|}}
{{apis|!re}}
{{apis|1==uptime=01:22:53}}
{{apis|1==cpu-load=0}}
{{apis|1==uptime.oid=.1.3.6.1.2.1.1.3.0}}
{{apis|1==cpu-load.oid=.1.3.6.1.2.1.25.3.3.1.2.1}}
{{apis|}}
{{apis|!done}}
{{apis|}}
|}
</tt>
===!trap===
When for some reason API sentence fails trap is sent in return accompanied with '''message''' attribute and on some occasions '''category''' argument.

====message====
When API sentence fails some generic message or message from used internal process is return to give more details about failure

<<< /ip/address/add
<<< =address=192.168.88.1
<<< =interface=asdf
<<<
>>> !trap
>>> =category=1
>>> =message=input does not match any value of interface

====category====
if it is a general error, it is categorized and error category is returned. possible values for this attribute are
*0 - missing item or command
*1 - argument value failure
*2 - execution of command interrupted
*3 - scripting related failure
*4 - general failure
*5 - API related failure
*6 - TTY related failure
*7 - value generated with :return command

== Command examples ==

=== <tt>/system/package/getall</tt> ===

{{bapi}}
{{apic|/system/package/getall}}
{{apic|}}
{{apis|!re}}
{{apis|1==.id=*5802}}
{{apis|1==disabled=no}}
{{apis|1==name=RadioOS-x86}}
{{apis|1==version=3.0beta2}}
{{apis|1==build-time=oct/18/2006 16:24:41}}
{{apis|1==scheduled=}}
{{apis|}}
{{apis|!re}}
{{apis|1==.id=*5805}}
{{apis|1==disabled=no}}
{{apis|1==name=system}}
{{apis|1==version=3.0beta2}}
{{apis|1==build-time=oct/18/2006 17:20:46}}
{{apis|1==scheduled=}}
{{apis|}}
|-
| ... more !re sentences ...
|-
{{apis|!re}}
{{apis|1==.id=*5902}}
{{apis|1==disabled=no}}
{{apis|1==name=advanced-tools}}
{{apis|1==version=3.0beta2}}
{{apis|1==build-time=oct/18/2006 17:20:49}}
{{apis|1==scheduled=}}
{{apis|}}
{{apis|!done}}
{{apis|}}
{{eapi}}

=== <tt>/user/active/listen</tt> ===

{{bapi}}
{{apic|/user/active/listen}}
{{apic|}}
{{apis|!re}}
{{apis|1==.id=*68}}
{{apis|1==radius=no}}
{{apis|1==when=oct/24/2006 08:40:42}}
{{apis|1==name=admin}}
{{apis|1==address=0.0.0.0}}
{{apis|1==via=console}}
{{apis|}}
{{apis|!re}}
{{apis|1==.id=*68}}
{{apis|1==.dead=yes}}
{{apis|}}
|-
| ... more !re sentences ...
|-
{{eapi}}

=== <tt>/cancel</tt>, simultaneous commands ===

{{bapi}}
{{apic|/login}}
{{apic|}}
{{apis|!done}}
{{apis|1==ret=856780b7411eefd3abadee2058c149a3}}
{{apis|}}
{{apic|/login}}
{{apic|1==name=admin}}
{{apic|1==response=005062f7a5ef124d34675bf3e81f56c556}}
{{apic|}}
{{apis|!done}}
{{apis|}}
{{apih|first start listening for interface changes (tag is 2)}}
{{apic|/interface/listen}}
{{apic|1=.tag=2}}
{{apic|}}
{{apih|disable interface (tag is 3)}}
{{apic|/interface/set}}
{{apic|1==disabled=yes}}
{{apic|1==.id=ether1}}
{{apic|1=.tag=3}}
{{apic|}}
{{apih|this is done for disable command (tag 3)}}
{{apis|!done}}
{{apis|1=.tag=3}}
{{apis|}}
{{apih|enable interface (tag is 4)}}
{{apic|/interface/set}}
{{apic|1==disabled=no}}
{{apic|1==.id=ether1}}
{{apic|1=.tag=4}}
{{apic|}}
{{apih|this update is generated by change made by first set command (tag 3)}}
{{apis|!re}}
{{apis|1==.id=*1}}
{{apis|1==disabled=yes}}
{{apis|1==dynamic=no}}
{{apis|1==running=no}}
{{apis|1==name=ether1}}
{{apis|1==mtu=1500}}
{{apis|1==type=ether}}
{{apis|1=.tag=2}}
{{apis|}}
{{apih|this is done for enable command (tag 4)}}
{{apis|!done}}
{{apis|1=.tag=4}}
{{apis|}}
{{apih|get interface list (tag is 5)}}
{{apic|/interface/getall}}
{{apic|1=.tag=5}}
{{apic|}}
{{apih|this update is generated by change made by second set command (tag 4)}}
{{apis|!re}}
{{apis|1==.id=*1}}
{{apis|1==disabled=no}}
{{apis|1==dynamic=no}}
{{apis|1==running=yes}}
{{apis|1==name=ether1}}
{{apis|1==mtu=1500}}
{{apis|1==type=ether}}
{{apis|1=.tag=2}}
{{apis|}}
{{apih|these are replies to getall command (tag 5)}}
{{apis|!re}}
{{apis|1==.id=*1}}
{{apis|1==disabled=no}}
{{apis|1==dynamic=no}}
{{apis|1==running=yes}}
{{apis|1==name=ether1}}
{{apis|1==mtu=1500}}
{{apis|1==type=ether}}
{{apis|1=.tag=5}}
{{apis|}}
{{apis|!re}}
{{apis|1==.id=*2}}
{{apis|1==disabled=no}}
{{apis|1==dynamic=no}}
{{apis|1==running=yes}}
{{apis|1==name=ether2}}
{{apis|1==mtu=1500}}
{{apis|1==type=ether}}
{{apis|1=.tag=5}}
{{apis|}}
{{apih|here interface getall ends (tag 5)}}
{{apis|!done}}
{{apis|1=.tag=5}}
{{apis|}}
{{apih|stop listening - request to cancel command with tag 2, cancel itself uses tag 7}}
{{apic|/cancel}}
{{apic|1==tag=2}}
{{apic|1=.tag=7}}
{{apic|}}
{{apih|listen command is interrupted (tag 2)}}
{{apis|!trap}}
{{apis|1==category=2}}
{{apis|1==message=interrupted}}
{{apis|1=.tag=2}}
{{apis|}}
{{apih|cancel command is finished (tag 7)}}
{{apis|!done}}
{{apis|1=.tag=7}}
{{apis|}}
{{apih|listen command is finished (tag 2)}}
{{apis|!done}}
{{apis|1=.tag=2}}
{{apis|}}
{{eapi}}

== Example client ==

* this is simple API client in Python2
* example for [[Manual:API_Python3|Python3]]
* usage: api.py ''ip-address'' ''username'' ''password''
* after that type words from keyboard, terminating them with newline
* Since empty word terminates sentence, you should press enter '''twice''' after last word before sentence will be sent to router.
<pre>

#!/usr/bin/python

import sys, posix, time, md5, binascii, socket, select

class ApiRos:
"RadioOS api"
def __init__(self, sk):
self.sk = sk
self.currenttag = 0

def login(self, username, pwd):
for repl, 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 main():
s = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
s.connect((sys.argv[1], 8728))
apiros = ApiRos(s);
apiros.login(sys.argv[2], sys.argv[3]);

inputsentence = []

while 1:
r = select.select([s, sys.stdin], [], [], None)
if s in r[0]:
# something to read in socket, read sentence
x = apiros.readSentence()

if sys.stdin in r[0]:
# read line from input and strip off newline
l = sys.stdin.readline()
l = l[:-1]

# if empty line, send sentence and start with new
# otherwise append to input sentence
if l == '':
apiros.writeSentence(inputsentence)
inputsentence = []
else:
inputsentence.append(l)

if __name__ == '__main__':
main()
</pre>

Example run:

<pre>
debian@localhost:~/api-test$ ./api.py 10.0.0.1 admin ''
<<< /login
<<<
>>> !done
>>> =ret=93b438ec9b80057c06dd9fe67d56aa9a
>>>
<<< /login
<<< =name=admin
<<< =response=00e134102a9d330dd7b1849fedfea3cb57
<<<
>>> !done
>>>
/user/getall

<<< /user/getall
<<<
>>> !re
>>> =.id=*1
>>> =disabled=no
>>> =name=admin
>>> =group=full
>>> =address=0.0.0.0/0
>>> =netmask=0.0.0.0
>>>
>>> !done
>>>

</pre>

== See also ==
*[[API command notes]]
*[http://forum.CableFree.com/viewtopic.php?f=2&t=72298| Forum topic explaining query in detail]
==== API examples ====

API implementations in different languages, provided by different sources. They are not ordered in any particular order.

=====in the Wiki =====

*[[API_PHP_package|in PHP]] #1 (recommended)
*[[API_PHP_class|in PHP]] #2
*[[RadioOS_PHP_class|in PHP]] #3
*[[API Delphi|in Delphi]] #1
*[[API_Delphi_Client|in Delphi]] #2

*[[API_in_C| in C]] #1
*[[LibRadioOS| in C]] #2
*[[API_in_C_using_winsock | in C using winsock]]
*[[API_In_CPP|API in C++]]
*[[API_in_C_Sharp|in C#]]

*[[API_ActionScript_3_class|in Flash Actionscript 3]]
*[[API_Ruby_class|in Ruby on rails]]
*[[API_in_VB_dot_NET|in VB .NET]]
*[[API_in_Java|in java]] see java client on github from Gideon LeGrange
*[[MikroNode|in NodeJS]]
*[[Manual:API_Python3|Python3]]
*[[API_rust| in RUST]] GPL v3

===== on the CableFree Forum =====

* [http://forum.CableFree.com/viewtopic.php?f=9&t=22744 in Perl] by Hugh
* [http://forum.CableFree.com/viewtopic.php?f=9&t=28821 in Delphi] by Rodolfo
* [http://forum.CableFree.com/viewtopic.php?f=9&t=31555 in Delphi #2] by Chupaka
* [http://forum.CableFree.com/viewtopic.php?f=9&t=51861 in NodeJS] by Trakkasure
* [http://forum.CableFree.com/viewtopic.php?f=2&t=51584 in VB] by lucho512
* [http://forum.CableFree.com/viewtopic.php?f=9&t=56869 on PHP for sparks framework] by vthinkteam

===== External sources =====

*[https://github.com/danikf/tik4net in .NET (C#) high-level api solution] [http://forum.CableFree.com/viewtopic.php?f=9&t=99954 forum thread] [https://github.com/danikf/tik4net/wiki additional info] by danikf
*[https://sourceforge.net/projects/netRadioOS/ in PHP] by boen_robot
*[https://github.com/haakonnessjoen/libRadioOS-api in C] by Håkon Nessjøen
*[https://github.com/GideonLeGrange/CableFree-java in Java] by Gideon LeGrange
*[https://github.com/comtihon/erotik in Erlang] by Valery Comtihon

[[Category:API|A]]
[[Category:Manual|A]]
[[Category:System|A]]
[[Category:Case Studies|A]]

Manual:API - Revision history

Administrator: /* Queries */

Administrator: /* External sources */

Administrator: /* on the CableFree Forum */

Administrator: /* See also */

Administrator: Created page with "==Summary== Application Programmable Interface (API) allows users to create custom software solutions to communicate with RadioOS to gather information, adjust configuration..."

← Older revision		Revision as of 13:14, 10 December 2015
Line 263:		Line 263:
	/ip/route/print		/ip/route/print
	?>comment=		?>comment=

	* [http://forum.CableFree.com/viewtopic.php?f=2&t=72298 Forum thread with detailed explanation of use of queries]

	=== OID ===		=== OID ===

← Older revision		Revision as of 10:22, 10 December 2015
Line 719:		Line 719:
	===== External sources =====		===== External sources =====

	*[https://github.com/danikf/tik4net in .NET (C#) high-level api solution] ~~[http://forum.CableFree.com/viewtopic.php?f=9&t=99954 forum thread]~~ [https://github.com/danikf/tik4net/wiki additional info] by danikf		*[https://github.com/danikf/tik4net in .NET (C#) high-level api solution]
	*[https://sourceforge.net/projects/netRadioOS/ in PHP] by boen_robot		*[https://github.com/danikf/tik4net/wiki additional info] by danikf
	*[https://github.com/haakonnessjoen/libRadioOS-api in C] by Håkon Nessjøen
	*[https://github.com/GideonLeGrange/CableFree-java in Java] by Gideon LeGrange
	*[https://github.com/comtihon/erotik in Erlang] by Valery Comtihon		*[https://github.com/comtihon/erotik in Erlang] by Valery Comtihon

← Older revision		Revision as of 10:20, 10 December 2015
Line 716:		Line 716:
	*[[Manual:API_Python3\|Python3]]		*[[Manual:API_Python3\|Python3]]
	*[[API_rust\| in RUST]] GPL v3		*[[API_rust\| in RUST]] GPL v3

	~~===== on the CableFree Forum =====~~

	* [http://forum.CableFree.com/viewtopic.php?f=9&t=22744 in Perl] by Hugh
	* [http://forum.CableFree.com/viewtopic.php?f=9&t=28821 in Delphi] by Rodolfo
	* [http://forum.CableFree.com/viewtopic.php?f=9&t=31555 in Delphi #2] by Chupaka
	* [http://forum.CableFree.com/viewtopic.php?f=9&t=51861 in NodeJS] by Trakkasure
	* [http://forum.CableFree.com/viewtopic.php?f=2&t=51584 in VB] by lucho512
	* [http://forum.CableFree.com/viewtopic.php?f=9&t=56869 on PHP for sparks framework] by vthinkteam

	===== External sources =====		===== External sources =====

← Older revision		Revision as of 10:20, 10 December 2015
Line 691:		Line 691:
	== See also ==		== See also ==
	*[[API command notes]]		*[[API command notes]]
	*[http://forum.CableFree.com/viewtopic.php?f=2&t=72298\| Forum topic explaining query in detail]
	==== API examples ====		==== API examples ====