System information

Manual:API
159
=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 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 !done;
• Errors and exceptional conditions begin with !trap;
• Data replies begin with !re
• If API connection is closed, RouterOS sends !fatal with reason as reply and then closes the connection;