Audiovox P965 Datasheet download pdf (Page 179)

API command notes

176

API command notes

Summary

This page contains some information about details of API commands, examples or use-cases. For more detailed

information refer to API.

Note: Till version 4.6 including API logins where shown as winbox logins. Since 4.7 this behaviour is

changed and API logins will be correctly recognised and displayed as API logins.

General information about API sentences

Communication with router through API is done using API sentences that consist of API

command and attributes. API queries are considered special command attribute, for example command tags. In

each sentence can only be one command and 'many attributes.

Command

API command is command as it is available from CLI (or special API command like 'getall'). Command syntax is

derived from CLI and includes CLI path to and command itself.

For example:

/ip address print

API command derived from this CLI command will be:

/ip/address/print

in this case, /ip/address/ is path and print is command itself, but, since print or command on its own does not have

meaning, path+command is considered to be command as that determines what to do exactly.

Attributes

CLI Attributes

Each API sentence can have attributes. Full attribute list can be acquired from CLI using ? or double Tab key.

Example:

First, what command we are going to use? In CLI we will examine /ip address add command.

What attributes command has? result of ?

[admin@MikroTik] > ip address add

Creates new item with specified property values.

address -- Local IP address

broadcast -- Broadcast address

comment -- Short description of the item

copy-from -- Item number

disabled -- Defines whether item is ignored or used

interface -- Interface name

netmask -- Network mask

network -- Network prefix

1 2 ... 174 175 176 177 178 179 180 181 182 183 184 ... 279 280

No comments

Audiovox P965 Datasheet Page 179