RouterOS REST Schema (v7.12beta3.28240783-all) version v7.12beta3.28240783-all

https://{host}:{port}/rest

host: required(string - default: 192.168.88.1)
RouterOS device IP or host name
port: required(string - default: 443)
RouterOS https port to use

RouterOS RAML Schema for REST API

Schema is generated using /console/inspect from a RouterOS device, and interpreted into a schema based on the rules in Mikrotik REST documentation

/beep

/blink

/certificate

/certificate get put

get

put

/certificate/add post

post

/certificate/add-scep post

post

/certificate/create-certificate-request post

post

/certificate/crl get put

get

put

/certificate/crl/{id} get delete patch

get

delete

patch

/certificate/crl/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/certificate/enable-ssl-certificate post

post

/certificate/{id} get delete patch

get

delete

patch

/certificate/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

active: (any)
append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
inactive: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/certificate/reset post

post

/certificate/scep-server get put

get

put

/certificate/scep-server/{id} get delete patch

get

delete

patch

/certificate/scep-server/otp/{id} get delete

get

delete

/certificate/scep-server/otp/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/certificate/scep-server/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/certificate/scep-server/ra get put

get

put

/certificate/scep-server/ra/add post

post

/certificate/scep-server/ra/{id} get delete patch

get

delete

patch

/certificate/scep-server/ra/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/certificate/scep-server/ra/reset post

post

/certificate/scep-server/ra/set post

post

/certificate/scep-server/requests/{id} get delete

get

delete

/certificate/scep-server/requests/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/certificate/set post

post

/certificate/settings/{id} get patch

get

patch

/certificate/sign post

post

/console

/container

/container get put

get

put

/container/add post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

cmd: (any)
comment: (any)
copy-from: (any)
dns: (any)
domain-name: (any)
entrypoint: (any)
envlist: (any)
file: (any)
hostname: (any)
interface: (any)
logging: (any)
mounts: (any)
remote-image: (any)
root-dir: (any)
start-on-boot: (any)
stop-signal: (any)
user: (any)
workdir: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/container/config/{id} get patch

get

patch

/container/envs get put

get

put

/container/envs/{id} get delete patch

get

delete

patch

/container/envs/print post

post

/container/{id} get delete patch

get

delete

patch

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

URI Parameters

id: required(string)

Body

Media type: application/json

Type: object

Properties

cmd: (any)
comment: (any)
dns: (any)
domain-name: (any)
entrypoint: (any)
envlist: (any)
file: (any)
hostname: (any)
interface: (any)
logging: (any)
mounts: (any)
numbers: (any)
remote-image: (any)
root-dir: (any)
start-on-boot: (any)
stop-signal: (any)
user: (any)
workdir: (any)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/container/mounts get put

get

put

/container/mounts/{id} get delete patch

get

delete

patch

/container/mounts/print post

post

/container/print post

post

/container/reset post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

cmd: (any)
comment: (any)
dns: (any)
domain-name: (any)
entrypoint: (any)
envlist: (any)
file: (any)
hostname: (any)
interface: (any)
logging: (any)
mounts: (any)
numbers: (any)
remote-image: (any)
root-dir: (any)
start-on-boot: (any)
stop-signal: (any)
user: (any)
workdir: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/container/set post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

cmd: (any)
comment: (any)
dns: (any)
domain-name: (any)
entrypoint: (any)
envlist: (any)
file: (any)
hostname: (any)
interface: (any)
logging: (any)
mounts: (any)
numbers: (any)
remote-image: (any)
root-dir: (any)
start-on-boot: (any)
stop-signal: (any)
user: (any)
workdir: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/convert

/delay

/disk

/disk/copy post

post

/disk/format-drive post

post

/disk/{id} get delete

get

delete

/disk/monitor-traffic post

post

/disk/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
oid: (any)
proplist: (any)
show-ids: (any)
stats: (any)
stats-detail: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/disk/smb-share get put

get

put

/disk/smb-share/add post

post

/disk/smb-share/{id} get delete patch

get

delete

patch

/disk/smb-share/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/disk/smb-share/reset post

post

/disk/smb-share/set post

post

/disk/smb-user get put

get

put

/disk/smb-user/{id} get delete patch

get

delete

patch

/disk/smb-user/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/do

/dude

/dude/agent get put

get

put

/dude/agent/{id} get delete patch

get

delete

patch

/dude/agent/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/dude/device get put

get

put

/dude/device/{id} get delete patch

get

delete

patch

/dude/device/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/dude/device-type get put

get

put

/dude/device-type/{id} get delete patch

get

delete

patch

/dude/device-type/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/dude/export-db post

post

/dude/{id} get patch

get

patch

/dude/import-db post

post

/dude/notification get put

get

put

/dude/notification/{id} get delete patch

get

delete

patch

/dude/notification/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/dude/probe get put

get

put

/dude/probe/{id} get delete patch

get

delete

patch

/dude/probe/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/dude/ros/address get put

get

put

/dude/ros/address/add post

post

/dude/ros/address/{id} get delete patch

get

delete

patch

/dude/ros/address/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/dude/ros/address/reset post

post

/dude/ros/address/set post

post

/dude/ros/arp get put

get

put

/dude/ros/arp/{id} get delete patch

get

delete

patch

/dude/ros/arp/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/dude/ros/arp/reset post

post

/dude/ros/health/{id} get patch

get

patch

/dude/ros/health/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/dude/ros/health/reset post

post

/dude/ros/health/set post

post

/dude/ros/interface/{id} get patch

get

patch

/dude/ros/interface/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
stats: (any)
stats-detail: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/dude/ros/lease get put

get

put

/dude/ros/lease/add post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

address: (any)
address-lists: (any)
always-broadcast: (any)
block-access: (any)
client-id: (any)
comment: (any)
copy-from: (any)
device: (any)
dhcp-option: (any)
dhcp-option-set: (any)
disabled: (any)
insert-queue-before: (any)
lease-time: (any)
mac-address: (any)
rate-limit: (any)
server: (any)
use-src-mac: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/dude/ros/lease/{id} get delete patch

get

delete

patch

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

URI Parameters

id: required(string)

Body

Media type: application/json

Type: object

Properties

address: (any)
address-lists: (any)
always-broadcast: (any)
block-access: (any)
client-id: (any)
comment: (any)
device: (any)
dhcp-option: (any)
dhcp-option-set: (any)
disabled: (any)
insert-queue-before: (any)
lease-time: (any)
mac-address: (any)
numbers: (any)
rate-limit: (any)
server: (any)
use-src-mac: (any)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/dude/ros/lease/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

active: (any)
append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/dude/ros/lease/reset post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

address: (any)
address-lists: (any)
always-broadcast: (any)
block-access: (any)
client-id: (any)
comment: (any)
device: (any)
dhcp-option: (any)
dhcp-option-set: (any)
disabled: (any)
insert-queue-before: (any)
lease-time: (any)
mac-address: (any)
numbers: (any)
rate-limit: (any)
server: (any)
use-src-mac: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/dude/ros/lease/set post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

address: (any)
address-lists: (any)
always-broadcast: (any)
block-access: (any)
client-id: (any)
comment: (any)
device: (any)
dhcp-option: (any)
dhcp-option-set: (any)
disabled: (any)
insert-queue-before: (any)
lease-time: (any)
mac-address: (any)
numbers: (any)
rate-limit: (any)
server: (any)
use-src-mac: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/dude/ros/neighbor/{id} get patch

get

patch

/dude/ros/neighbor/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
oid: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/dude/ros/queue get put

get

put

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

bucket-size: (any)
burst-limit: (any)
burst-threshold: (any)
burst-time: (any)
comment: (any)
copy-from: (any)
device: (any)
disabled: (any)
dst: (any)
limit-at: (any)
max-limit: (any)
name: (any)
packet-marks: (any)
parent: (any)
priority: (any)
queue: (any)
target: (any)
time: (any)
total-bucket-size: (any)
total-burst-limit: (any)
total-burst-threshold: (any)
total-burst-time: (any)
total-limit-at: (any)
total-max-limit: (any)
total-priority: (any)
total-queue: (any)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/dude/ros/queue/add post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

bucket-size: (any)
burst-limit: (any)
burst-threshold: (any)
burst-time: (any)
comment: (any)
copy-from: (any)
device: (any)
disabled: (any)
dst: (any)
limit-at: (any)
max-limit: (any)
name: (any)
packet-marks: (any)
parent: (any)
priority: (any)
queue: (any)
target: (any)
time: (any)
total-bucket-size: (any)
total-burst-limit: (any)
total-burst-threshold: (any)
total-burst-time: (any)
total-limit-at: (any)
total-max-limit: (any)
total-priority: (any)
total-queue: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/dude/ros/queue/{id} get delete patch

get

delete

patch

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

URI Parameters

id: required(string)

Body

Media type: application/json

Type: object

Properties

bucket-size: (any)
burst-limit: (any)
burst-threshold: (any)
burst-time: (any)
comment: (any)
device: (any)
disabled: (any)
dst: (any)
limit-at: (any)
max-limit: (any)
name: (any)
numbers: (any)
packet-marks: (any)
parent: (any)
priority: (any)
queue: (any)
target: (any)
time: (any)
total-bucket-size: (any)
total-burst-limit: (any)
total-burst-threshold: (any)
total-burst-time: (any)
total-limit-at: (any)
total-max-limit: (any)
total-priority: (any)
total-queue: (any)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/dude/ros/queue/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
bytes: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
packets: (any)
proplist: (any)
rate: (any)
show-ids: (any)
stats: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/dude/ros/queue/reset post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

bucket-size: (any)
burst-limit: (any)
burst-threshold: (any)
burst-time: (any)
comment: (any)
device: (any)
disabled: (any)
dst: (any)
limit-at: (any)
max-limit: (any)
name: (any)
numbers: (any)
packet-marks: (any)
parent: (any)
priority: (any)
queue: (any)
target: (any)
time: (any)
total-bucket-size: (any)
total-burst-limit: (any)
total-burst-threshold: (any)
total-burst-time: (any)
total-limit-at: (any)
total-max-limit: (any)
total-priority: (any)
total-queue: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/dude/ros/queue/set post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

bucket-size: (any)
burst-limit: (any)
burst-threshold: (any)
burst-time: (any)
comment: (any)
device: (any)
disabled: (any)
dst: (any)
limit-at: (any)
max-limit: (any)
name: (any)
numbers: (any)
packet-marks: (any)
parent: (any)
priority: (any)
queue: (any)
target: (any)
time: (any)
total-bucket-size: (any)
total-burst-limit: (any)
total-burst-threshold: (any)
total-burst-time: (any)
total-limit-at: (any)
total-max-limit: (any)
total-priority: (any)
total-queue: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/dude/ros/registration-table/{id} get delete

get

delete

/dude/ros/registration-table/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
stats: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/dude/ros/resource/{id} get patch

get

patch

/dude/ros/resource/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/dude/ros/route/{id} get delete

get

delete

/dude/ros/route/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/dude/ros/routerboard/{id} get patch

get

patch

/dude/ros/routerboard/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/dude/service get put

get

put

/dude/service/{id} get delete patch

get

delete

patch

/dude/service/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/environment

/error

/execute

/file

/file get put

get

put

/file/{id} get delete patch

get

delete

patch

/file/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/file/sync get put

get

put

/file/sync/add post

post

/file/sync/{id} get delete patch

get

delete

patch

/file/sync/monitor post

post

/file/sync/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/file/sync/reset post

post

/file/sync/set post

post

/find

/for

/foreach

/global

/if

/import

/interface

/interface/6to4 get put

get

put

/interface/6to4/add post

post

/interface/6to4/{id} get delete patch

get

delete

patch

/interface/6to4/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/6to4/reset post

post

/interface/6to4/set post

post

/interface/bonding get put

get

put

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

arp: (any)
arp-interval: (any)
arp-ip-targets: (any)
arp-timeout: (any)
comment: (any)
copy-from: (any)
disabled: (any)
down-delay: (any)
forced-mac-address: (any)
lacp-rate: (any)
lacp-user-key: (any)
link-monitoring: (any)
mii-interval: (any)
min-links: (any)
mlag-id: (any)
mode: (any)
mtu: (any)
name: (any)
primary: (any)
slaves: (any)
transmit-hash-policy: (any)
up-delay: (any)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/bonding/add post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

arp: (any)
arp-interval: (any)
arp-ip-targets: (any)
arp-timeout: (any)
comment: (any)
copy-from: (any)
disabled: (any)
down-delay: (any)
forced-mac-address: (any)
lacp-rate: (any)
lacp-user-key: (any)
link-monitoring: (any)
mii-interval: (any)
min-links: (any)
mlag-id: (any)
mode: (any)
mtu: (any)
name: (any)
primary: (any)
slaves: (any)
transmit-hash-policy: (any)
up-delay: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/bonding/{id} get delete patch

get

delete

patch

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

URI Parameters

id: required(string)

Body

Media type: application/json

Type: object

Properties

arp: (any)
arp-interval: (any)
arp-ip-targets: (any)
arp-timeout: (any)
comment: (any)
disabled: (any)
down-delay: (any)
forced-mac-address: (any)
lacp-rate: (any)
lacp-user-key: (any)
link-monitoring: (any)
mii-interval: (any)
min-links: (any)
mlag-id: (any)
mode: (any)
mtu: (any)
name: (any)
numbers: (any)
primary: (any)
slaves: (any)
transmit-hash-policy: (any)
up-delay: (any)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/bonding/monitor post

post

/interface/bonding/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/bonding/reset post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

arp: (any)
arp-interval: (any)
arp-ip-targets: (any)
arp-timeout: (any)
comment: (any)
disabled: (any)
down-delay: (any)
forced-mac-address: (any)
lacp-rate: (any)
lacp-user-key: (any)
link-monitoring: (any)
mii-interval: (any)
min-links: (any)
mlag-id: (any)
mode: (any)
mtu: (any)
name: (any)
numbers: (any)
primary: (any)
slaves: (any)
transmit-hash-policy: (any)
up-delay: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/bonding/set post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

arp: (any)
arp-interval: (any)
arp-ip-targets: (any)
arp-timeout: (any)
comment: (any)
disabled: (any)
down-delay: (any)
forced-mac-address: (any)
lacp-rate: (any)
lacp-user-key: (any)
link-monitoring: (any)
mii-interval: (any)
min-links: (any)
mlag-id: (any)
mode: (any)
mtu: (any)
name: (any)
numbers: (any)
primary: (any)
slaves: (any)
transmit-hash-policy: (any)
up-delay: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/bridge get put

get

put

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

add-dhcp-option82: (any)
admin-mac: (any)
ageing-time: (any)
arp: (any)
arp-timeout: (any)
auto-mac: (any)
comment: (any)
copy-from: (any)
dhcp-snooping: (any)
disabled: (any)
ether-type: (any)
fast-forward: (any)
forward-delay: (any)
frame-types: (any)
igmp-snooping: (any)
igmp-version: (any)
ingress-filtering: (any)
last-member-interval: (any)
last-member-query-count: (any)
max-hops: (any)
max-message-age: (any)
membership-interval: (any)
mld-version: (any)
mtu: (any)
multicast-querier: (any)
multicast-router: (any)
name: (any)
priority: (any)
protocol-mode: (any)
pvid: (any)
querier-interval: (any)
query-interval: (any)
query-response-interval: (any)
region-name: (any)
region-revision: (any)
startup-query-count: (any)
startup-query-interval: (any)
transmit-hold-count: (any)
vlan-filtering: (any)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/bridge/add post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

add-dhcp-option82: (any)
admin-mac: (any)
ageing-time: (any)
arp: (any)
arp-timeout: (any)
auto-mac: (any)
comment: (any)
copy-from: (any)
dhcp-snooping: (any)
disabled: (any)
ether-type: (any)
fast-forward: (any)
forward-delay: (any)
frame-types: (any)
igmp-snooping: (any)
igmp-version: (any)
ingress-filtering: (any)
last-member-interval: (any)
last-member-query-count: (any)
max-hops: (any)
max-message-age: (any)
membership-interval: (any)
mld-version: (any)
mtu: (any)
multicast-querier: (any)
multicast-router: (any)
name: (any)
priority: (any)
protocol-mode: (any)
pvid: (any)
querier-interval: (any)
query-interval: (any)
query-response-interval: (any)
region-name: (any)
region-revision: (any)
startup-query-count: (any)
startup-query-interval: (any)
transmit-hold-count: (any)
vlan-filtering: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/bridge/calea get put

get

put

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

802.3-sap: (any)
802.3-type: (any)
action: (any)
arp-dst-address: (any)
arp-dst-mac-address: (any)
arp-gratuitous: (any)
arp-hardware-type: (any)
arp-opcode: (any)
arp-packet-type: (any)
arp-src-address: (any)
arp-src-mac-address: (any)
chain: (any)
comment: (any)
copy-from: (any)
disabled: (any)
dst-address: (any)
dst-address6: (any)
dst-mac-address: (any)
dst-port: (any)
in-bridge: (any)
in-bridge-list: (any)
in-interface: (any)
in-interface-list: (any)
ingress-priority: (any)
ip-protocol: (any)
limit: (any)
log: (any)
log-prefix: (any)
mac-protocol: (any)
out-bridge: (any)
out-bridge-list: (any)
out-interface: (any)
out-interface-list: (any)
packet-mark: (any)
packet-type: (any)
place-before: (any)
sniff-id: (any)
sniff-target: (any)
sniff-target-port: (any)
src-address: (any)
src-address6: (any)
src-mac-address: (any)
src-port: (any)
stp-flags: (any)
stp-forward-delay: (any)
stp-hello-time: (any)
stp-max-age: (any)
stp-msg-age: (any)
stp-port: (any)
stp-root-address: (any)
stp-root-cost: (any)
stp-root-priority: (any)
stp-sender-address: (any)
stp-sender-priority: (any)
stp-type: (any)
tls-host: (any)
vlan-encap: (any)
vlan-id: (any)
vlan-priority: (any)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/bridge/calea/add post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

802.3-sap: (any)
802.3-type: (any)
action: (any)
arp-dst-address: (any)
arp-dst-mac-address: (any)
arp-gratuitous: (any)
arp-hardware-type: (any)
arp-opcode: (any)
arp-packet-type: (any)
arp-src-address: (any)
arp-src-mac-address: (any)
chain: (any)
comment: (any)
copy-from: (any)
disabled: (any)
dst-address: (any)
dst-address6: (any)
dst-mac-address: (any)
dst-port: (any)
in-bridge: (any)
in-bridge-list: (any)
in-interface: (any)
in-interface-list: (any)
ingress-priority: (any)
ip-protocol: (any)
limit: (any)
log: (any)
log-prefix: (any)
mac-protocol: (any)
out-bridge: (any)
out-bridge-list: (any)
out-interface: (any)
out-interface-list: (any)
packet-mark: (any)
packet-type: (any)
place-before: (any)
sniff-id: (any)
sniff-target: (any)
sniff-target-port: (any)
src-address: (any)
src-address6: (any)
src-mac-address: (any)
src-port: (any)
stp-flags: (any)
stp-forward-delay: (any)
stp-hello-time: (any)
stp-max-age: (any)
stp-msg-age: (any)
stp-port: (any)
stp-root-address: (any)
stp-root-cost: (any)
stp-root-priority: (any)
stp-sender-address: (any)
stp-sender-priority: (any)
stp-type: (any)
tls-host: (any)
vlan-encap: (any)
vlan-id: (any)
vlan-priority: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/bridge/calea/{id} get delete patch

get

delete

patch

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

URI Parameters

id: required(string)

Body

Media type: application/json

Type: object

Properties

802.3-sap: (any)
802.3-type: (any)
action: (any)
arp-dst-address: (any)
arp-dst-mac-address: (any)
arp-gratuitous: (any)
arp-hardware-type: (any)
arp-opcode: (any)
arp-packet-type: (any)
arp-src-address: (any)
arp-src-mac-address: (any)
chain: (any)
comment: (any)
disabled: (any)
dst-address: (any)
dst-address6: (any)
dst-mac-address: (any)
dst-port: (any)
in-bridge: (any)
in-bridge-list: (any)
in-interface: (any)
in-interface-list: (any)
ingress-priority: (any)
ip-protocol: (any)
limit: (any)
log: (any)
log-prefix: (any)
mac-protocol: (any)
numbers: (any)
out-bridge: (any)
out-bridge-list: (any)
out-interface: (any)
out-interface-list: (any)
packet-mark: (any)
packet-type: (any)
sniff-id: (any)
sniff-target: (any)
sniff-target-port: (any)
src-address: (any)
src-address6: (any)
src-mac-address: (any)
src-port: (any)
stp-flags: (any)
stp-forward-delay: (any)
stp-hello-time: (any)
stp-max-age: (any)
stp-msg-age: (any)
stp-port: (any)
stp-root-address: (any)
stp-root-cost: (any)
stp-root-priority: (any)
stp-sender-address: (any)
stp-sender-priority: (any)
stp-type: (any)
tls-host: (any)
vlan-encap: (any)
vlan-id: (any)
vlan-priority: (any)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/bridge/calea/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

all: (any)
append: (any)
as-value: (any)
chain: (any)
count-only: (any)
detail: (any)
dynamic: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
static: (any)
stats: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/bridge/calea/reset post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

802.3-sap: (any)
802.3-type: (any)
action: (any)
arp-dst-address: (any)
arp-dst-mac-address: (any)
arp-gratuitous: (any)
arp-hardware-type: (any)
arp-opcode: (any)
arp-packet-type: (any)
arp-src-address: (any)
arp-src-mac-address: (any)
chain: (any)
comment: (any)
disabled: (any)
dst-address: (any)
dst-address6: (any)
dst-mac-address: (any)
dst-port: (any)
in-bridge: (any)
in-bridge-list: (any)
in-interface: (any)
in-interface-list: (any)
ingress-priority: (any)
ip-protocol: (any)
limit: (any)
log: (any)
log-prefix: (any)
mac-protocol: (any)
numbers: (any)
out-bridge: (any)
out-bridge-list: (any)
out-interface: (any)
out-interface-list: (any)
packet-mark: (any)
packet-type: (any)
sniff-id: (any)
sniff-target: (any)
sniff-target-port: (any)
src-address: (any)
src-address6: (any)
src-mac-address: (any)
src-port: (any)
stp-flags: (any)
stp-forward-delay: (any)
stp-hello-time: (any)
stp-max-age: (any)
stp-msg-age: (any)
stp-port: (any)
stp-root-address: (any)
stp-root-cost: (any)
stp-root-priority: (any)
stp-sender-address: (any)
stp-sender-priority: (any)
stp-type: (any)
tls-host: (any)
vlan-encap: (any)
vlan-id: (any)
vlan-priority: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/bridge/calea/set post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

802.3-sap: (any)
802.3-type: (any)
action: (any)
arp-dst-address: (any)
arp-dst-mac-address: (any)
arp-gratuitous: (any)
arp-hardware-type: (any)
arp-opcode: (any)
arp-packet-type: (any)
arp-src-address: (any)
arp-src-mac-address: (any)
chain: (any)
comment: (any)
disabled: (any)
dst-address: (any)
dst-address6: (any)
dst-mac-address: (any)
dst-port: (any)
in-bridge: (any)
in-bridge-list: (any)
in-interface: (any)
in-interface-list: (any)
ingress-priority: (any)
ip-protocol: (any)
limit: (any)
log: (any)
log-prefix: (any)
mac-protocol: (any)
numbers: (any)
out-bridge: (any)
out-bridge-list: (any)
out-interface: (any)
out-interface-list: (any)
packet-mark: (any)
packet-type: (any)
sniff-id: (any)
sniff-target: (any)
sniff-target-port: (any)
src-address: (any)
src-address6: (any)
src-mac-address: (any)
src-port: (any)
stp-flags: (any)
stp-forward-delay: (any)
stp-hello-time: (any)
stp-max-age: (any)
stp-msg-age: (any)
stp-port: (any)
stp-root-address: (any)
stp-root-cost: (any)
stp-root-priority: (any)
stp-sender-address: (any)
stp-sender-priority: (any)
stp-type: (any)
tls-host: (any)
vlan-encap: (any)
vlan-id: (any)
vlan-priority: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/bridge/filter get put

get

put

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

802.3-sap: (any)
802.3-type: (any)
action: (any)
arp-dst-address: (any)
arp-dst-mac-address: (any)
arp-gratuitous: (any)
arp-hardware-type: (any)
arp-opcode: (any)
arp-packet-type: (any)
arp-src-address: (any)
arp-src-mac-address: (any)
chain: (any)
comment: (any)
copy-from: (any)
disabled: (any)
dst-address: (any)
dst-address6: (any)
dst-mac-address: (any)
dst-port: (any)
in-bridge: (any)
in-bridge-list: (any)
in-interface: (any)
in-interface-list: (any)
ingress-priority: (any)
ip-protocol: (any)
jump-target: (any)
limit: (any)
log: (any)
log-prefix: (any)
mac-protocol: (any)
new-packet-mark: (any)
new-priority: (any)
out-bridge: (any)
out-bridge-list: (any)
out-interface: (any)
out-interface-list: (any)
packet-mark: (any)
packet-type: (any)
passthrough: (any)
place-before: (any)
src-address: (any)
src-address6: (any)
src-mac-address: (any)
src-port: (any)
stp-flags: (any)
stp-forward-delay: (any)
stp-hello-time: (any)
stp-max-age: (any)
stp-msg-age: (any)
stp-port: (any)
stp-root-address: (any)
stp-root-cost: (any)
stp-root-priority: (any)
stp-sender-address: (any)
stp-sender-priority: (any)
stp-type: (any)
tls-host: (any)
vlan-encap: (any)
vlan-id: (any)
vlan-priority: (any)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/bridge/filter/add post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

802.3-sap: (any)
802.3-type: (any)
action: (any)
arp-dst-address: (any)
arp-dst-mac-address: (any)
arp-gratuitous: (any)
arp-hardware-type: (any)
arp-opcode: (any)
arp-packet-type: (any)
arp-src-address: (any)
arp-src-mac-address: (any)
chain: (any)
comment: (any)
copy-from: (any)
disabled: (any)
dst-address: (any)
dst-address6: (any)
dst-mac-address: (any)
dst-port: (any)
in-bridge: (any)
in-bridge-list: (any)
in-interface: (any)
in-interface-list: (any)
ingress-priority: (any)
ip-protocol: (any)
jump-target: (any)
limit: (any)
log: (any)
log-prefix: (any)
mac-protocol: (any)
new-packet-mark: (any)
new-priority: (any)
out-bridge: (any)
out-bridge-list: (any)
out-interface: (any)
out-interface-list: (any)
packet-mark: (any)
packet-type: (any)
passthrough: (any)
place-before: (any)
src-address: (any)
src-address6: (any)
src-mac-address: (any)
src-port: (any)
stp-flags: (any)
stp-forward-delay: (any)
stp-hello-time: (any)
stp-max-age: (any)
stp-msg-age: (any)
stp-port: (any)
stp-root-address: (any)
stp-root-cost: (any)
stp-root-priority: (any)
stp-sender-address: (any)
stp-sender-priority: (any)
stp-type: (any)
tls-host: (any)
vlan-encap: (any)
vlan-id: (any)
vlan-priority: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/bridge/filter/{id} get delete patch

get

delete

patch

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

URI Parameters

id: required(string)

Body

Media type: application/json

Type: object

Properties

802.3-sap: (any)
802.3-type: (any)
action: (any)
arp-dst-address: (any)
arp-dst-mac-address: (any)
arp-gratuitous: (any)
arp-hardware-type: (any)
arp-opcode: (any)
arp-packet-type: (any)
arp-src-address: (any)
arp-src-mac-address: (any)
chain: (any)
comment: (any)
disabled: (any)
dst-address: (any)
dst-address6: (any)
dst-mac-address: (any)
dst-port: (any)
in-bridge: (any)
in-bridge-list: (any)
in-interface: (any)
in-interface-list: (any)
ingress-priority: (any)
ip-protocol: (any)
jump-target: (any)
limit: (any)
log: (any)
log-prefix: (any)
mac-protocol: (any)
new-packet-mark: (any)
new-priority: (any)
numbers: (any)
out-bridge: (any)
out-bridge-list: (any)
out-interface: (any)
out-interface-list: (any)
packet-mark: (any)
packet-type: (any)
passthrough: (any)
src-address: (any)
src-address6: (any)
src-mac-address: (any)
src-port: (any)
stp-flags: (any)
stp-forward-delay: (any)
stp-hello-time: (any)
stp-max-age: (any)
stp-msg-age: (any)
stp-port: (any)
stp-root-address: (any)
stp-root-cost: (any)
stp-root-priority: (any)
stp-sender-address: (any)
stp-sender-priority: (any)
stp-type: (any)
tls-host: (any)
vlan-encap: (any)
vlan-id: (any)
vlan-priority: (any)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/bridge/filter/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

all: (any)
append: (any)
as-value: (any)
chain: (any)
count-only: (any)
detail: (any)
dynamic: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
static: (any)
stats: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/bridge/filter/reset post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

802.3-sap: (any)
802.3-type: (any)
action: (any)
arp-dst-address: (any)
arp-dst-mac-address: (any)
arp-gratuitous: (any)
arp-hardware-type: (any)
arp-opcode: (any)
arp-packet-type: (any)
arp-src-address: (any)
arp-src-mac-address: (any)
chain: (any)
comment: (any)
disabled: (any)
dst-address: (any)
dst-address6: (any)
dst-mac-address: (any)
dst-port: (any)
in-bridge: (any)
in-bridge-list: (any)
in-interface: (any)
in-interface-list: (any)
ingress-priority: (any)
ip-protocol: (any)
jump-target: (any)
limit: (any)
log: (any)
log-prefix: (any)
mac-protocol: (any)
new-packet-mark: (any)
new-priority: (any)
numbers: (any)
out-bridge: (any)
out-bridge-list: (any)
out-interface: (any)
out-interface-list: (any)
packet-mark: (any)
packet-type: (any)
passthrough: (any)
src-address: (any)
src-address6: (any)
src-mac-address: (any)
src-port: (any)
stp-flags: (any)
stp-forward-delay: (any)
stp-hello-time: (any)
stp-max-age: (any)
stp-msg-age: (any)
stp-port: (any)
stp-root-address: (any)
stp-root-cost: (any)
stp-root-priority: (any)
stp-sender-address: (any)
stp-sender-priority: (any)
stp-type: (any)
tls-host: (any)
vlan-encap: (any)
vlan-id: (any)
vlan-priority: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/bridge/filter/set post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

802.3-sap: (any)
802.3-type: (any)
action: (any)
arp-dst-address: (any)
arp-dst-mac-address: (any)
arp-gratuitous: (any)
arp-hardware-type: (any)
arp-opcode: (any)
arp-packet-type: (any)
arp-src-address: (any)
arp-src-mac-address: (any)
chain: (any)
comment: (any)
disabled: (any)
dst-address: (any)
dst-address6: (any)
dst-mac-address: (any)
dst-port: (any)
in-bridge: (any)
in-bridge-list: (any)
in-interface: (any)
in-interface-list: (any)
ingress-priority: (any)
ip-protocol: (any)
jump-target: (any)
limit: (any)
log: (any)
log-prefix: (any)
mac-protocol: (any)
new-packet-mark: (any)
new-priority: (any)
numbers: (any)
out-bridge: (any)
out-bridge-list: (any)
out-interface: (any)
out-interface-list: (any)
packet-mark: (any)
packet-type: (any)
passthrough: (any)
src-address: (any)
src-address6: (any)
src-mac-address: (any)
src-port: (any)
stp-flags: (any)
stp-forward-delay: (any)
stp-hello-time: (any)
stp-max-age: (any)
stp-msg-age: (any)
stp-port: (any)
stp-root-address: (any)
stp-root-cost: (any)
stp-root-priority: (any)
stp-sender-address: (any)
stp-sender-priority: (any)
stp-type: (any)
tls-host: (any)
vlan-encap: (any)
vlan-id: (any)
vlan-priority: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/bridge/{id} get delete patch

get

delete

patch

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

URI Parameters

id: required(string)

Body

Media type: application/json

Type: object

Properties

add-dhcp-option82: (any)
admin-mac: (any)
ageing-time: (any)
arp: (any)
arp-timeout: (any)
auto-mac: (any)
comment: (any)
dhcp-snooping: (any)
disabled: (any)
ether-type: (any)
fast-forward: (any)
forward-delay: (any)
frame-types: (any)
igmp-snooping: (any)
igmp-version: (any)
ingress-filtering: (any)
last-member-interval: (any)
last-member-query-count: (any)
max-hops: (any)
max-message-age: (any)
membership-interval: (any)
mld-version: (any)
mtu: (any)
multicast-querier: (any)
multicast-router: (any)
name: (any)
numbers: (any)
priority: (any)
protocol-mode: (any)
pvid: (any)
querier-interval: (any)
query-interval: (any)
query-response-interval: (any)
region-name: (any)
region-revision: (any)
startup-query-count: (any)
startup-query-interval: (any)
transmit-hold-count: (any)
vlan-filtering: (any)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/bridge/host get put

get

put

/interface/bridge/host/add post

post

/interface/bridge/host/{id} get delete patch

get

delete

patch

/interface/bridge/host/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/bridge/mdb get put

get

put

/interface/bridge/mdb/{id} get delete patch

get

delete

patch

/interface/bridge/mdb/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/bridge/monitor post

post

/interface/bridge/msti get put

get

put

/interface/bridge/msti/add post

post

/interface/bridge/msti/{id} get delete patch

get

delete

patch

/interface/bridge/msti/monitor post

post

/interface/bridge/msti/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/bridge/msti/set post

post

/interface/bridge/nat get put

get

put

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

802.3-sap: (any)
802.3-type: (any)
action: (any)
arp-dst-address: (any)
arp-dst-mac-address: (any)
arp-gratuitous: (any)
arp-hardware-type: (any)
arp-opcode: (any)
arp-packet-type: (any)
arp-src-address: (any)
arp-src-mac-address: (any)
chain: (any)
comment: (any)
copy-from: (any)
disabled: (any)
dst-address: (any)
dst-address6: (any)
dst-mac-address: (any)
dst-port: (any)
in-bridge: (any)
in-bridge-list: (any)
in-interface: (any)
in-interface-list: (any)
ingress-priority: (any)
ip-protocol: (any)
jump-target: (any)
limit: (any)
log: (any)
log-prefix: (any)
mac-protocol: (any)
new-packet-mark: (any)
new-priority: (any)
out-bridge: (any)
out-bridge-list: (any)
out-interface: (any)
out-interface-list: (any)
packet-mark: (any)
packet-type: (any)
passthrough: (any)
place-before: (any)
src-address: (any)
src-address6: (any)
src-mac-address: (any)
src-port: (any)
stp-flags: (any)
stp-forward-delay: (any)
stp-hello-time: (any)
stp-max-age: (any)
stp-msg-age: (any)
stp-port: (any)
stp-root-address: (any)
stp-root-cost: (any)
stp-root-priority: (any)
stp-sender-address: (any)
stp-sender-priority: (any)
stp-type: (any)
tls-host: (any)
to-arp-reply-mac-address: (any)
to-dst-mac-address: (any)
to-src-mac-address: (any)
vlan-encap: (any)
vlan-id: (any)
vlan-priority: (any)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/bridge/nat/add post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

802.3-sap: (any)
802.3-type: (any)
action: (any)
arp-dst-address: (any)
arp-dst-mac-address: (any)
arp-gratuitous: (any)
arp-hardware-type: (any)
arp-opcode: (any)
arp-packet-type: (any)
arp-src-address: (any)
arp-src-mac-address: (any)
chain: (any)
comment: (any)
copy-from: (any)
disabled: (any)
dst-address: (any)
dst-address6: (any)
dst-mac-address: (any)
dst-port: (any)
in-bridge: (any)
in-bridge-list: (any)
in-interface: (any)
in-interface-list: (any)
ingress-priority: (any)
ip-protocol: (any)
jump-target: (any)
limit: (any)
log: (any)
log-prefix: (any)
mac-protocol: (any)
new-packet-mark: (any)
new-priority: (any)
out-bridge: (any)
out-bridge-list: (any)
out-interface: (any)
out-interface-list: (any)
packet-mark: (any)
packet-type: (any)
passthrough: (any)
place-before: (any)
src-address: (any)
src-address6: (any)
src-mac-address: (any)
src-port: (any)
stp-flags: (any)
stp-forward-delay: (any)
stp-hello-time: (any)
stp-max-age: (any)
stp-msg-age: (any)
stp-port: (any)
stp-root-address: (any)
stp-root-cost: (any)
stp-root-priority: (any)
stp-sender-address: (any)
stp-sender-priority: (any)
stp-type: (any)
tls-host: (any)
to-arp-reply-mac-address: (any)
to-dst-mac-address: (any)
to-src-mac-address: (any)
vlan-encap: (any)
vlan-id: (any)
vlan-priority: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/bridge/nat/{id} get delete patch

get

delete

patch

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

URI Parameters

id: required(string)

Body

Media type: application/json

Type: object

Properties

802.3-sap: (any)
802.3-type: (any)
action: (any)
arp-dst-address: (any)
arp-dst-mac-address: (any)
arp-gratuitous: (any)
arp-hardware-type: (any)
arp-opcode: (any)
arp-packet-type: (any)
arp-src-address: (any)
arp-src-mac-address: (any)
chain: (any)
comment: (any)
disabled: (any)
dst-address: (any)
dst-address6: (any)
dst-mac-address: (any)
dst-port: (any)
in-bridge: (any)
in-bridge-list: (any)
in-interface: (any)
in-interface-list: (any)
ingress-priority: (any)
ip-protocol: (any)
jump-target: (any)
limit: (any)
log: (any)
log-prefix: (any)
mac-protocol: (any)
new-packet-mark: (any)
new-priority: (any)
numbers: (any)
out-bridge: (any)
out-bridge-list: (any)
out-interface: (any)
out-interface-list: (any)
packet-mark: (any)
packet-type: (any)
passthrough: (any)
src-address: (any)
src-address6: (any)
src-mac-address: (any)
src-port: (any)
stp-flags: (any)
stp-forward-delay: (any)
stp-hello-time: (any)
stp-max-age: (any)
stp-msg-age: (any)
stp-port: (any)
stp-root-address: (any)
stp-root-cost: (any)
stp-root-priority: (any)
stp-sender-address: (any)
stp-sender-priority: (any)
stp-type: (any)
tls-host: (any)
to-arp-reply-mac-address: (any)
to-dst-mac-address: (any)
to-src-mac-address: (any)
vlan-encap: (any)
vlan-id: (any)
vlan-priority: (any)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/bridge/nat/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

all: (any)
append: (any)
as-value: (any)
chain: (any)
count-only: (any)
detail: (any)
dynamic: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
static: (any)
stats: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/bridge/nat/reset post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

802.3-sap: (any)
802.3-type: (any)
action: (any)
arp-dst-address: (any)
arp-dst-mac-address: (any)
arp-gratuitous: (any)
arp-hardware-type: (any)
arp-opcode: (any)
arp-packet-type: (any)
arp-src-address: (any)
arp-src-mac-address: (any)
chain: (any)
comment: (any)
disabled: (any)
dst-address: (any)
dst-address6: (any)
dst-mac-address: (any)
dst-port: (any)
in-bridge: (any)
in-bridge-list: (any)
in-interface: (any)
in-interface-list: (any)
ingress-priority: (any)
ip-protocol: (any)
jump-target: (any)
limit: (any)
log: (any)
log-prefix: (any)
mac-protocol: (any)
new-packet-mark: (any)
new-priority: (any)
numbers: (any)
out-bridge: (any)
out-bridge-list: (any)
out-interface: (any)
out-interface-list: (any)
packet-mark: (any)
packet-type: (any)
passthrough: (any)
src-address: (any)
src-address6: (any)
src-mac-address: (any)
src-port: (any)
stp-flags: (any)
stp-forward-delay: (any)
stp-hello-time: (any)
stp-max-age: (any)
stp-msg-age: (any)
stp-port: (any)
stp-root-address: (any)
stp-root-cost: (any)
stp-root-priority: (any)
stp-sender-address: (any)
stp-sender-priority: (any)
stp-type: (any)
tls-host: (any)
to-arp-reply-mac-address: (any)
to-dst-mac-address: (any)
to-src-mac-address: (any)
vlan-encap: (any)
vlan-id: (any)
vlan-priority: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/bridge/nat/set post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

802.3-sap: (any)
802.3-type: (any)
action: (any)
arp-dst-address: (any)
arp-dst-mac-address: (any)
arp-gratuitous: (any)
arp-hardware-type: (any)
arp-opcode: (any)
arp-packet-type: (any)
arp-src-address: (any)
arp-src-mac-address: (any)
chain: (any)
comment: (any)
disabled: (any)
dst-address: (any)
dst-address6: (any)
dst-mac-address: (any)
dst-port: (any)
in-bridge: (any)
in-bridge-list: (any)
in-interface: (any)
in-interface-list: (any)
ingress-priority: (any)
ip-protocol: (any)
jump-target: (any)
limit: (any)
log: (any)
log-prefix: (any)
mac-protocol: (any)
new-packet-mark: (any)
new-priority: (any)
numbers: (any)
out-bridge: (any)
out-bridge-list: (any)
out-interface: (any)
out-interface-list: (any)
packet-mark: (any)
packet-type: (any)
passthrough: (any)
src-address: (any)
src-address6: (any)
src-mac-address: (any)
src-port: (any)
stp-flags: (any)
stp-forward-delay: (any)
stp-hello-time: (any)
stp-max-age: (any)
stp-msg-age: (any)
stp-port: (any)
stp-root-address: (any)
stp-root-cost: (any)
stp-root-priority: (any)
stp-sender-address: (any)
stp-sender-priority: (any)
stp-type: (any)
tls-host: (any)
to-arp-reply-mac-address: (any)
to-dst-mac-address: (any)
to-src-mac-address: (any)
vlan-encap: (any)
vlan-id: (any)
vlan-priority: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/bridge/port get put

get

put

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

auto-isolate: (any)
bpdu-guard: (any)
bridge: (any)
broadcast-flood: (any)
comment: (any)
copy-from: (any)
disabled: (any)
edge: (any)
fast-leave: (any)
frame-types: (any)
horizon: (any)
hw: (any)
ingress-filtering: (any)
interface: (any)
internal-path-cost: (any)
learn: (any)
multicast-router: (any)
path-cost: (any)
place-before: (any)
point-to-point: (any)
priority: (any)
pvid: (any)
restricted-role: (any)
restricted-tcn: (any)
tag-stacking: (any)
trusted: (any)
unknown-multicast-flood: (any)
unknown-unicast-flood: (any)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/bridge/port/add post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

auto-isolate: (any)
bpdu-guard: (any)
bridge: (any)
broadcast-flood: (any)
comment: (any)
copy-from: (any)
disabled: (any)
edge: (any)
fast-leave: (any)
frame-types: (any)
horizon: (any)
hw: (any)
ingress-filtering: (any)
interface: (any)
internal-path-cost: (any)
learn: (any)
multicast-router: (any)
path-cost: (any)
place-before: (any)
point-to-point: (any)
priority: (any)
pvid: (any)
restricted-role: (any)
restricted-tcn: (any)
tag-stacking: (any)
trusted: (any)
unknown-multicast-flood: (any)
unknown-unicast-flood: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/bridge/port/{id} get delete patch

get

delete

patch

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

URI Parameters

id: required(string)

Body

Media type: application/json

Type: object

Properties

auto-isolate: (any)
bpdu-guard: (any)
bridge: (any)
broadcast-flood: (any)
comment: (any)
disabled: (any)
edge: (any)
fast-leave: (any)
frame-types: (any)
horizon: (any)
hw: (any)
ingress-filtering: (any)
interface: (any)
internal-path-cost: (any)
learn: (any)
multicast-router: (any)
numbers: (any)
path-cost: (any)
point-to-point: (any)
priority: (any)
pvid: (any)
restricted-role: (any)
restricted-tcn: (any)
tag-stacking: (any)
trusted: (any)
unknown-multicast-flood: (any)
unknown-unicast-flood: (any)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/bridge/port/monitor post

post

/interface/bridge/port/mst-override get put

get

put

/interface/bridge/port/mst-override/{id} get delete patch

get

delete

patch

/interface/bridge/port/mst-override/monitor post

post

/interface/bridge/port/mst-override/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
debug: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/bridge/port/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
debug: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
stats: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/bridge/port/reset post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

auto-isolate: (any)
bpdu-guard: (any)
bridge: (any)
broadcast-flood: (any)
comment: (any)
disabled: (any)
edge: (any)
fast-leave: (any)
frame-types: (any)
horizon: (any)
hw: (any)
ingress-filtering: (any)
interface: (any)
internal-path-cost: (any)
learn: (any)
multicast-router: (any)
numbers: (any)
path-cost: (any)
point-to-point: (any)
priority: (any)
pvid: (any)
restricted-role: (any)
restricted-tcn: (any)
tag-stacking: (any)
trusted: (any)
unknown-multicast-flood: (any)
unknown-unicast-flood: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/bridge/port/set post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

auto-isolate: (any)
bpdu-guard: (any)
bridge: (any)
broadcast-flood: (any)
comment: (any)
disabled: (any)
edge: (any)
fast-leave: (any)
frame-types: (any)
horizon: (any)
hw: (any)
ingress-filtering: (any)
interface: (any)
internal-path-cost: (any)
learn: (any)
multicast-router: (any)
numbers: (any)
path-cost: (any)
point-to-point: (any)
priority: (any)
pvid: (any)
restricted-role: (any)
restricted-tcn: (any)
tag-stacking: (any)
trusted: (any)
unknown-multicast-flood: (any)
unknown-unicast-flood: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/bridge/port-controller/device get put

get

put

/interface/bridge/port-controller/device/{id} get delete patch

get

delete

patch

/interface/bridge/port-controller/device/monitor post

post

/interface/bridge/port-controller/device/print post

post

/interface/bridge/port-controller/{id} get patch

get

patch

/interface/bridge/port-controller/port/{id} get delete patch

get

delete

patch

/interface/bridge/port-controller/port/monitor post

post

/interface/bridge/port-controller/port/poe/monitor post

post

/interface/bridge/port-controller/port/poe/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/bridge/port-controller/port/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/bridge/port-extender/{id} get patch

get

patch

/interface/bridge/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/bridge/reset post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

add-dhcp-option82: (any)
admin-mac: (any)
ageing-time: (any)
arp: (any)
arp-timeout: (any)
auto-mac: (any)
comment: (any)
dhcp-snooping: (any)
disabled: (any)
ether-type: (any)
fast-forward: (any)
forward-delay: (any)
frame-types: (any)
igmp-snooping: (any)
igmp-version: (any)
ingress-filtering: (any)
last-member-interval: (any)
last-member-query-count: (any)
max-hops: (any)
max-message-age: (any)
membership-interval: (any)
mld-version: (any)
mtu: (any)
multicast-querier: (any)
multicast-router: (any)
name: (any)
numbers: (any)
priority: (any)
protocol-mode: (any)
pvid: (any)
querier-interval: (any)
query-interval: (any)
query-response-interval: (any)
region-name: (any)
region-revision: (any)
startup-query-count: (any)
startup-query-interval: (any)
transmit-hold-count: (any)
vlan-filtering: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/bridge/set post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

add-dhcp-option82: (any)
admin-mac: (any)
ageing-time: (any)
arp: (any)
arp-timeout: (any)
auto-mac: (any)
comment: (any)
dhcp-snooping: (any)
disabled: (any)
ether-type: (any)
fast-forward: (any)
forward-delay: (any)
frame-types: (any)
igmp-snooping: (any)
igmp-version: (any)
ingress-filtering: (any)
last-member-interval: (any)
last-member-query-count: (any)
max-hops: (any)
max-message-age: (any)
membership-interval: (any)
mld-version: (any)
mtu: (any)
multicast-querier: (any)
multicast-router: (any)
name: (any)
numbers: (any)
priority: (any)
protocol-mode: (any)
pvid: (any)
querier-interval: (any)
query-interval: (any)
query-response-interval: (any)
region-name: (any)
region-revision: (any)
startup-query-count: (any)
startup-query-interval: (any)
transmit-hold-count: (any)
vlan-filtering: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/bridge/settings/{id} get patch

get

patch

/interface/bridge/vlan get put

get

put

/interface/bridge/vlan/{id} get delete patch

get

delete

patch

/interface/bridge/vlan/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/detect-internet/{id} get patch

get

patch

/interface/detect-internet/state/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/dot1x/client get put

get

put

/interface/dot1x/client/add post

post

/interface/dot1x/client/{id} get delete patch

get

delete

patch

/interface/dot1x/client/print post

post

/interface/dot1x/client/reset post

post

/interface/dot1x/client/set post

post

/interface/dot1x/server get put

get

put

/interface/dot1x/server/active get put

get

put

/interface/dot1x/server/active/{id} get delete

get

delete

/interface/dot1x/server/active/print post

post

/interface/dot1x/server/add post

post

/interface/dot1x/server/{id} get delete patch

get

delete

patch

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

URI Parameters

id: required(string)

Body

Media type: application/json

Type: object

Properties

accounting: (any)
auth-timeout: (any)
auth-types: (any)
comment: (any)
disabled: (any)
guest-vlan-id: (any)
interface: (any)
interim-update: (any)
mac-auth-mode: (any)
numbers: (any)
radius-mac-format: (any)
reauth-timeout: (any)
reject-vlan-id: (any)
retrans-timeout: (any)
server-fail-vlan-id: (any)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/dot1x/server/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/dot1x/server/reset post

post

/interface/dot1x/server/set post

post

/interface/dot1x/server/state/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/eoip get put

get

put

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

allow-fast-path: (any)
arp: (any)
arp-timeout: (any)
clamp-tcp-mss: (any)
comment: (any)
copy-from: (any)
disabled: (any)
dont-fragment: (any)
dscp: (any)
ipsec-secret: (any)
keepalive: (any)
local-address: (any)
loop-protect: (any)
loop-protect-disable-time: (any)
loop-protect-send-interval: (any)
mac-address: (any)
mtu: (any)
name: (any)
remote-address: (any)
tunnel-id: (any)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/eoip/add post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

allow-fast-path: (any)
arp: (any)
arp-timeout: (any)
clamp-tcp-mss: (any)
comment: (any)
copy-from: (any)
disabled: (any)
dont-fragment: (any)
dscp: (any)
ipsec-secret: (any)
keepalive: (any)
local-address: (any)
loop-protect: (any)
loop-protect-disable-time: (any)
loop-protect-send-interval: (any)
mac-address: (any)
mtu: (any)
name: (any)
remote-address: (any)
tunnel-id: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/eoip/{id} get delete patch

get

delete

patch

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

URI Parameters

id: required(string)

Body

Media type: application/json

Type: object

Properties

allow-fast-path: (any)
arp: (any)
arp-timeout: (any)
clamp-tcp-mss: (any)
comment: (any)
disabled: (any)
dont-fragment: (any)
dscp: (any)
ipsec-secret: (any)
keepalive: (any)
local-address: (any)
loop-protect: (any)
loop-protect-disable-time: (any)
loop-protect-send-interval: (any)
mac-address: (any)
mtu: (any)
name: (any)
numbers: (any)
remote-address: (any)
tunnel-id: (any)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/eoip/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/eoip/reset post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

allow-fast-path: (any)
arp: (any)
arp-timeout: (any)
clamp-tcp-mss: (any)
comment: (any)
disabled: (any)
dont-fragment: (any)
dscp: (any)
ipsec-secret: (any)
keepalive: (any)
local-address: (any)
loop-protect: (any)
loop-protect-disable-time: (any)
loop-protect-send-interval: (any)
mac-address: (any)
mtu: (any)
name: (any)
numbers: (any)
remote-address: (any)
tunnel-id: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/eoip/set post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

allow-fast-path: (any)
arp: (any)
arp-timeout: (any)
clamp-tcp-mss: (any)
comment: (any)
disabled: (any)
dont-fragment: (any)
dscp: (any)
ipsec-secret: (any)
keepalive: (any)
local-address: (any)
loop-protect: (any)
loop-protect-disable-time: (any)
loop-protect-send-interval: (any)
mac-address: (any)
mtu: (any)
name: (any)
numbers: (any)
remote-address: (any)
tunnel-id: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/eoipv6 get put

get

put

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

arp: (any)
arp-timeout: (any)
clamp-tcp-mss: (any)
comment: (any)
copy-from: (any)
disabled: (any)
dscp: (any)
ipsec-secret: (any)
keepalive: (any)
local-address: (any)
loop-protect: (any)
loop-protect-disable-time: (any)
loop-protect-send-interval: (any)
mac-address: (any)
mtu: (any)
name: (any)
remote-address: (any)
tunnel-id: (any)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/eoipv6/add post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

arp: (any)
arp-timeout: (any)
clamp-tcp-mss: (any)
comment: (any)
copy-from: (any)
disabled: (any)
dscp: (any)
ipsec-secret: (any)
keepalive: (any)
local-address: (any)
loop-protect: (any)
loop-protect-disable-time: (any)
loop-protect-send-interval: (any)
mac-address: (any)
mtu: (any)
name: (any)
remote-address: (any)
tunnel-id: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/eoipv6/{id} get delete patch

get

delete

patch

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

URI Parameters

id: required(string)

Body

Media type: application/json

Type: object

Properties

arp: (any)
arp-timeout: (any)
clamp-tcp-mss: (any)
comment: (any)
disabled: (any)
dscp: (any)
ipsec-secret: (any)
keepalive: (any)
local-address: (any)
loop-protect: (any)
loop-protect-disable-time: (any)
loop-protect-send-interval: (any)
mac-address: (any)
mtu: (any)
name: (any)
numbers: (any)
remote-address: (any)
tunnel-id: (any)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/eoipv6/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/eoipv6/reset post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

arp: (any)
arp-timeout: (any)
clamp-tcp-mss: (any)
comment: (any)
disabled: (any)
dscp: (any)
ipsec-secret: (any)
keepalive: (any)
local-address: (any)
loop-protect: (any)
loop-protect-disable-time: (any)
loop-protect-send-interval: (any)
mac-address: (any)
mtu: (any)
name: (any)
numbers: (any)
remote-address: (any)
tunnel-id: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/eoipv6/set post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

arp: (any)
arp-timeout: (any)
clamp-tcp-mss: (any)
comment: (any)
disabled: (any)
dscp: (any)
ipsec-secret: (any)
keepalive: (any)
local-address: (any)
loop-protect: (any)
loop-protect-disable-time: (any)
loop-protect-send-interval: (any)
mac-address: (any)
mtu: (any)
name: (any)
numbers: (any)
remote-address: (any)
tunnel-id: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/ethernet/cable-test post

post

/interface/ethernet/{id} get patch

get

patch

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

URI Parameters

id: required(string)

Body

Media type: application/json

Type: object

Properties

advertise: (any)
arp: (any)
arp-timeout: (any)
auto-negotiation: (any)
bandwidth: (any)
combo-mode: (any)
comment: (any)
disabled: (any)
fec-mode: (any)
l2mtu: (any)
loop-protect: (any)
loop-protect-disable-time: (any)
loop-protect-send-interval: (any)
mac-address: (any)
mdix-enable: (any)
mtu: (any)
name: (any)
numbers: (any)
orig-mac-address: (any)
rx-flow-control: (any)
sfp-rate-select: (any)
sfp-shutdown-temperature: (any)
speed: (any)
tx-flow-control: (any)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/ethernet/monitor post

post

/interface/ethernet/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
stats: (any)
stats-detail: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/ethernet/reset post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

advertise: (any)
arp: (any)
arp-timeout: (any)
auto-negotiation: (any)
bandwidth: (any)
combo-mode: (any)
comment: (any)
disabled: (any)
fec-mode: (any)
l2mtu: (any)
loop-protect: (any)
loop-protect-disable-time: (any)
loop-protect-send-interval: (any)
mac-address: (any)
mdix-enable: (any)
mtu: (any)
name: (any)
numbers: (any)
orig-mac-address: (any)
rx-flow-control: (any)
sfp-rate-select: (any)
sfp-shutdown-temperature: (any)
speed: (any)
tx-flow-control: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/ethernet/set post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

advertise: (any)
arp: (any)
arp-timeout: (any)
auto-negotiation: (any)
bandwidth: (any)
combo-mode: (any)
comment: (any)
disabled: (any)
fec-mode: (any)
l2mtu: (any)
loop-protect: (any)
loop-protect-disable-time: (any)
loop-protect-send-interval: (any)
mac-address: (any)
mdix-enable: (any)
mtu: (any)
name: (any)
numbers: (any)
orig-mac-address: (any)
rx-flow-control: (any)
sfp-rate-select: (any)
sfp-shutdown-temperature: (any)
speed: (any)
tx-flow-control: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/ethernet/switch/{id} get patch

get

patch

/interface/ethernet/switch/port/{id} get patch

get

patch

/interface/ethernet/switch/port/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
qos: (any)
show-ids: (any)
stats: (any)
stats-detail: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/ethernet/switch/port-isolation/{id} get patch

get

patch

/interface/ethernet/switch/port-isolation/print post

post

/interface/ethernet/switch/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
stats: (any)
stats-detail: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/ethernet/switch/rule get put

get

put

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

comment: (any)
copy-from: (any)
copy-to-cpu: (any)
disabled: (any)
dscp: (any)
dst-address: (any)
dst-address6: (any)
dst-mac-address: (any)
dst-port: (any)
flow-label: (any)
mac-protocol: (any)
mirror: (any)
new-dst-ports: (any)
new-vlan-id: (any)
new-vlan-priority: (any)
place-before: (any)
ports: (any)
protocol: (any)
rate: (any)
redirect-to-cpu: (any)
src-address: (any)
src-address6: (any)
src-mac-address: (any)
src-port: (any)
switch: (any)
traffic-class: (any)
vlan-header: (any)
vlan-id: (any)
vlan-priority: (any)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/ethernet/switch/rule/add post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

comment: (any)
copy-from: (any)
copy-to-cpu: (any)
disabled: (any)
dscp: (any)
dst-address: (any)
dst-address6: (any)
dst-mac-address: (any)
dst-port: (any)
flow-label: (any)
mac-protocol: (any)
mirror: (any)
new-dst-ports: (any)
new-vlan-id: (any)
new-vlan-priority: (any)
place-before: (any)
ports: (any)
protocol: (any)
rate: (any)
redirect-to-cpu: (any)
src-address: (any)
src-address6: (any)
src-mac-address: (any)
src-port: (any)
switch: (any)
traffic-class: (any)
vlan-header: (any)
vlan-id: (any)
vlan-priority: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/ethernet/switch/rule/{id} get delete patch

get

delete

patch

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

URI Parameters

id: required(string)

Body

Media type: application/json

Type: object

Properties

comment: (any)
copy-to-cpu: (any)
disabled: (any)
dscp: (any)
dst-address: (any)
dst-address6: (any)
dst-mac-address: (any)
dst-port: (any)
flow-label: (any)
mac-protocol: (any)
mirror: (any)
new-dst-ports: (any)
new-vlan-id: (any)
new-vlan-priority: (any)
numbers: (any)
ports: (any)
protocol: (any)
rate: (any)
redirect-to-cpu: (any)
src-address: (any)
src-address6: (any)
src-mac-address: (any)
src-port: (any)
switch: (any)
traffic-class: (any)
vlan-header: (any)
vlan-id: (any)
vlan-priority: (any)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/ethernet/switch/rule/print post

post

/interface/ethernet/switch/rule/reset post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

comment: (any)
copy-to-cpu: (any)
disabled: (any)
dscp: (any)
dst-address: (any)
dst-address6: (any)
dst-mac-address: (any)
dst-port: (any)
flow-label: (any)
mac-protocol: (any)
mirror: (any)
new-dst-ports: (any)
new-vlan-id: (any)
new-vlan-priority: (any)
numbers: (any)
ports: (any)
protocol: (any)
rate: (any)
redirect-to-cpu: (any)
src-address: (any)
src-address6: (any)
src-mac-address: (any)
src-port: (any)
switch: (any)
traffic-class: (any)
vlan-header: (any)
vlan-id: (any)
vlan-priority: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/ethernet/switch/rule/set post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

comment: (any)
copy-to-cpu: (any)
disabled: (any)
dscp: (any)
dst-address: (any)
dst-address6: (any)
dst-mac-address: (any)
dst-port: (any)
flow-label: (any)
mac-protocol: (any)
mirror: (any)
new-dst-ports: (any)
new-vlan-id: (any)
new-vlan-priority: (any)
numbers: (any)
ports: (any)
protocol: (any)
rate: (any)
redirect-to-cpu: (any)
src-address: (any)
src-address6: (any)
src-mac-address: (any)
src-port: (any)
switch: (any)
traffic-class: (any)
vlan-header: (any)
vlan-id: (any)
vlan-priority: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/{id} get patch

get

patch

/interface/gre get put

get

put

/interface/gre/add post

post

/interface/gre/{id} get delete patch

get

delete

patch

/interface/gre/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/gre/reset post

post

/interface/gre/set post

post

/interface/gre6 get put

get

put

/interface/gre6/add post

post

/interface/gre6/{id} get delete patch

get

delete

patch

/interface/gre6/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/gre6/reset post

post

/interface/gre6/set post

post

/interface/ipip get put

get

put

/interface/ipip/add post

post

/interface/ipip/{id} get delete patch

get

delete

patch

/interface/ipip/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/ipip/reset post

post

/interface/ipip/set post

post

/interface/ipipv6 get put

get

put

/interface/ipipv6/add post

post

/interface/ipipv6/{id} get delete patch

get

delete

patch

/interface/ipipv6/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/ipipv6/reset post

post

/interface/ipipv6/set post

post

/interface/l2tp-client get put

get

put

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

add-default-route: (any)
allow: (any)
allow-fast-path: (any)
comment: (any)
connect-to: (any)
copy-from: (any)
default-route-distance: (any)
dial-on-demand: (any)
disabled: (any)
ipsec-secret: (any)
keepalive-timeout: (any)
l2tp-proto-version: (any)
l2tpv3-circuit-id: (any)
l2tpv3-cookie-length: (any)
l2tpv3-digest-hash: (any)
max-mru: (any)
max-mtu: (any)
mrru: (any)
name: (any)
password: (any)
profile: (any)
src-address: (any)
use-ipsec: (any)
use-peer-dns: (any)
user: (any)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/l2tp-client/add post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

add-default-route: (any)
allow: (any)
allow-fast-path: (any)
comment: (any)
connect-to: (any)
copy-from: (any)
default-route-distance: (any)
dial-on-demand: (any)
disabled: (any)
ipsec-secret: (any)
keepalive-timeout: (any)
l2tp-proto-version: (any)
l2tpv3-circuit-id: (any)
l2tpv3-cookie-length: (any)
l2tpv3-digest-hash: (any)
max-mru: (any)
max-mtu: (any)
mrru: (any)
name: (any)
password: (any)
profile: (any)
src-address: (any)
use-ipsec: (any)
use-peer-dns: (any)
user: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/l2tp-client/{id} get delete patch

get

delete

patch

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

URI Parameters

id: required(string)

Body

Media type: application/json

Type: object

Properties

add-default-route: (any)
allow: (any)
allow-fast-path: (any)
comment: (any)
connect-to: (any)
default-route-distance: (any)
dial-on-demand: (any)
disabled: (any)
ipsec-secret: (any)
keepalive-timeout: (any)
l2tp-proto-version: (any)
l2tpv3-circuit-id: (any)
l2tpv3-cookie-length: (any)
l2tpv3-digest-hash: (any)
max-mru: (any)
max-mtu: (any)
mrru: (any)
name: (any)
numbers: (any)
password: (any)
profile: (any)
src-address: (any)
use-ipsec: (any)
use-peer-dns: (any)
user: (any)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/l2tp-client/monitor post

post

/interface/l2tp-client/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/l2tp-client/reset post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

add-default-route: (any)
allow: (any)
allow-fast-path: (any)
comment: (any)
connect-to: (any)
default-route-distance: (any)
dial-on-demand: (any)
disabled: (any)
ipsec-secret: (any)
keepalive-timeout: (any)
l2tp-proto-version: (any)
l2tpv3-circuit-id: (any)
l2tpv3-cookie-length: (any)
l2tpv3-digest-hash: (any)
max-mru: (any)
max-mtu: (any)
mrru: (any)
name: (any)
numbers: (any)
password: (any)
profile: (any)
src-address: (any)
use-ipsec: (any)
use-peer-dns: (any)
user: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/l2tp-client/set post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

add-default-route: (any)
allow: (any)
allow-fast-path: (any)
comment: (any)
connect-to: (any)
default-route-distance: (any)
dial-on-demand: (any)
disabled: (any)
ipsec-secret: (any)
keepalive-timeout: (any)
l2tp-proto-version: (any)
l2tpv3-circuit-id: (any)
l2tpv3-cookie-length: (any)
l2tpv3-digest-hash: (any)
max-mru: (any)
max-mtu: (any)
mrru: (any)
name: (any)
numbers: (any)
password: (any)
profile: (any)
src-address: (any)
use-ipsec: (any)
use-peer-dns: (any)
user: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/l2tp-ether get put

get

put

/interface/l2tp-ether/add post

post

/interface/l2tp-ether/{id} get delete patch

get

delete

patch

/interface/l2tp-ether/monitor post

post

/interface/l2tp-ether/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/l2tp-ether/reset post

post

/interface/l2tp-ether/set post

post

/interface/l2tp-server get put

get

put

/interface/l2tp-server/{id} get delete patch

get

delete

patch

/interface/l2tp-server/monitor post

post

/interface/l2tp-server/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/l2tp-server/server/{id} get patch

get

patch

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

URI Parameters

id: required(string)

Body

Media type: application/json

Type: object

Properties

accept-proto-version: (any)
accept-pseudowire-type: (any)
allow-fast-path: (any)
authentication: (any)
caller-id-type: (any)
default-profile: (any)
enabled: (any)
ipsec-secret: (any)
keepalive-timeout: (any)
l2tpv3-circuit-id: (any)
l2tpv3-cookie-length: (any)
l2tpv3-digest-hash: (any)
l2tpv3-ether-interface-list: (any)
max-mru: (any)
max-mtu: (any)
max-sessions: (any)
mrru: (any)
one-session-per-host: (any)
use-ipsec: (any)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/l2tp-server/server/set post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

accept-proto-version: (any)
accept-pseudowire-type: (any)
allow-fast-path: (any)
authentication: (any)
caller-id-type: (any)
default-profile: (any)
enabled: (any)
ipsec-secret: (any)
keepalive-timeout: (any)
l2tpv3-circuit-id: (any)
l2tpv3-cookie-length: (any)
l2tpv3-digest-hash: (any)
l2tpv3-ether-interface-list: (any)
max-mru: (any)
max-mtu: (any)
max-sessions: (any)
mrru: (any)
one-session-per-host: (any)
use-ipsec: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/list get put

get

put

/interface/list/{id} get delete patch

get

delete

patch

/interface/list/member get put

get

put

/interface/list/member/{id} get delete patch

get

delete

patch

/interface/list/member/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/list/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/lte/apn get put

get

put

/interface/lte/apn/add post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

add-default-route: (any)
apn: (any)
authentication: (any)
comment: (any)
copy-from: (any)
default-route-distance: (any)
ip-type: (any)
ipv6-interface: (any)
name: (any)
passthrough-interface: (any)
passthrough-mac: (any)
passthrough-subnet-selection: (any)
password: (any)
use-network-apn: (any)
use-peer-dns: (any)
user: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/lte/apn/{id} get delete patch

get

delete

patch

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

URI Parameters

id: required(string)

Body

Media type: application/json

Type: object

Properties

add-default-route: (any)
apn: (any)
authentication: (any)
comment: (any)
default-route-distance: (any)
ip-type: (any)
ipv6-interface: (any)
name: (any)
numbers: (any)
passthrough-interface: (any)
passthrough-mac: (any)
passthrough-subnet-selection: (any)
password: (any)
use-network-apn: (any)
use-peer-dns: (any)
user: (any)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/lte/apn/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/lte/apn/reset post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

add-default-route: (any)
apn: (any)
authentication: (any)
comment: (any)
default-route-distance: (any)
ip-type: (any)
ipv6-interface: (any)
name: (any)
numbers: (any)
passthrough-interface: (any)
passthrough-mac: (any)
passthrough-subnet-selection: (any)
password: (any)
use-network-apn: (any)
use-peer-dns: (any)
user: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/lte/apn/set post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

add-default-route: (any)
apn: (any)
authentication: (any)
comment: (any)
default-route-distance: (any)
ip-type: (any)
ipv6-interface: (any)
name: (any)
numbers: (any)
passthrough-interface: (any)
passthrough-mac: (any)
passthrough-subnet-selection: (any)
password: (any)
use-network-apn: (any)
use-peer-dns: (any)
user: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/lte/esim/activate-profile post

post

/interface/lte/firmware-upgrade post

post

/interface/lte/{id} get patch

get

patch

/interface/lte/monitor post

post

/interface/lte/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/lte/reset post

post

/interface/lte/set post

post

/interface/lte/settings/{id} get patch

get

patch

/interface/macsec get put

get

put

/interface/macsec/add post

post

/interface/macsec/{id} get delete patch

get

delete

patch

/interface/macsec/print post

post

/interface/macsec/profile get put

get

put

/interface/macsec/profile/{id} get delete patch

get

delete

patch

/interface/macsec/profile/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/macsec/reset post

post

/interface/macsec/set post

post

/interface/macvlan get put

get

put

/interface/macvlan/add post

post

/interface/macvlan/{id} get delete patch

get

delete

patch

/interface/macvlan/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/macvlan/reset post

post

/interface/macvlan/set post

post

/interface/mesh get put

get

put

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

admin-mac: (any)
arp: (any)
arp-timeout: (any)
auto-mac: (any)
comment: (any)
copy-from: (any)
disabled: (any)
hwmp-default-hoplimit: (any)
hwmp-prep-lifetime: (any)
hwmp-preq-destination-only: (any)
hwmp-preq-reply-and-forward: (any)
hwmp-preq-retries: (any)
hwmp-preq-waiting-time: (any)
hwmp-rann-interval: (any)
hwmp-rann-lifetime: (any)
hwmp-rann-propagation-delay: (any)
mesh-portal: (any)
mtu: (any)
name: (any)
reoptimize-paths: (any)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/mesh/add post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

admin-mac: (any)
arp: (any)
arp-timeout: (any)
auto-mac: (any)
comment: (any)
copy-from: (any)
disabled: (any)
hwmp-default-hoplimit: (any)
hwmp-prep-lifetime: (any)
hwmp-preq-destination-only: (any)
hwmp-preq-reply-and-forward: (any)
hwmp-preq-retries: (any)
hwmp-preq-waiting-time: (any)
hwmp-rann-interval: (any)
hwmp-rann-lifetime: (any)
hwmp-rann-propagation-delay: (any)
mesh-portal: (any)
mtu: (any)
name: (any)
reoptimize-paths: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/mesh/fdb/print post

post

/interface/mesh/{id} get delete patch

get

delete

patch

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

URI Parameters

id: required(string)

Body

Media type: application/json

Type: object

Properties

admin-mac: (any)
arp: (any)
arp-timeout: (any)
auto-mac: (any)
comment: (any)
disabled: (any)
hwmp-default-hoplimit: (any)
hwmp-prep-lifetime: (any)
hwmp-preq-destination-only: (any)
hwmp-preq-reply-and-forward: (any)
hwmp-preq-retries: (any)
hwmp-preq-waiting-time: (any)
hwmp-rann-interval: (any)
hwmp-rann-lifetime: (any)
hwmp-rann-propagation-delay: (any)
mesh-portal: (any)
mtu: (any)
name: (any)
numbers: (any)
reoptimize-paths: (any)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/mesh/port get put

get

put

/interface/mesh/port/add post

post

/interface/mesh/port/{id} get delete patch

get

delete

patch

/interface/mesh/port/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
stats: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/mesh/port/reset post

post

/interface/mesh/port/set post

post

/interface/mesh/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/mesh/reset post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

admin-mac: (any)
arp: (any)
arp-timeout: (any)
auto-mac: (any)
comment: (any)
disabled: (any)
hwmp-default-hoplimit: (any)
hwmp-prep-lifetime: (any)
hwmp-preq-destination-only: (any)
hwmp-preq-reply-and-forward: (any)
hwmp-preq-retries: (any)
hwmp-preq-waiting-time: (any)
hwmp-rann-interval: (any)
hwmp-rann-lifetime: (any)
hwmp-rann-propagation-delay: (any)
mesh-portal: (any)
mtu: (any)
name: (any)
numbers: (any)
reoptimize-paths: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/mesh/set post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

admin-mac: (any)
arp: (any)
arp-timeout: (any)
auto-mac: (any)
comment: (any)
disabled: (any)
hwmp-default-hoplimit: (any)
hwmp-prep-lifetime: (any)
hwmp-preq-destination-only: (any)
hwmp-preq-reply-and-forward: (any)
hwmp-preq-retries: (any)
hwmp-preq-waiting-time: (any)
hwmp-rann-interval: (any)
hwmp-rann-lifetime: (any)
hwmp-rann-propagation-delay: (any)
mesh-portal: (any)
mtu: (any)
name: (any)
numbers: (any)
reoptimize-paths: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/mesh/traceroute post

post

/interface/monitor-traffic post

post

/interface/ovpn-client get put

get

put

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

add-default-route: (any)
auth: (any)
certificate: (any)
cipher: (any)
comment: (any)
connect-to: (any)
copy-from: (any)
disabled: (any)
disconnect-notify: (any)
mac-address: (any)
max-mtu: (any)
mode: (any)
name: (any)
password: (any)
port: (any)
profile: (any)
protocol: (any)
route-nopull: (any)
tls-version: (any)
use-peer-dns: (any)
user: (any)
verify-server-certificate: (any)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/ovpn-client/add post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

add-default-route: (any)
auth: (any)
certificate: (any)
cipher: (any)
comment: (any)
connect-to: (any)
copy-from: (any)
disabled: (any)
disconnect-notify: (any)
mac-address: (any)
max-mtu: (any)
mode: (any)
name: (any)
password: (any)
port: (any)
profile: (any)
protocol: (any)
route-nopull: (any)
tls-version: (any)
use-peer-dns: (any)
user: (any)
verify-server-certificate: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/ovpn-client/{id} get delete patch

get

delete

patch

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

URI Parameters

id: required(string)

Body

Media type: application/json

Type: object

Properties

add-default-route: (any)
auth: (any)
certificate: (any)
cipher: (any)
comment: (any)
connect-to: (any)
disabled: (any)
disconnect-notify: (any)
mac-address: (any)
max-mtu: (any)
mode: (any)
name: (any)
numbers: (any)
password: (any)
port: (any)
profile: (any)
protocol: (any)
route-nopull: (any)
tls-version: (any)
use-peer-dns: (any)
user: (any)
verify-server-certificate: (any)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/ovpn-client/import-ovpn-configuration post

post

/interface/ovpn-client/monitor post

post

/interface/ovpn-client/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/ovpn-client/reset post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

add-default-route: (any)
auth: (any)
certificate: (any)
cipher: (any)
comment: (any)
connect-to: (any)
disabled: (any)
disconnect-notify: (any)
mac-address: (any)
max-mtu: (any)
mode: (any)
name: (any)
numbers: (any)
password: (any)
port: (any)
profile: (any)
protocol: (any)
route-nopull: (any)
tls-version: (any)
use-peer-dns: (any)
user: (any)
verify-server-certificate: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/ovpn-client/set post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

add-default-route: (any)
auth: (any)
certificate: (any)
cipher: (any)
comment: (any)
connect-to: (any)
disabled: (any)
disconnect-notify: (any)
mac-address: (any)
max-mtu: (any)
mode: (any)
name: (any)
numbers: (any)
password: (any)
port: (any)
profile: (any)
protocol: (any)
route-nopull: (any)
tls-version: (any)
use-peer-dns: (any)
user: (any)
verify-server-certificate: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/ovpn-server get put

get

put

/interface/ovpn-server/{id} get delete patch

get

delete

patch

/interface/ovpn-server/monitor post

post

/interface/ovpn-server/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/ovpn-server/server/export-client-configuration post

post

/interface/ovpn-server/server/{id} get patch

get

patch

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

URI Parameters

id: required(string)

Body

Media type: application/json

Type: object

Properties

auth: (any)
certificate: (any)
cipher: (any)
default-profile: (any)
enable-tun-ipv6: (any)
enabled: (any)
ipv6-prefix-len: (any)
keepalive-timeout: (any)
mac-address: (any)
max-mtu: (any)
mode: (any)
netmask: (any)
port: (any)
protocol: (any)
redirect-gateway: (any)
reneg-sec: (any)
require-client-certificate: (any)
tls-version: (any)
tun-server-ipv6: (any)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/ovpn-server/server/set post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

auth: (any)
certificate: (any)
cipher: (any)
default-profile: (any)
enable-tun-ipv6: (any)
enabled: (any)
ipv6-prefix-len: (any)
keepalive-timeout: (any)
mac-address: (any)
max-mtu: (any)
mode: (any)
netmask: (any)
port: (any)
protocol: (any)
redirect-gateway: (any)
reneg-sec: (any)
require-client-certificate: (any)
tls-version: (any)
tun-server-ipv6: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/ppp-client get put

get

put

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

add-default-route: (any)
allow: (any)
apn: (any)
comment: (any)
copy-from: (any)
data-channel: (any)
default-route-distance: (any)
dial-command: (any)
dial-on-demand: (any)
disabled: (any)
info-channel: (any)
keepalive-timeout: (any)
max-mru: (any)
max-mtu: (any)
modem-init: (any)
mrru: (any)
name: (any)
null-modem: (any)
password: (any)
phone: (any)
pin: (any)
port: (any)
profile: (any)
remote-address: (any)
use-peer-dns: (any)
user: (any)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/ppp-client/add post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

add-default-route: (any)
allow: (any)
apn: (any)
comment: (any)
copy-from: (any)
data-channel: (any)
default-route-distance: (any)
dial-command: (any)
dial-on-demand: (any)
disabled: (any)
info-channel: (any)
keepalive-timeout: (any)
max-mru: (any)
max-mtu: (any)
modem-init: (any)
mrru: (any)
name: (any)
null-modem: (any)
password: (any)
phone: (any)
pin: (any)
port: (any)
profile: (any)
remote-address: (any)
use-peer-dns: (any)
user: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/ppp-client/firmware-upgrade post

post

/interface/ppp-client/{id} get delete patch

get

delete

patch

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

URI Parameters

id: required(string)

Body

Media type: application/json

Type: object

Properties

add-default-route: (any)
allow: (any)
apn: (any)
comment: (any)
data-channel: (any)
default-route-distance: (any)
dial-command: (any)
dial-on-demand: (any)
disabled: (any)
info-channel: (any)
keepalive-timeout: (any)
max-mru: (any)
max-mtu: (any)
modem-init: (any)
mrru: (any)
name: (any)
null-modem: (any)
numbers: (any)
password: (any)
phone: (any)
pin: (any)
port: (any)
profile: (any)
remote-address: (any)
use-peer-dns: (any)
user: (any)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/ppp-client/info post

post

/interface/ppp-client/monitor post

post

/interface/ppp-client/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/ppp-client/reset post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

add-default-route: (any)
allow: (any)
apn: (any)
comment: (any)
data-channel: (any)
default-route-distance: (any)
dial-command: (any)
dial-on-demand: (any)
disabled: (any)
info-channel: (any)
keepalive-timeout: (any)
max-mru: (any)
max-mtu: (any)
modem-init: (any)
mrru: (any)
name: (any)
null-modem: (any)
numbers: (any)
password: (any)
phone: (any)
pin: (any)
port: (any)
profile: (any)
remote-address: (any)
use-peer-dns: (any)
user: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/ppp-client/set post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

add-default-route: (any)
allow: (any)
apn: (any)
comment: (any)
data-channel: (any)
default-route-distance: (any)
dial-command: (any)
dial-on-demand: (any)
disabled: (any)
info-channel: (any)
keepalive-timeout: (any)
max-mru: (any)
max-mtu: (any)
modem-init: (any)
mrru: (any)
name: (any)
null-modem: (any)
numbers: (any)
password: (any)
phone: (any)
pin: (any)
port: (any)
profile: (any)
remote-address: (any)
use-peer-dns: (any)
user: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/ppp-server get put

get

put

/interface/ppp-server/add post

post

/interface/ppp-server/{id} get delete patch

get

delete

patch

/interface/ppp-server/monitor post

post

/interface/ppp-server/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/ppp-server/reset post

post

/interface/ppp-server/set post

post

/interface/pppoe-client get put

get

put

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

ac-name: (any)
add-default-route: (any)
allow: (any)
comment: (any)
copy-from: (any)
default-route-distance: (any)
dial-on-demand: (any)
disabled: (any)
host-uniq: (any)
interface: (any)
keepalive-timeout: (any)
max-mru: (any)
max-mtu: (any)
mrru: (any)
name: (any)
password: (any)
profile: (any)
service-name: (any)
use-peer-dns: (any)
user: (any)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/pppoe-client/add post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

ac-name: (any)
add-default-route: (any)
allow: (any)
comment: (any)
copy-from: (any)
default-route-distance: (any)
dial-on-demand: (any)
disabled: (any)
host-uniq: (any)
interface: (any)
keepalive-timeout: (any)
max-mru: (any)
max-mtu: (any)
mrru: (any)
name: (any)
password: (any)
profile: (any)
service-name: (any)
use-peer-dns: (any)
user: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/pppoe-client/{id} get delete patch

get

delete

patch

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

URI Parameters

id: required(string)

Body

Media type: application/json

Type: object

Properties

ac-name: (any)
add-default-route: (any)
allow: (any)
comment: (any)
default-route-distance: (any)
dial-on-demand: (any)
disabled: (any)
host-uniq: (any)
interface: (any)
keepalive-timeout: (any)
max-mru: (any)
max-mtu: (any)
mrru: (any)
name: (any)
numbers: (any)
password: (any)
profile: (any)
service-name: (any)
use-peer-dns: (any)
user: (any)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/pppoe-client/monitor post

post

/interface/pppoe-client/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/pppoe-client/reset post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

ac-name: (any)
add-default-route: (any)
allow: (any)
comment: (any)
default-route-distance: (any)
dial-on-demand: (any)
disabled: (any)
host-uniq: (any)
interface: (any)
keepalive-timeout: (any)
max-mru: (any)
max-mtu: (any)
mrru: (any)
name: (any)
numbers: (any)
password: (any)
profile: (any)
service-name: (any)
use-peer-dns: (any)
user: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/pppoe-client/set post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

ac-name: (any)
add-default-route: (any)
allow: (any)
comment: (any)
default-route-distance: (any)
dial-on-demand: (any)
disabled: (any)
host-uniq: (any)
interface: (any)
keepalive-timeout: (any)
max-mru: (any)
max-mtu: (any)
mrru: (any)
name: (any)
numbers: (any)
password: (any)
profile: (any)
service-name: (any)
use-peer-dns: (any)
user: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/pppoe-server get put

get

put

/interface/pppoe-server/{id} get delete patch

get

delete

patch

/interface/pppoe-server/monitor post

post

/interface/pppoe-server/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/pppoe-server/server get put

get

put

/interface/pppoe-server/server/add post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

accept-empty-service: (any)
authentication: (any)
comment: (any)
copy-from: (any)
default-profile: (any)
disabled: (any)
interface: (any)
keepalive-timeout: (any)
max-mru: (any)
max-mtu: (any)
max-sessions: (any)
mrru: (any)
one-session-per-host: (any)
pado-delay: (any)
service-name: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/pppoe-server/server/{id} get delete patch

get

delete

patch

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

URI Parameters

id: required(string)

Body

Media type: application/json

Type: object

Properties

accept-empty-service: (any)
authentication: (any)
comment: (any)
default-profile: (any)
disabled: (any)
interface: (any)
keepalive-timeout: (any)
max-mru: (any)
max-mtu: (any)
max-sessions: (any)
mrru: (any)
numbers: (any)
one-session-per-host: (any)
pado-delay: (any)
service-name: (any)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/pppoe-server/server/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/pppoe-server/server/reset post

post

/interface/pppoe-server/server/set post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

accept-empty-service: (any)
authentication: (any)
comment: (any)
default-profile: (any)
disabled: (any)
interface: (any)
keepalive-timeout: (any)
max-mru: (any)
max-mtu: (any)
max-sessions: (any)
mrru: (any)
numbers: (any)
one-session-per-host: (any)
pado-delay: (any)
service-name: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/pptp-client get put

get

put

/interface/pptp-client/add post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

add-default-route: (any)
allow: (any)
comment: (any)
connect-to: (any)
copy-from: (any)
default-route-distance: (any)
dial-on-demand: (any)
disabled: (any)
keepalive-timeout: (any)
max-mru: (any)
max-mtu: (any)
mrru: (any)
name: (any)
password: (any)
profile: (any)
use-peer-dns: (any)
user: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/pptp-client/{id} get delete patch

get

delete

patch

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

URI Parameters

id: required(string)

Body

Media type: application/json

Type: object

Properties

add-default-route: (any)
allow: (any)
comment: (any)
connect-to: (any)
default-route-distance: (any)
dial-on-demand: (any)
disabled: (any)
keepalive-timeout: (any)
max-mru: (any)
max-mtu: (any)
mrru: (any)
name: (any)
numbers: (any)
password: (any)
profile: (any)
use-peer-dns: (any)
user: (any)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/pptp-client/monitor post

post

/interface/pptp-client/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/pptp-client/reset post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

add-default-route: (any)
allow: (any)
comment: (any)
connect-to: (any)
default-route-distance: (any)
dial-on-demand: (any)
disabled: (any)
keepalive-timeout: (any)
max-mru: (any)
max-mtu: (any)
mrru: (any)
name: (any)
numbers: (any)
password: (any)
profile: (any)
use-peer-dns: (any)
user: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/pptp-client/set post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

add-default-route: (any)
allow: (any)
comment: (any)
connect-to: (any)
default-route-distance: (any)
dial-on-demand: (any)
disabled: (any)
keepalive-timeout: (any)
max-mru: (any)
max-mtu: (any)
mrru: (any)
name: (any)
numbers: (any)
password: (any)
profile: (any)
use-peer-dns: (any)
user: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/pptp-server get put

get

put

/interface/pptp-server/{id} get delete patch

get

delete

patch

/interface/pptp-server/monitor post

post

/interface/pptp-server/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/pptp-server/server/{id} get patch

get

patch

/interface/pptp-server/server/set post

post

/interface/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
oid: (any)
proplist: (any)
show-ids: (any)
stats: (any)
stats-detail: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/sstp-client get put

get

put

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

add-default-route: (any)
authentication: (any)
certificate: (any)
comment: (any)
connect-to: (any)
copy-from: (any)
default-route-distance: (any)
dial-on-demand: (any)
disabled: (any)
http-proxy: (any)
keepalive-timeout: (any)
max-mru: (any)
max-mtu: (any)
mrru: (any)
name: (any)
password: (any)
pfs: (any)
port: (any)
profile: (any)
proxy-port: (any)
tls-version: (any)
user: (any)
verify-server-address-from-certificate: (any)
verify-server-certificate: (any)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/sstp-client/add post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

add-default-route: (any)
authentication: (any)
certificate: (any)
comment: (any)
connect-to: (any)
copy-from: (any)
default-route-distance: (any)
dial-on-demand: (any)
disabled: (any)
http-proxy: (any)
keepalive-timeout: (any)
max-mru: (any)
max-mtu: (any)
mrru: (any)
name: (any)
password: (any)
pfs: (any)
port: (any)
profile: (any)
proxy-port: (any)
tls-version: (any)
user: (any)
verify-server-address-from-certificate: (any)
verify-server-certificate: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/sstp-client/{id} get delete patch

get

delete

patch

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

URI Parameters

id: required(string)

Body

Media type: application/json

Type: object

Properties

add-default-route: (any)
authentication: (any)
certificate: (any)
comment: (any)
connect-to: (any)
default-route-distance: (any)
dial-on-demand: (any)
disabled: (any)
http-proxy: (any)
keepalive-timeout: (any)
max-mru: (any)
max-mtu: (any)
mrru: (any)
name: (any)
numbers: (any)
password: (any)
pfs: (any)
port: (any)
profile: (any)
proxy-port: (any)
tls-version: (any)
user: (any)
verify-server-address-from-certificate: (any)
verify-server-certificate: (any)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/sstp-client/monitor post

post

/interface/sstp-client/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/sstp-client/reset post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

add-default-route: (any)
authentication: (any)
certificate: (any)
comment: (any)
connect-to: (any)
default-route-distance: (any)
dial-on-demand: (any)
disabled: (any)
http-proxy: (any)
keepalive-timeout: (any)
max-mru: (any)
max-mtu: (any)
mrru: (any)
name: (any)
numbers: (any)
password: (any)
pfs: (any)
port: (any)
profile: (any)
proxy-port: (any)
tls-version: (any)
user: (any)
verify-server-address-from-certificate: (any)
verify-server-certificate: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/sstp-client/set post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

add-default-route: (any)
authentication: (any)
certificate: (any)
comment: (any)
connect-to: (any)
default-route-distance: (any)
dial-on-demand: (any)
disabled: (any)
http-proxy: (any)
keepalive-timeout: (any)
max-mru: (any)
max-mtu: (any)
mrru: (any)
name: (any)
numbers: (any)
password: (any)
pfs: (any)
port: (any)
profile: (any)
proxy-port: (any)
tls-version: (any)
user: (any)
verify-server-address-from-certificate: (any)
verify-server-certificate: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/sstp-server get put

get

put

/interface/sstp-server/{id} get delete patch

get

delete

patch

/interface/sstp-server/monitor post

post

/interface/sstp-server/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/sstp-server/server/{id} get patch

get

patch

/interface/sstp-server/server/set post

post

/interface/veth get put

get

put

/interface/veth/{id} get delete patch

get

delete

patch

/interface/veth/print post

post

/interface/vlan get put

get

put

/interface/vlan/add post

post

/interface/vlan/{id} get delete patch

get

delete

patch

/interface/vlan/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/vlan/reset post

post

/interface/vlan/set post

post

/interface/vpls get put

get

put

/interface/vpls/add post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

arp: (any)
arp-timeout: (any)
bridge: (any)
bridge-cost: (any)
bridge-horizon: (any)
cisco-static-id: (any)
comment: (any)
copy-from: (any)
disable-running-check: (any)
disabled: (any)
mac-address: (any)
mtu: (any)
name: (any)
peer: (any)
pw-control-word: (any)
pw-l2mtu: (any)
pw-type: (any)
vpls-id: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/vpls/{id} get delete patch

get

delete

patch

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

URI Parameters

id: required(string)

Body

Media type: application/json

Type: object

Properties

arp: (any)
arp-timeout: (any)
bridge: (any)
bridge-cost: (any)
bridge-horizon: (any)
cisco-static-id: (any)
comment: (any)
disable-running-check: (any)
disabled: (any)
mac-address: (any)
mtu: (any)
name: (any)
numbers: (any)
peer: (any)
pw-control-word: (any)
pw-l2mtu: (any)
pw-type: (any)
vpls-id: (any)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/vpls/monitor post

post

/interface/vpls/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/vpls/reset post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

arp: (any)
arp-timeout: (any)
bridge: (any)
bridge-cost: (any)
bridge-horizon: (any)
cisco-static-id: (any)
comment: (any)
disable-running-check: (any)
disabled: (any)
mac-address: (any)
mtu: (any)
name: (any)
numbers: (any)
peer: (any)
pw-control-word: (any)
pw-l2mtu: (any)
pw-type: (any)
vpls-id: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/vpls/set post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

arp: (any)
arp-timeout: (any)
bridge: (any)
bridge-cost: (any)
bridge-horizon: (any)
cisco-static-id: (any)
comment: (any)
disable-running-check: (any)
disabled: (any)
mac-address: (any)
mtu: (any)
name: (any)
numbers: (any)
peer: (any)
pw-control-word: (any)
pw-l2mtu: (any)
pw-type: (any)
vpls-id: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/vrrp get put

get

put

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

arp: (any)
arp-timeout: (any)
authentication: (any)
comment: (any)
copy-from: (any)
disabled: (any)
group-authority: (any)
group-master: (any)
interface: (any)
interval: (any)
mtu: (any)
name: (any)
on-backup: (any)
on-fail: (any)
on-master: (any)
password: (any)
preemption-mode: (any)
priority: (any)
remote-address: (any)
sync-connection-tracking: (any)
v3-protocol: (any)
version: (any)
vrid: (any)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/vrrp/add post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

arp: (any)
arp-timeout: (any)
authentication: (any)
comment: (any)
copy-from: (any)
disabled: (any)
group-authority: (any)
group-master: (any)
interface: (any)
interval: (any)
mtu: (any)
name: (any)
on-backup: (any)
on-fail: (any)
on-master: (any)
password: (any)
preemption-mode: (any)
priority: (any)
remote-address: (any)
sync-connection-tracking: (any)
v3-protocol: (any)
version: (any)
vrid: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/vrrp/{id} get delete patch

get

delete

patch

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

URI Parameters

id: required(string)

Body

Media type: application/json

Type: object

Properties

arp: (any)
arp-timeout: (any)
authentication: (any)
comment: (any)
disabled: (any)
group-authority: (any)
group-master: (any)
interface: (any)
interval: (any)
mtu: (any)
name: (any)
numbers: (any)
on-backup: (any)
on-fail: (any)
on-master: (any)
password: (any)
preemption-mode: (any)
priority: (any)
remote-address: (any)
sync-connection-tracking: (any)
v3-protocol: (any)
version: (any)
vrid: (any)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/vrrp/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/vrrp/reset post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

arp: (any)
arp-timeout: (any)
authentication: (any)
comment: (any)
disabled: (any)
group-authority: (any)
group-master: (any)
interface: (any)
interval: (any)
mtu: (any)
name: (any)
numbers: (any)
on-backup: (any)
on-fail: (any)
on-master: (any)
password: (any)
preemption-mode: (any)
priority: (any)
remote-address: (any)
sync-connection-tracking: (any)
v3-protocol: (any)
version: (any)
vrid: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/vrrp/set post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

arp: (any)
arp-timeout: (any)
authentication: (any)
comment: (any)
disabled: (any)
group-authority: (any)
group-master: (any)
interface: (any)
interval: (any)
mtu: (any)
name: (any)
numbers: (any)
on-backup: (any)
on-fail: (any)
on-master: (any)
password: (any)
preemption-mode: (any)
priority: (any)
remote-address: (any)
sync-connection-tracking: (any)
v3-protocol: (any)
version: (any)
vrid: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/vxlan get put

get

put

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

allow-fast-path: (any)
arp: (any)
arp-timeout: (any)
comment: (any)
copy-from: (any)
disabled: (any)
dont-fragment: (any)
group: (any)
interface: (any)
local-address: (any)
loop-protect: (any)
loop-protect-disable-time: (any)
loop-protect-send-interval: (any)
mac-address: (any)
max-fdb-size: (any)
mtu: (any)
name: (any)
port: (any)
vni: (any)
vrf: (any)
vteps-ip-version: (any)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/vxlan/add post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

allow-fast-path: (any)
arp: (any)
arp-timeout: (any)
comment: (any)
copy-from: (any)
disabled: (any)
dont-fragment: (any)
group: (any)
interface: (any)
local-address: (any)
loop-protect: (any)
loop-protect-disable-time: (any)
loop-protect-send-interval: (any)
mac-address: (any)
max-fdb-size: (any)
mtu: (any)
name: (any)
port: (any)
vni: (any)
vrf: (any)
vteps-ip-version: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/vxlan/fdb/print post

post

/interface/vxlan/{id} get delete patch

get

delete

patch

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

URI Parameters

id: required(string)

Body

Media type: application/json

Type: object

Properties

allow-fast-path: (any)
arp: (any)
arp-timeout: (any)
comment: (any)
disabled: (any)
dont-fragment: (any)
group: (any)
interface: (any)
local-address: (any)
loop-protect: (any)
loop-protect-disable-time: (any)
loop-protect-send-interval: (any)
mac-address: (any)
max-fdb-size: (any)
mtu: (any)
name: (any)
numbers: (any)
port: (any)
vni: (any)
vrf: (any)
vteps-ip-version: (any)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/vxlan/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/vxlan/reset post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

allow-fast-path: (any)
arp: (any)
arp-timeout: (any)
comment: (any)
disabled: (any)
dont-fragment: (any)
group: (any)
interface: (any)
local-address: (any)
loop-protect: (any)
loop-protect-disable-time: (any)
loop-protect-send-interval: (any)
mac-address: (any)
max-fdb-size: (any)
mtu: (any)
name: (any)
numbers: (any)
port: (any)
vni: (any)
vrf: (any)
vteps-ip-version: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/vxlan/set post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

allow-fast-path: (any)
arp: (any)
arp-timeout: (any)
comment: (any)
disabled: (any)
dont-fragment: (any)
group: (any)
interface: (any)
local-address: (any)
loop-protect: (any)
loop-protect-disable-time: (any)
loop-protect-send-interval: (any)
mac-address: (any)
max-fdb-size: (any)
mtu: (any)
name: (any)
numbers: (any)
port: (any)
vni: (any)
vrf: (any)
vteps-ip-version: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/vxlan/vteps get put

get

put

/interface/vxlan/vteps/{id} get delete patch

get

delete

patch

/interface/vxlan/vteps/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/wifiwave2 get put

get

put

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

aaa: (any)
aaa.called-format: (any)
aaa.calling-format: (any)
aaa.interim-update: (any)
aaa.mac-caching: (any)
aaa.nas-identifier: (any)
aaa.password-format: (any)
aaa.username-format: (any)
arp: (any)
arp-timeout: (any)
channel: (any)
channel.band: (any)
channel.frequency: (any)
channel.secondary-frequency: (any)
channel.skip-dfs-channels: (any)
channel.width: (any)
comment: (any)
configuration: (any)
configuration.antenna-gain: (any)
configuration.beacon-interval: (any)
configuration.chains: (any)
configuration.country: (any)
configuration.dtim-period: (any)
configuration.hide-ssid: (any)
configuration.manager: (any)
configuration.mode: (any)
configuration.ssid: (any)
configuration.tx-chains: (any)
configuration.tx-power: (any)
copy-from: (any)
datapath: (any)
datapath.bridge: (any)
datapath.bridge-cost: (any)
datapath.bridge-horizon: (any)
datapath.client-isolation: (any)
datapath.interface-list: (any)
datapath.openflow-switch: (any)
datapath.vlan-id: (any)
disable-running-check: (any)
disabled: (any)
interworking: (any)
interworking.3gpp-info: (any)
interworking.authentication-types: (any)
interworking.connection-capabilities: (any)
interworking.domain-names: (any)
interworking.esr: (any)
interworking.hessid: (any)
interworking.hotspot20: (any)
interworking.hotspot20-dgaf: (any)
interworking.internet: (any)
interworking.ipv4-availability: (any)
interworking.ipv6-availability: (any)
interworking.network-type: (any)
interworking.operational-classes: (any)
interworking.operator-names: (any)
interworking.realms: (any)
interworking.roaming-ois: (any)
interworking.uesa: (any)
interworking.venue: (any)
interworking.venue-names: (any)
interworking.wan-at-capacity: (any)
interworking.wan-downlink: (any)
interworking.wan-downlink-load: (any)
interworking.wan-measurement-duration: (any)
interworking.wan-status: (any)
interworking.wan-symmetric: (any)
interworking.wan-uplink: (any)
interworking.wan-uplink-load: (any)
l2mtu: (any)
mac-address: (any)
master-interface: (any)
mtu: (any)
name: (any)
radio-mac: (any)
security: (any)
security.authentication-types: (any)
security.connect-group: (any)
security.connect-priority: (any)
security.dh-groups: (any)
security.disable-pmkid: (any)
security.eap-accounting: (any)
security.eap-anonymous-identity: (any)
security.eap-certificate-mode: (any)
security.eap-methods: (any)
security.eap-password: (any)
security.eap-tls-certificate: (any)
security.eap-username: (any)
security.encryption: (any)
security.ft: (any)
security.ft-mobility-domain: (any)
security.ft-nas-identifier: (any)
security.ft-over-ds: (any)
security.ft-preserve-vlanid: (any)
security.ft-r0-key-lifetime: (any)
security.ft-reassociation-deadline: (any)
security.group-encryption: (any)
security.group-key-update: (any)
security.management-encryption: (any)
security.management-protection: (any)
security.owe-transition-interface: (any)
security.passphrase: (any)
security.sae-anti-clogging-threshold: (any)
security.sae-max-failure-rate: (any)
security.sae-pwe: (any)
security.wps: (any)
steering: (any)
steering.neighbor-group: (any)
steering.rrm: (any)
steering.wnm: (any)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/wifiwave2/aaa get put

get

put

/interface/wifiwave2/aaa/add post

post

/interface/wifiwave2/aaa/{id} get delete patch

get

delete

patch

/interface/wifiwave2/aaa/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/wifiwave2/aaa/reset post

post

/interface/wifiwave2/aaa/set post

post

/interface/wifiwave2/access-list get put

get

put

/interface/wifiwave2/access-list/add post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

action: (any)
allow-signal-out-of-range: (any)
client-isolation: (any)
comment: (any)
copy-from: (any)
disabled: (any)
interface: (any)
mac-address: (any)
mac-address-mask: (any)
passphrase: (any)
place-before: (any)
radius-accounting: (any)
signal-range: (any)
ssid-regexp: (any)
time: (any)
vlan-id: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/wifiwave2/access-list/{id} get delete patch

get

delete

patch

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

URI Parameters

id: required(string)

Body

Media type: application/json

Type: object

Properties

action: (any)
allow-signal-out-of-range: (any)
client-isolation: (any)
comment: (any)
disabled: (any)
interface: (any)
mac-address: (any)
mac-address-mask: (any)
numbers: (any)
passphrase: (any)
radius-accounting: (any)
signal-range: (any)
ssid-regexp: (any)
time: (any)
vlan-id: (any)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/wifiwave2/access-list/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/wifiwave2/access-list/reset post

post

/interface/wifiwave2/access-list/set post

post

/interface/wifiwave2/actual-configuration/{id} get patch

get

patch

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

URI Parameters

id: required(string)

Body

Media type: application/json

Type: object

Properties

aaa.called-format: (any)
aaa.calling-format: (any)
aaa.interim-update: (any)
aaa.mac-caching: (any)
aaa.nas-identifier: (any)
aaa.password-format: (any)
aaa.username-format: (any)
arp: (any)
arp-timeout: (any)
channel.band: (any)
channel.frequency: (any)
channel.secondary-frequency: (any)
channel.skip-dfs-channels: (any)
channel.width: (any)
comment: (any)
configuration.antenna-gain: (any)
configuration.beacon-interval: (any)
configuration.chains: (any)
configuration.country: (any)
configuration.dtim-period: (any)
configuration.hide-ssid: (any)
configuration.manager: (any)
configuration.mode: (any)
configuration.ssid: (any)
configuration.tx-chains: (any)
configuration.tx-power: (any)
datapath.bridge: (any)
datapath.bridge-cost: (any)
datapath.bridge-horizon: (any)
datapath.client-isolation: (any)
datapath.interface-list: (any)
datapath.openflow-switch: (any)
datapath.vlan-id: (any)
disable-running-check: (any)
interworking.3gpp-info: (any)
interworking.authentication-types: (any)
interworking.connection-capabilities: (any)
interworking.domain-names: (any)
interworking.esr: (any)
interworking.hessid: (any)
interworking.hotspot20: (any)
interworking.hotspot20-dgaf: (any)
interworking.internet: (any)
interworking.ipv4-availability: (any)
interworking.ipv6-availability: (any)
interworking.network-type: (any)
interworking.operational-classes: (any)
interworking.operator-names: (any)
interworking.realms: (any)
interworking.roaming-ois: (any)
interworking.uesa: (any)
interworking.venue: (any)
interworking.venue-names: (any)
interworking.wan-at-capacity: (any)
interworking.wan-downlink: (any)
interworking.wan-downlink-load: (any)
interworking.wan-measurement-duration: (any)
interworking.wan-status: (any)
interworking.wan-symmetric: (any)
interworking.wan-uplink: (any)
interworking.wan-uplink-load: (any)
l2mtu: (any)
mac-address: (any)
master-interface: (any)
mtu: (any)
name: (any)
numbers: (any)
radio-mac: (any)
security.authentication-types: (any)
security.connect-group: (any)
security.connect-priority: (any)
security.dh-groups: (any)
security.disable-pmkid: (any)
security.eap-accounting: (any)
security.eap-anonymous-identity: (any)
security.eap-certificate-mode: (any)
security.eap-methods: (any)
security.eap-password: (any)
security.eap-tls-certificate: (any)
security.eap-username: (any)
security.encryption: (any)
security.ft: (any)
security.ft-mobility-domain: (any)
security.ft-nas-identifier: (any)
security.ft-over-ds: (any)
security.ft-preserve-vlanid: (any)
security.ft-r0-key-lifetime: (any)
security.ft-reassociation-deadline: (any)
security.group-encryption: (any)
security.group-key-update: (any)
security.management-encryption: (any)
security.management-protection: (any)
security.owe-transition-interface: (any)
security.passphrase: (any)
security.sae-anti-clogging-threshold: (any)
security.sae-max-failure-rate: (any)
security.sae-pwe: (any)
security.wps: (any)
steering.neighbor-group: (any)
steering.rrm: (any)
steering.wnm: (any)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/wifiwave2/actual-configuration/print post

post

/interface/wifiwave2/actual-configuration/reset post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

aaa.called-format: (any)
aaa.calling-format: (any)
aaa.interim-update: (any)
aaa.mac-caching: (any)
aaa.nas-identifier: (any)
aaa.password-format: (any)
aaa.username-format: (any)
arp: (any)
arp-timeout: (any)
channel.band: (any)
channel.frequency: (any)
channel.secondary-frequency: (any)
channel.skip-dfs-channels: (any)
channel.width: (any)
comment: (any)
configuration.antenna-gain: (any)
configuration.beacon-interval: (any)
configuration.chains: (any)
configuration.country: (any)
configuration.dtim-period: (any)
configuration.hide-ssid: (any)
configuration.manager: (any)
configuration.mode: (any)
configuration.ssid: (any)
configuration.tx-chains: (any)
configuration.tx-power: (any)
datapath.bridge: (any)
datapath.bridge-cost: (any)
datapath.bridge-horizon: (any)
datapath.client-isolation: (any)
datapath.interface-list: (any)
datapath.openflow-switch: (any)
datapath.vlan-id: (any)
disable-running-check: (any)
interworking.3gpp-info: (any)
interworking.authentication-types: (any)
interworking.connection-capabilities: (any)
interworking.domain-names: (any)
interworking.esr: (any)
interworking.hessid: (any)
interworking.hotspot20: (any)
interworking.hotspot20-dgaf: (any)
interworking.internet: (any)
interworking.ipv4-availability: (any)
interworking.ipv6-availability: (any)
interworking.network-type: (any)
interworking.operational-classes: (any)
interworking.operator-names: (any)
interworking.realms: (any)
interworking.roaming-ois: (any)
interworking.uesa: (any)
interworking.venue: (any)
interworking.venue-names: (any)
interworking.wan-at-capacity: (any)
interworking.wan-downlink: (any)
interworking.wan-downlink-load: (any)
interworking.wan-measurement-duration: (any)
interworking.wan-status: (any)
interworking.wan-symmetric: (any)
interworking.wan-uplink: (any)
interworking.wan-uplink-load: (any)
l2mtu: (any)
mac-address: (any)
master-interface: (any)
mtu: (any)
name: (any)
numbers: (any)
radio-mac: (any)
security.authentication-types: (any)
security.connect-group: (any)
security.connect-priority: (any)
security.dh-groups: (any)
security.disable-pmkid: (any)
security.eap-accounting: (any)
security.eap-anonymous-identity: (any)
security.eap-certificate-mode: (any)
security.eap-methods: (any)
security.eap-password: (any)
security.eap-tls-certificate: (any)
security.eap-username: (any)
security.encryption: (any)
security.ft: (any)
security.ft-mobility-domain: (any)
security.ft-nas-identifier: (any)
security.ft-over-ds: (any)
security.ft-preserve-vlanid: (any)
security.ft-r0-key-lifetime: (any)
security.ft-reassociation-deadline: (any)
security.group-encryption: (any)
security.group-key-update: (any)
security.management-encryption: (any)
security.management-protection: (any)
security.owe-transition-interface: (any)
security.passphrase: (any)
security.sae-anti-clogging-threshold: (any)
security.sae-max-failure-rate: (any)
security.sae-pwe: (any)
security.wps: (any)
steering.neighbor-group: (any)
steering.rrm: (any)
steering.wnm: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/wifiwave2/actual-configuration/set post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

aaa.called-format: (any)
aaa.calling-format: (any)
aaa.interim-update: (any)
aaa.mac-caching: (any)
aaa.nas-identifier: (any)
aaa.password-format: (any)
aaa.username-format: (any)
arp: (any)
arp-timeout: (any)
channel.band: (any)
channel.frequency: (any)
channel.secondary-frequency: (any)
channel.skip-dfs-channels: (any)
channel.width: (any)
comment: (any)
configuration.antenna-gain: (any)
configuration.beacon-interval: (any)
configuration.chains: (any)
configuration.country: (any)
configuration.dtim-period: (any)
configuration.hide-ssid: (any)
configuration.manager: (any)
configuration.mode: (any)
configuration.ssid: (any)
configuration.tx-chains: (any)
configuration.tx-power: (any)
datapath.bridge: (any)
datapath.bridge-cost: (any)
datapath.bridge-horizon: (any)
datapath.client-isolation: (any)
datapath.interface-list: (any)
datapath.openflow-switch: (any)
datapath.vlan-id: (any)
disable-running-check: (any)
interworking.3gpp-info: (any)
interworking.authentication-types: (any)
interworking.connection-capabilities: (any)
interworking.domain-names: (any)
interworking.esr: (any)
interworking.hessid: (any)
interworking.hotspot20: (any)
interworking.hotspot20-dgaf: (any)
interworking.internet: (any)
interworking.ipv4-availability: (any)
interworking.ipv6-availability: (any)
interworking.network-type: (any)
interworking.operational-classes: (any)
interworking.operator-names: (any)
interworking.realms: (any)
interworking.roaming-ois: (any)
interworking.uesa: (any)
interworking.venue: (any)
interworking.venue-names: (any)
interworking.wan-at-capacity: (any)
interworking.wan-downlink: (any)
interworking.wan-downlink-load: (any)
interworking.wan-measurement-duration: (any)
interworking.wan-status: (any)
interworking.wan-symmetric: (any)
interworking.wan-uplink: (any)
interworking.wan-uplink-load: (any)
l2mtu: (any)
mac-address: (any)
master-interface: (any)
mtu: (any)
name: (any)
numbers: (any)
radio-mac: (any)
security.authentication-types: (any)
security.connect-group: (any)
security.connect-priority: (any)
security.dh-groups: (any)
security.disable-pmkid: (any)
security.eap-accounting: (any)
security.eap-anonymous-identity: (any)
security.eap-certificate-mode: (any)
security.eap-methods: (any)
security.eap-password: (any)
security.eap-tls-certificate: (any)
security.eap-username: (any)
security.encryption: (any)
security.ft: (any)
security.ft-mobility-domain: (any)
security.ft-nas-identifier: (any)
security.ft-over-ds: (any)
security.ft-preserve-vlanid: (any)
security.ft-r0-key-lifetime: (any)
security.ft-reassociation-deadline: (any)
security.group-encryption: (any)
security.group-key-update: (any)
security.management-encryption: (any)
security.management-protection: (any)
security.owe-transition-interface: (any)
security.passphrase: (any)
security.sae-anti-clogging-threshold: (any)
security.sae-max-failure-rate: (any)
security.sae-pwe: (any)
security.wps: (any)
steering.neighbor-group: (any)
steering.rrm: (any)
steering.wnm: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/wifiwave2/add post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

aaa: (any)
aaa.called-format: (any)
aaa.calling-format: (any)
aaa.interim-update: (any)
aaa.mac-caching: (any)
aaa.nas-identifier: (any)
aaa.password-format: (any)
aaa.username-format: (any)
arp: (any)
arp-timeout: (any)
channel: (any)
channel.band: (any)
channel.frequency: (any)
channel.secondary-frequency: (any)
channel.skip-dfs-channels: (any)
channel.width: (any)
comment: (any)
configuration: (any)
configuration.antenna-gain: (any)
configuration.beacon-interval: (any)
configuration.chains: (any)
configuration.country: (any)
configuration.dtim-period: (any)
configuration.hide-ssid: (any)
configuration.manager: (any)
configuration.mode: (any)
configuration.ssid: (any)
configuration.tx-chains: (any)
configuration.tx-power: (any)
copy-from: (any)
datapath: (any)
datapath.bridge: (any)
datapath.bridge-cost: (any)
datapath.bridge-horizon: (any)
datapath.client-isolation: (any)
datapath.interface-list: (any)
datapath.openflow-switch: (any)
datapath.vlan-id: (any)
disable-running-check: (any)
disabled: (any)
interworking: (any)
interworking.3gpp-info: (any)
interworking.authentication-types: (any)
interworking.connection-capabilities: (any)
interworking.domain-names: (any)
interworking.esr: (any)
interworking.hessid: (any)
interworking.hotspot20: (any)
interworking.hotspot20-dgaf: (any)
interworking.internet: (any)
interworking.ipv4-availability: (any)
interworking.ipv6-availability: (any)
interworking.network-type: (any)
interworking.operational-classes: (any)
interworking.operator-names: (any)
interworking.realms: (any)
interworking.roaming-ois: (any)
interworking.uesa: (any)
interworking.venue: (any)
interworking.venue-names: (any)
interworking.wan-at-capacity: (any)
interworking.wan-downlink: (any)
interworking.wan-downlink-load: (any)
interworking.wan-measurement-duration: (any)
interworking.wan-status: (any)
interworking.wan-symmetric: (any)
interworking.wan-uplink: (any)
interworking.wan-uplink-load: (any)
l2mtu: (any)
mac-address: (any)
master-interface: (any)
mtu: (any)
name: (any)
radio-mac: (any)
security: (any)
security.authentication-types: (any)
security.connect-group: (any)
security.connect-priority: (any)
security.dh-groups: (any)
security.disable-pmkid: (any)
security.eap-accounting: (any)
security.eap-anonymous-identity: (any)
security.eap-certificate-mode: (any)
security.eap-methods: (any)
security.eap-password: (any)
security.eap-tls-certificate: (any)
security.eap-username: (any)
security.encryption: (any)
security.ft: (any)
security.ft-mobility-domain: (any)
security.ft-nas-identifier: (any)
security.ft-over-ds: (any)
security.ft-preserve-vlanid: (any)
security.ft-r0-key-lifetime: (any)
security.ft-reassociation-deadline: (any)
security.group-encryption: (any)
security.group-key-update: (any)
security.management-encryption: (any)
security.management-protection: (any)
security.owe-transition-interface: (any)
security.passphrase: (any)
security.sae-anti-clogging-threshold: (any)
security.sae-max-failure-rate: (any)
security.sae-pwe: (any)
security.wps: (any)
steering: (any)
steering.neighbor-group: (any)
steering.rrm: (any)
steering.wnm: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/wifiwave2/cap/{id} get patch

get

patch

/interface/wifiwave2/cap/set post

post

/interface/wifiwave2/capsman/{id} get patch

get

patch

/interface/wifiwave2/capsman/remote-cap/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/wifiwave2/capsman/set post

post

/interface/wifiwave2/channel get put

get

put

/interface/wifiwave2/channel/add post

post

/interface/wifiwave2/channel/{id} get delete patch

get

delete

patch

/interface/wifiwave2/channel/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/wifiwave2/channel/reset post

post

/interface/wifiwave2/channel/set post

post

/interface/wifiwave2/configuration get put

get

put

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

aaa: (any)
aaa.called-format: (any)
aaa.calling-format: (any)
aaa.interim-update: (any)
aaa.mac-caching: (any)
aaa.nas-identifier: (any)
aaa.password-format: (any)
aaa.username-format: (any)
antenna-gain: (any)
beacon-interval: (any)
chains: (any)
channel: (any)
channel.band: (any)
channel.frequency: (any)
channel.secondary-frequency: (any)
channel.skip-dfs-channels: (any)
channel.width: (any)
comment: (any)
copy-from: (any)
country: (any)
datapath: (any)
datapath.bridge: (any)
datapath.bridge-cost: (any)
datapath.bridge-horizon: (any)
datapath.client-isolation: (any)
datapath.interface-list: (any)
datapath.openflow-switch: (any)
datapath.vlan-id: (any)
disabled: (any)
dtim-period: (any)
hide-ssid: (any)
interworking: (any)
interworking.3gpp-info: (any)
interworking.authentication-types: (any)
interworking.connection-capabilities: (any)
interworking.domain-names: (any)
interworking.esr: (any)
interworking.hessid: (any)
interworking.hotspot20: (any)
interworking.hotspot20-dgaf: (any)
interworking.internet: (any)
interworking.ipv4-availability: (any)
interworking.ipv6-availability: (any)
interworking.network-type: (any)
interworking.operational-classes: (any)
interworking.operator-names: (any)
interworking.realms: (any)
interworking.roaming-ois: (any)
interworking.uesa: (any)
interworking.venue: (any)
interworking.venue-names: (any)
interworking.wan-at-capacity: (any)
interworking.wan-downlink: (any)
interworking.wan-downlink-load: (any)
interworking.wan-measurement-duration: (any)
interworking.wan-status: (any)
interworking.wan-symmetric: (any)
interworking.wan-uplink: (any)
interworking.wan-uplink-load: (any)
manager: (any)
mode: (any)
name: (any)
security: (any)
security.authentication-types: (any)
security.connect-group: (any)
security.connect-priority: (any)
security.dh-groups: (any)
security.disable-pmkid: (any)
security.eap-accounting: (any)
security.eap-anonymous-identity: (any)
security.eap-certificate-mode: (any)
security.eap-methods: (any)
security.eap-password: (any)
security.eap-tls-certificate: (any)
security.eap-username: (any)
security.encryption: (any)
security.ft: (any)
security.ft-mobility-domain: (any)
security.ft-nas-identifier: (any)
security.ft-over-ds: (any)
security.ft-preserve-vlanid: (any)
security.ft-r0-key-lifetime: (any)
security.ft-reassociation-deadline: (any)
security.group-encryption: (any)
security.group-key-update: (any)
security.management-encryption: (any)
security.management-protection: (any)
security.owe-transition-interface: (any)
security.passphrase: (any)
security.sae-anti-clogging-threshold: (any)
security.sae-max-failure-rate: (any)
security.sae-pwe: (any)
security.wps: (any)
ssid: (any)
steering: (any)
steering.neighbor-group: (any)
steering.rrm: (any)
steering.wnm: (any)
tx-chains: (any)
tx-power: (any)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/wifiwave2/configuration/add post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

aaa: (any)
aaa.called-format: (any)
aaa.calling-format: (any)
aaa.interim-update: (any)
aaa.mac-caching: (any)
aaa.nas-identifier: (any)
aaa.password-format: (any)
aaa.username-format: (any)
antenna-gain: (any)
beacon-interval: (any)
chains: (any)
channel: (any)
channel.band: (any)
channel.frequency: (any)
channel.secondary-frequency: (any)
channel.skip-dfs-channels: (any)
channel.width: (any)
comment: (any)
copy-from: (any)
country: (any)
datapath: (any)
datapath.bridge: (any)
datapath.bridge-cost: (any)
datapath.bridge-horizon: (any)
datapath.client-isolation: (any)
datapath.interface-list: (any)
datapath.openflow-switch: (any)
datapath.vlan-id: (any)
disabled: (any)
dtim-period: (any)
hide-ssid: (any)
interworking: (any)
interworking.3gpp-info: (any)
interworking.authentication-types: (any)
interworking.connection-capabilities: (any)
interworking.domain-names: (any)
interworking.esr: (any)
interworking.hessid: (any)
interworking.hotspot20: (any)
interworking.hotspot20-dgaf: (any)
interworking.internet: (any)
interworking.ipv4-availability: (any)
interworking.ipv6-availability: (any)
interworking.network-type: (any)
interworking.operational-classes: (any)
interworking.operator-names: (any)
interworking.realms: (any)
interworking.roaming-ois: (any)
interworking.uesa: (any)
interworking.venue: (any)
interworking.venue-names: (any)
interworking.wan-at-capacity: (any)
interworking.wan-downlink: (any)
interworking.wan-downlink-load: (any)
interworking.wan-measurement-duration: (any)
interworking.wan-status: (any)
interworking.wan-symmetric: (any)
interworking.wan-uplink: (any)
interworking.wan-uplink-load: (any)
manager: (any)
mode: (any)
name: (any)
security: (any)
security.authentication-types: (any)
security.connect-group: (any)
security.connect-priority: (any)
security.dh-groups: (any)
security.disable-pmkid: (any)
security.eap-accounting: (any)
security.eap-anonymous-identity: (any)
security.eap-certificate-mode: (any)
security.eap-methods: (any)
security.eap-password: (any)
security.eap-tls-certificate: (any)
security.eap-username: (any)
security.encryption: (any)
security.ft: (any)
security.ft-mobility-domain: (any)
security.ft-nas-identifier: (any)
security.ft-over-ds: (any)
security.ft-preserve-vlanid: (any)
security.ft-r0-key-lifetime: (any)
security.ft-reassociation-deadline: (any)
security.group-encryption: (any)
security.group-key-update: (any)
security.management-encryption: (any)
security.management-protection: (any)
security.owe-transition-interface: (any)
security.passphrase: (any)
security.sae-anti-clogging-threshold: (any)
security.sae-max-failure-rate: (any)
security.sae-pwe: (any)
security.wps: (any)
ssid: (any)
steering: (any)
steering.neighbor-group: (any)
steering.rrm: (any)
steering.wnm: (any)
tx-chains: (any)
tx-power: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/wifiwave2/configuration/{id} get delete patch

get

delete

patch

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

URI Parameters

id: required(string)

Body

Media type: application/json

Type: object

Properties

aaa: (any)
aaa.called-format: (any)
aaa.calling-format: (any)
aaa.interim-update: (any)
aaa.mac-caching: (any)
aaa.nas-identifier: (any)
aaa.password-format: (any)
aaa.username-format: (any)
antenna-gain: (any)
beacon-interval: (any)
chains: (any)
channel: (any)
channel.band: (any)
channel.frequency: (any)
channel.secondary-frequency: (any)
channel.skip-dfs-channels: (any)
channel.width: (any)
comment: (any)
country: (any)
datapath: (any)
datapath.bridge: (any)
datapath.bridge-cost: (any)
datapath.bridge-horizon: (any)
datapath.client-isolation: (any)
datapath.interface-list: (any)
datapath.openflow-switch: (any)
datapath.vlan-id: (any)
disabled: (any)
dtim-period: (any)
hide-ssid: (any)
interworking: (any)
interworking.3gpp-info: (any)
interworking.authentication-types: (any)
interworking.connection-capabilities: (any)
interworking.domain-names: (any)
interworking.esr: (any)
interworking.hessid: (any)
interworking.hotspot20: (any)
interworking.hotspot20-dgaf: (any)
interworking.internet: (any)
interworking.ipv4-availability: (any)
interworking.ipv6-availability: (any)
interworking.network-type: (any)
interworking.operational-classes: (any)
interworking.operator-names: (any)
interworking.realms: (any)
interworking.roaming-ois: (any)
interworking.uesa: (any)
interworking.venue: (any)
interworking.venue-names: (any)
interworking.wan-at-capacity: (any)
interworking.wan-downlink: (any)
interworking.wan-downlink-load: (any)
interworking.wan-measurement-duration: (any)
interworking.wan-status: (any)
interworking.wan-symmetric: (any)
interworking.wan-uplink: (any)
interworking.wan-uplink-load: (any)
manager: (any)
mode: (any)
name: (any)
numbers: (any)
security: (any)
security.authentication-types: (any)
security.connect-group: (any)
security.connect-priority: (any)
security.dh-groups: (any)
security.disable-pmkid: (any)
security.eap-accounting: (any)
security.eap-anonymous-identity: (any)
security.eap-certificate-mode: (any)
security.eap-methods: (any)
security.eap-password: (any)
security.eap-tls-certificate: (any)
security.eap-username: (any)
security.encryption: (any)
security.ft: (any)
security.ft-mobility-domain: (any)
security.ft-nas-identifier: (any)
security.ft-over-ds: (any)
security.ft-preserve-vlanid: (any)
security.ft-r0-key-lifetime: (any)
security.ft-reassociation-deadline: (any)
security.group-encryption: (any)
security.group-key-update: (any)
security.management-encryption: (any)
security.management-protection: (any)
security.owe-transition-interface: (any)
security.passphrase: (any)
security.sae-anti-clogging-threshold: (any)
security.sae-max-failure-rate: (any)
security.sae-pwe: (any)
security.wps: (any)
ssid: (any)
steering: (any)
steering.neighbor-group: (any)
steering.rrm: (any)
steering.wnm: (any)
tx-chains: (any)
tx-power: (any)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/wifiwave2/configuration/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/wifiwave2/configuration/reset post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

aaa: (any)
aaa.called-format: (any)
aaa.calling-format: (any)
aaa.interim-update: (any)
aaa.mac-caching: (any)
aaa.nas-identifier: (any)
aaa.password-format: (any)
aaa.username-format: (any)
antenna-gain: (any)
beacon-interval: (any)
chains: (any)
channel: (any)
channel.band: (any)
channel.frequency: (any)
channel.secondary-frequency: (any)
channel.skip-dfs-channels: (any)
channel.width: (any)
comment: (any)
country: (any)
datapath: (any)
datapath.bridge: (any)
datapath.bridge-cost: (any)
datapath.bridge-horizon: (any)
datapath.client-isolation: (any)
datapath.interface-list: (any)
datapath.openflow-switch: (any)
datapath.vlan-id: (any)
disabled: (any)
dtim-period: (any)
hide-ssid: (any)
interworking: (any)
interworking.3gpp-info: (any)
interworking.authentication-types: (any)
interworking.connection-capabilities: (any)
interworking.domain-names: (any)
interworking.esr: (any)
interworking.hessid: (any)
interworking.hotspot20: (any)
interworking.hotspot20-dgaf: (any)
interworking.internet: (any)
interworking.ipv4-availability: (any)
interworking.ipv6-availability: (any)
interworking.network-type: (any)
interworking.operational-classes: (any)
interworking.operator-names: (any)
interworking.realms: (any)
interworking.roaming-ois: (any)
interworking.uesa: (any)
interworking.venue: (any)
interworking.venue-names: (any)
interworking.wan-at-capacity: (any)
interworking.wan-downlink: (any)
interworking.wan-downlink-load: (any)
interworking.wan-measurement-duration: (any)
interworking.wan-status: (any)
interworking.wan-symmetric: (any)
interworking.wan-uplink: (any)
interworking.wan-uplink-load: (any)
manager: (any)
mode: (any)
name: (any)
numbers: (any)
security: (any)
security.authentication-types: (any)
security.connect-group: (any)
security.connect-priority: (any)
security.dh-groups: (any)
security.disable-pmkid: (any)
security.eap-accounting: (any)
security.eap-anonymous-identity: (any)
security.eap-certificate-mode: (any)
security.eap-methods: (any)
security.eap-password: (any)
security.eap-tls-certificate: (any)
security.eap-username: (any)
security.encryption: (any)
security.ft: (any)
security.ft-mobility-domain: (any)
security.ft-nas-identifier: (any)
security.ft-over-ds: (any)
security.ft-preserve-vlanid: (any)
security.ft-r0-key-lifetime: (any)
security.ft-reassociation-deadline: (any)
security.group-encryption: (any)
security.group-key-update: (any)
security.management-encryption: (any)
security.management-protection: (any)
security.owe-transition-interface: (any)
security.passphrase: (any)
security.sae-anti-clogging-threshold: (any)
security.sae-max-failure-rate: (any)
security.sae-pwe: (any)
security.wps: (any)
ssid: (any)
steering: (any)
steering.neighbor-group: (any)
steering.rrm: (any)
steering.wnm: (any)
tx-chains: (any)
tx-power: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/wifiwave2/configuration/set post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

aaa: (any)
aaa.called-format: (any)
aaa.calling-format: (any)
aaa.interim-update: (any)
aaa.mac-caching: (any)
aaa.nas-identifier: (any)
aaa.password-format: (any)
aaa.username-format: (any)
antenna-gain: (any)
beacon-interval: (any)
chains: (any)
channel: (any)
channel.band: (any)
channel.frequency: (any)
channel.secondary-frequency: (any)
channel.skip-dfs-channels: (any)
channel.width: (any)
comment: (any)
country: (any)
datapath: (any)
datapath.bridge: (any)
datapath.bridge-cost: (any)
datapath.bridge-horizon: (any)
datapath.client-isolation: (any)
datapath.interface-list: (any)
datapath.openflow-switch: (any)
datapath.vlan-id: (any)
disabled: (any)
dtim-period: (any)
hide-ssid: (any)
interworking: (any)
interworking.3gpp-info: (any)
interworking.authentication-types: (any)
interworking.connection-capabilities: (any)
interworking.domain-names: (any)
interworking.esr: (any)
interworking.hessid: (any)
interworking.hotspot20: (any)
interworking.hotspot20-dgaf: (any)
interworking.internet: (any)
interworking.ipv4-availability: (any)
interworking.ipv6-availability: (any)
interworking.network-type: (any)
interworking.operational-classes: (any)
interworking.operator-names: (any)
interworking.realms: (any)
interworking.roaming-ois: (any)
interworking.uesa: (any)
interworking.venue: (any)
interworking.venue-names: (any)
interworking.wan-at-capacity: (any)
interworking.wan-downlink: (any)
interworking.wan-downlink-load: (any)
interworking.wan-measurement-duration: (any)
interworking.wan-status: (any)
interworking.wan-symmetric: (any)
interworking.wan-uplink: (any)
interworking.wan-uplink-load: (any)
manager: (any)
mode: (any)
name: (any)
numbers: (any)
security: (any)
security.authentication-types: (any)
security.connect-group: (any)
security.connect-priority: (any)
security.dh-groups: (any)
security.disable-pmkid: (any)
security.eap-accounting: (any)
security.eap-anonymous-identity: (any)
security.eap-certificate-mode: (any)
security.eap-methods: (any)
security.eap-password: (any)
security.eap-tls-certificate: (any)
security.eap-username: (any)
security.encryption: (any)
security.ft: (any)
security.ft-mobility-domain: (any)
security.ft-nas-identifier: (any)
security.ft-over-ds: (any)
security.ft-preserve-vlanid: (any)
security.ft-r0-key-lifetime: (any)
security.ft-reassociation-deadline: (any)
security.group-encryption: (any)
security.group-key-update: (any)
security.management-encryption: (any)
security.management-protection: (any)
security.owe-transition-interface: (any)
security.passphrase: (any)
security.sae-anti-clogging-threshold: (any)
security.sae-max-failure-rate: (any)
security.sae-pwe: (any)
security.wps: (any)
ssid: (any)
steering: (any)
steering.neighbor-group: (any)
steering.rrm: (any)
steering.wnm: (any)
tx-chains: (any)
tx-power: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/wifiwave2/datapath get put

get

put

/interface/wifiwave2/datapath/add post

post

/interface/wifiwave2/datapath/{id} get delete patch

get

delete

patch

/interface/wifiwave2/datapath/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/wifiwave2/datapath/reset post

post

/interface/wifiwave2/datapath/set post

post

/interface/wifiwave2/frequency-scan post

post

/interface/wifiwave2/{id} get delete patch

get

delete

patch

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

URI Parameters

id: required(string)

Body

Media type: application/json

Type: object

Properties

aaa: (any)
aaa.called-format: (any)
aaa.calling-format: (any)
aaa.interim-update: (any)
aaa.mac-caching: (any)
aaa.nas-identifier: (any)
aaa.password-format: (any)
aaa.username-format: (any)
arp: (any)
arp-timeout: (any)
channel: (any)
channel.band: (any)
channel.frequency: (any)
channel.secondary-frequency: (any)
channel.skip-dfs-channels: (any)
channel.width: (any)
comment: (any)
configuration: (any)
configuration.antenna-gain: (any)
configuration.beacon-interval: (any)
configuration.chains: (any)
configuration.country: (any)
configuration.dtim-period: (any)
configuration.hide-ssid: (any)
configuration.manager: (any)
configuration.mode: (any)
configuration.ssid: (any)
configuration.tx-chains: (any)
configuration.tx-power: (any)
datapath: (any)
datapath.bridge: (any)
datapath.bridge-cost: (any)
datapath.bridge-horizon: (any)
datapath.client-isolation: (any)
datapath.interface-list: (any)
datapath.openflow-switch: (any)
datapath.vlan-id: (any)
disable-running-check: (any)
disabled: (any)
interworking: (any)
interworking.3gpp-info: (any)
interworking.authentication-types: (any)
interworking.connection-capabilities: (any)
interworking.domain-names: (any)
interworking.esr: (any)
interworking.hessid: (any)
interworking.hotspot20: (any)
interworking.hotspot20-dgaf: (any)
interworking.internet: (any)
interworking.ipv4-availability: (any)
interworking.ipv6-availability: (any)
interworking.network-type: (any)
interworking.operational-classes: (any)
interworking.operator-names: (any)
interworking.realms: (any)
interworking.roaming-ois: (any)
interworking.uesa: (any)
interworking.venue: (any)
interworking.venue-names: (any)
interworking.wan-at-capacity: (any)
interworking.wan-downlink: (any)
interworking.wan-downlink-load: (any)
interworking.wan-measurement-duration: (any)
interworking.wan-status: (any)
interworking.wan-symmetric: (any)
interworking.wan-uplink: (any)
interworking.wan-uplink-load: (any)
l2mtu: (any)
mac-address: (any)
master-interface: (any)
mtu: (any)
name: (any)
numbers: (any)
radio-mac: (any)
security: (any)
security.authentication-types: (any)
security.connect-group: (any)
security.connect-priority: (any)
security.dh-groups: (any)
security.disable-pmkid: (any)
security.eap-accounting: (any)
security.eap-anonymous-identity: (any)
security.eap-certificate-mode: (any)
security.eap-methods: (any)
security.eap-password: (any)
security.eap-tls-certificate: (any)
security.eap-username: (any)
security.encryption: (any)
security.ft: (any)
security.ft-mobility-domain: (any)
security.ft-nas-identifier: (any)
security.ft-over-ds: (any)
security.ft-preserve-vlanid: (any)
security.ft-r0-key-lifetime: (any)
security.ft-reassociation-deadline: (any)
security.group-encryption: (any)
security.group-key-update: (any)
security.management-encryption: (any)
security.management-protection: (any)
security.owe-transition-interface: (any)
security.passphrase: (any)
security.sae-anti-clogging-threshold: (any)
security.sae-max-failure-rate: (any)
security.sae-pwe: (any)
security.wps: (any)
steering: (any)
steering.neighbor-group: (any)
steering.rrm: (any)
steering.wnm: (any)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/wifiwave2/interworking get put

get

put

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

3gpp-info: (any)
authentication-types: (any)
comment: (any)
connection-capabilities: (any)
copy-from: (any)
disabled: (any)
domain-names: (any)
esr: (any)
hessid: (any)
hotspot20: (any)
hotspot20-dgaf: (any)
internet: (any)
ipv4-availability: (any)
ipv6-availability: (any)
name: (any)
network-type: (any)
operational-classes: (any)
operator-names: (any)
realms: (any)
roaming-ois: (any)
uesa: (any)
venue: (any)
venue-names: (any)
wan-at-capacity: (any)
wan-downlink: (any)
wan-downlink-load: (any)
wan-measurement-duration: (any)
wan-status: (any)
wan-symmetric: (any)
wan-uplink: (any)
wan-uplink-load: (any)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/wifiwave2/interworking/add post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

3gpp-info: (any)
authentication-types: (any)
comment: (any)
connection-capabilities: (any)
copy-from: (any)
disabled: (any)
domain-names: (any)
esr: (any)
hessid: (any)
hotspot20: (any)
hotspot20-dgaf: (any)
internet: (any)
ipv4-availability: (any)
ipv6-availability: (any)
name: (any)
network-type: (any)
operational-classes: (any)
operator-names: (any)
realms: (any)
roaming-ois: (any)
uesa: (any)
venue: (any)
venue-names: (any)
wan-at-capacity: (any)
wan-downlink: (any)
wan-downlink-load: (any)
wan-measurement-duration: (any)
wan-status: (any)
wan-symmetric: (any)
wan-uplink: (any)
wan-uplink-load: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/wifiwave2/interworking/{id} get delete patch

get

delete

patch

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

URI Parameters

id: required(string)

Body

Media type: application/json

Type: object

Properties

3gpp-info: (any)
authentication-types: (any)
comment: (any)
connection-capabilities: (any)
disabled: (any)
domain-names: (any)
esr: (any)
hessid: (any)
hotspot20: (any)
hotspot20-dgaf: (any)
internet: (any)
ipv4-availability: (any)
ipv6-availability: (any)
name: (any)
network-type: (any)
numbers: (any)
operational-classes: (any)
operator-names: (any)
realms: (any)
roaming-ois: (any)
uesa: (any)
venue: (any)
venue-names: (any)
wan-at-capacity: (any)
wan-downlink: (any)
wan-downlink-load: (any)
wan-measurement-duration: (any)
wan-status: (any)
wan-symmetric: (any)
wan-uplink: (any)
wan-uplink-load: (any)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/wifiwave2/interworking/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/wifiwave2/interworking/reset post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

3gpp-info: (any)
authentication-types: (any)
comment: (any)
connection-capabilities: (any)
disabled: (any)
domain-names: (any)
esr: (any)
hessid: (any)
hotspot20: (any)
hotspot20-dgaf: (any)
internet: (any)
ipv4-availability: (any)
ipv6-availability: (any)
name: (any)
network-type: (any)
numbers: (any)
operational-classes: (any)
operator-names: (any)
realms: (any)
roaming-ois: (any)
uesa: (any)
venue: (any)
venue-names: (any)
wan-at-capacity: (any)
wan-downlink: (any)
wan-downlink-load: (any)
wan-measurement-duration: (any)
wan-status: (any)
wan-symmetric: (any)
wan-uplink: (any)
wan-uplink-load: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/wifiwave2/interworking/set post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

3gpp-info: (any)
authentication-types: (any)
comment: (any)
connection-capabilities: (any)
disabled: (any)
domain-names: (any)
esr: (any)
hessid: (any)
hotspot20: (any)
hotspot20-dgaf: (any)
internet: (any)
ipv4-availability: (any)
ipv6-availability: (any)
name: (any)
network-type: (any)
numbers: (any)
operational-classes: (any)
operator-names: (any)
realms: (any)
roaming-ois: (any)
uesa: (any)
venue: (any)
venue-names: (any)
wan-at-capacity: (any)
wan-downlink: (any)
wan-downlink-load: (any)
wan-measurement-duration: (any)
wan-status: (any)
wan-symmetric: (any)
wan-uplink: (any)
wan-uplink-load: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/wifiwave2/monitor post

post

/interface/wifiwave2/print post

post

/interface/wifiwave2/provisioning get put

get

put

/interface/wifiwave2/provisioning/add post

post

/interface/wifiwave2/provisioning/{id} get delete patch

get

delete

patch

/interface/wifiwave2/provisioning/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/wifiwave2/provisioning/reset post

post

/interface/wifiwave2/provisioning/set post

post

/interface/wifiwave2/radio/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/wifiwave2/registration-table/{id} get delete

get

delete

/interface/wifiwave2/registration-table/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
stats: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/wifiwave2/reset post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

aaa: (any)
aaa.called-format: (any)
aaa.calling-format: (any)
aaa.interim-update: (any)
aaa.mac-caching: (any)
aaa.nas-identifier: (any)
aaa.password-format: (any)
aaa.username-format: (any)
arp: (any)
arp-timeout: (any)
channel: (any)
channel.band: (any)
channel.frequency: (any)
channel.secondary-frequency: (any)
channel.skip-dfs-channels: (any)
channel.width: (any)
comment: (any)
configuration: (any)
configuration.antenna-gain: (any)
configuration.beacon-interval: (any)
configuration.chains: (any)
configuration.country: (any)
configuration.dtim-period: (any)
configuration.hide-ssid: (any)
configuration.manager: (any)
configuration.mode: (any)
configuration.ssid: (any)
configuration.tx-chains: (any)
configuration.tx-power: (any)
datapath: (any)
datapath.bridge: (any)
datapath.bridge-cost: (any)
datapath.bridge-horizon: (any)
datapath.client-isolation: (any)
datapath.interface-list: (any)
datapath.openflow-switch: (any)
datapath.vlan-id: (any)
disable-running-check: (any)
disabled: (any)
interworking: (any)
interworking.3gpp-info: (any)
interworking.authentication-types: (any)
interworking.connection-capabilities: (any)
interworking.domain-names: (any)
interworking.esr: (any)
interworking.hessid: (any)
interworking.hotspot20: (any)
interworking.hotspot20-dgaf: (any)
interworking.internet: (any)
interworking.ipv4-availability: (any)
interworking.ipv6-availability: (any)
interworking.network-type: (any)
interworking.operational-classes: (any)
interworking.operator-names: (any)
interworking.realms: (any)
interworking.roaming-ois: (any)
interworking.uesa: (any)
interworking.venue: (any)
interworking.venue-names: (any)
interworking.wan-at-capacity: (any)
interworking.wan-downlink: (any)
interworking.wan-downlink-load: (any)
interworking.wan-measurement-duration: (any)
interworking.wan-status: (any)
interworking.wan-symmetric: (any)
interworking.wan-uplink: (any)
interworking.wan-uplink-load: (any)
l2mtu: (any)
mac-address: (any)
master-interface: (any)
mtu: (any)
name: (any)
numbers: (any)
radio-mac: (any)
security: (any)
security.authentication-types: (any)
security.connect-group: (any)
security.connect-priority: (any)
security.dh-groups: (any)
security.disable-pmkid: (any)
security.eap-accounting: (any)
security.eap-anonymous-identity: (any)
security.eap-certificate-mode: (any)
security.eap-methods: (any)
security.eap-password: (any)
security.eap-tls-certificate: (any)
security.eap-username: (any)
security.encryption: (any)
security.ft: (any)
security.ft-mobility-domain: (any)
security.ft-nas-identifier: (any)
security.ft-over-ds: (any)
security.ft-preserve-vlanid: (any)
security.ft-r0-key-lifetime: (any)
security.ft-reassociation-deadline: (any)
security.group-encryption: (any)
security.group-key-update: (any)
security.management-encryption: (any)
security.management-protection: (any)
security.owe-transition-interface: (any)
security.passphrase: (any)
security.sae-anti-clogging-threshold: (any)
security.sae-max-failure-rate: (any)
security.sae-pwe: (any)
security.wps: (any)
steering: (any)
steering.neighbor-group: (any)
steering.rrm: (any)
steering.wnm: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/wifiwave2/scan post

post

/interface/wifiwave2/security get put

get

put

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

authentication-types: (any)
comment: (any)
connect-group: (any)
connect-priority: (any)
copy-from: (any)
dh-groups: (any)
disable-pmkid: (any)
disabled: (any)
eap-accounting: (any)
eap-anonymous-identity: (any)
eap-certificate-mode: (any)
eap-methods: (any)
eap-password: (any)
eap-tls-certificate: (any)
eap-username: (any)
encryption: (any)
ft: (any)
ft-mobility-domain: (any)
ft-nas-identifier: (any)
ft-over-ds: (any)
ft-preserve-vlanid: (any)
ft-r0-key-lifetime: (any)
ft-reassociation-deadline: (any)
group-encryption: (any)
group-key-update: (any)
management-encryption: (any)
management-protection: (any)
name: (any)
owe-transition-interface: (any)
passphrase: (any)
sae-anti-clogging-threshold: (any)
sae-max-failure-rate: (any)
sae-pwe: (any)
wps: (any)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/wifiwave2/security/add post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

authentication-types: (any)
comment: (any)
connect-group: (any)
connect-priority: (any)
copy-from: (any)
dh-groups: (any)
disable-pmkid: (any)
disabled: (any)
eap-accounting: (any)
eap-anonymous-identity: (any)
eap-certificate-mode: (any)
eap-methods: (any)
eap-password: (any)
eap-tls-certificate: (any)
eap-username: (any)
encryption: (any)
ft: (any)
ft-mobility-domain: (any)
ft-nas-identifier: (any)
ft-over-ds: (any)
ft-preserve-vlanid: (any)
ft-r0-key-lifetime: (any)
ft-reassociation-deadline: (any)
group-encryption: (any)
group-key-update: (any)
management-encryption: (any)
management-protection: (any)
name: (any)
owe-transition-interface: (any)
passphrase: (any)
sae-anti-clogging-threshold: (any)
sae-max-failure-rate: (any)
sae-pwe: (any)
wps: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/wifiwave2/security/{id} get delete patch

get

delete

patch

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

URI Parameters

id: required(string)

Body

Media type: application/json

Type: object

Properties

authentication-types: (any)
comment: (any)
connect-group: (any)
connect-priority: (any)
dh-groups: (any)
disable-pmkid: (any)
disabled: (any)
eap-accounting: (any)
eap-anonymous-identity: (any)
eap-certificate-mode: (any)
eap-methods: (any)
eap-password: (any)
eap-tls-certificate: (any)
eap-username: (any)
encryption: (any)
ft: (any)
ft-mobility-domain: (any)
ft-nas-identifier: (any)
ft-over-ds: (any)
ft-preserve-vlanid: (any)
ft-r0-key-lifetime: (any)
ft-reassociation-deadline: (any)
group-encryption: (any)
group-key-update: (any)
management-encryption: (any)
management-protection: (any)
name: (any)
numbers: (any)
owe-transition-interface: (any)
passphrase: (any)
sae-anti-clogging-threshold: (any)
sae-max-failure-rate: (any)
sae-pwe: (any)
wps: (any)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/wifiwave2/security/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/wifiwave2/security/reset post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

authentication-types: (any)
comment: (any)
connect-group: (any)
connect-priority: (any)
dh-groups: (any)
disable-pmkid: (any)
disabled: (any)
eap-accounting: (any)
eap-anonymous-identity: (any)
eap-certificate-mode: (any)
eap-methods: (any)
eap-password: (any)
eap-tls-certificate: (any)
eap-username: (any)
encryption: (any)
ft: (any)
ft-mobility-domain: (any)
ft-nas-identifier: (any)
ft-over-ds: (any)
ft-preserve-vlanid: (any)
ft-r0-key-lifetime: (any)
ft-reassociation-deadline: (any)
group-encryption: (any)
group-key-update: (any)
management-encryption: (any)
management-protection: (any)
name: (any)
numbers: (any)
owe-transition-interface: (any)
passphrase: (any)
sae-anti-clogging-threshold: (any)
sae-max-failure-rate: (any)
sae-pwe: (any)
wps: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/wifiwave2/security/set post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

authentication-types: (any)
comment: (any)
connect-group: (any)
connect-priority: (any)
dh-groups: (any)
disable-pmkid: (any)
disabled: (any)
eap-accounting: (any)
eap-anonymous-identity: (any)
eap-certificate-mode: (any)
eap-methods: (any)
eap-password: (any)
eap-tls-certificate: (any)
eap-username: (any)
encryption: (any)
ft: (any)
ft-mobility-domain: (any)
ft-nas-identifier: (any)
ft-over-ds: (any)
ft-preserve-vlanid: (any)
ft-r0-key-lifetime: (any)
ft-reassociation-deadline: (any)
group-encryption: (any)
group-key-update: (any)
management-encryption: (any)
management-protection: (any)
name: (any)
numbers: (any)
owe-transition-interface: (any)
passphrase: (any)
sae-anti-clogging-threshold: (any)
sae-max-failure-rate: (any)
sae-pwe: (any)
wps: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/wifiwave2/set post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

aaa: (any)
aaa.called-format: (any)
aaa.calling-format: (any)
aaa.interim-update: (any)
aaa.mac-caching: (any)
aaa.nas-identifier: (any)
aaa.password-format: (any)
aaa.username-format: (any)
arp: (any)
arp-timeout: (any)
channel: (any)
channel.band: (any)
channel.frequency: (any)
channel.secondary-frequency: (any)
channel.skip-dfs-channels: (any)
channel.width: (any)
comment: (any)
configuration: (any)
configuration.antenna-gain: (any)
configuration.beacon-interval: (any)
configuration.chains: (any)
configuration.country: (any)
configuration.dtim-period: (any)
configuration.hide-ssid: (any)
configuration.manager: (any)
configuration.mode: (any)
configuration.ssid: (any)
configuration.tx-chains: (any)
configuration.tx-power: (any)
datapath: (any)
datapath.bridge: (any)
datapath.bridge-cost: (any)
datapath.bridge-horizon: (any)
datapath.client-isolation: (any)
datapath.interface-list: (any)
datapath.openflow-switch: (any)
datapath.vlan-id: (any)
disable-running-check: (any)
disabled: (any)
interworking: (any)
interworking.3gpp-info: (any)
interworking.authentication-types: (any)
interworking.connection-capabilities: (any)
interworking.domain-names: (any)
interworking.esr: (any)
interworking.hessid: (any)
interworking.hotspot20: (any)
interworking.hotspot20-dgaf: (any)
interworking.internet: (any)
interworking.ipv4-availability: (any)
interworking.ipv6-availability: (any)
interworking.network-type: (any)
interworking.operational-classes: (any)
interworking.operator-names: (any)
interworking.realms: (any)
interworking.roaming-ois: (any)
interworking.uesa: (any)
interworking.venue: (any)
interworking.venue-names: (any)
interworking.wan-at-capacity: (any)
interworking.wan-downlink: (any)
interworking.wan-downlink-load: (any)
interworking.wan-measurement-duration: (any)
interworking.wan-status: (any)
interworking.wan-symmetric: (any)
interworking.wan-uplink: (any)
interworking.wan-uplink-load: (any)
l2mtu: (any)
mac-address: (any)
master-interface: (any)
mtu: (any)
name: (any)
numbers: (any)
radio-mac: (any)
security: (any)
security.authentication-types: (any)
security.connect-group: (any)
security.connect-priority: (any)
security.dh-groups: (any)
security.disable-pmkid: (any)
security.eap-accounting: (any)
security.eap-anonymous-identity: (any)
security.eap-certificate-mode: (any)
security.eap-methods: (any)
security.eap-password: (any)
security.eap-tls-certificate: (any)
security.eap-username: (any)
security.encryption: (any)
security.ft: (any)
security.ft-mobility-domain: (any)
security.ft-nas-identifier: (any)
security.ft-over-ds: (any)
security.ft-preserve-vlanid: (any)
security.ft-r0-key-lifetime: (any)
security.ft-reassociation-deadline: (any)
security.group-encryption: (any)
security.group-key-update: (any)
security.management-encryption: (any)
security.management-protection: (any)
security.owe-transition-interface: (any)
security.passphrase: (any)
security.sae-anti-clogging-threshold: (any)
security.sae-max-failure-rate: (any)
security.sae-pwe: (any)
security.wps: (any)
steering: (any)
steering.neighbor-group: (any)
steering.rrm: (any)
steering.wnm: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/wifiwave2/sniffer post

post

/interface/wifiwave2/steering get put

get

put

/interface/wifiwave2/steering/add post

post

/interface/wifiwave2/steering/{id} get delete patch

get

delete

patch

/interface/wifiwave2/steering/neighbor-group/{id} get patch

get

patch

/interface/wifiwave2/steering/neighbor-group/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/wifiwave2/steering/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/wifiwave2/steering/set post

post

/interface/wifiwave2/wps-client post

post

/interface/wireguard get put

get

put

/interface/wireguard/{id} get delete patch

get

delete

patch

/interface/wireguard/peers get put

get

put

/interface/wireguard/peers/add post

post

/interface/wireguard/peers/{id} get delete patch

get

delete

patch

/interface/wireguard/peers/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/interface/wireguard/peers/reset post

post

/interface/wireguard/peers/set post

post

/interface/wireguard/print post

post

/interface/wireguard/wg-add-client post

post

/iot

/iot/bluetooth/advertisers/ad-structures/{id} get delete

get

delete

/iot/bluetooth/advertisers/ad-structures/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/iot/bluetooth/advertisers/{id} get patch

get

patch

/iot/bluetooth/advertisers/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/iot/bluetooth/advertisers/reset post

post

/iot/bluetooth/advertisers/set post

post

/iot/bluetooth/{id} get patch

get

patch

/iot/bluetooth/peripheral-devices/{id} get patch

get

patch

/iot/bluetooth/peripheral-devices/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/iot/bluetooth/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
stats: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/iot/bluetooth/scanners/advertisements/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/iot/bluetooth/scanners/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/iot/bluetooth/whitelist get put

get

put

/iot/bluetooth/whitelist/{id} get delete patch

get

delete

patch

/iot/bluetooth/whitelist/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/iot/lora/channels/{id} get patch

get

patch

/iot/lora/channels/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/iot/lora/channels/reset post

post

/iot/lora/{id} get patch

get

patch

/iot/lora/joineui get put

get

put

/iot/lora/joineui/{id} get delete patch

get

delete

patch

/iot/lora/joineui/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/iot/lora/netid get put

get

put

/iot/lora/netid/{id} get delete patch

get

delete

patch

/iot/lora/netid/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/iot/lora/print post

post

/iot/lora/radios/{id} get patch

get

patch

/iot/lora/radios/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/iot/lora/reset post

post

/iot/lora/servers get put

get

put

/iot/lora/servers/{id} get delete patch

get

delete

patch

/iot/lora/servers/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/iot/lora/set post

post

/iot/modbus/{id} get patch

get

patch

/iot/modbus/read-holding-registers post

post

/iot/modbus/security-rules get put

get

put

/iot/modbus/security-rules/{id} get delete patch

get

delete

patch

/iot/modbus/security-rules/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/iot/mqtt/brokers get put

get

put

/iot/mqtt/brokers/add post

post

/iot/mqtt/brokers/{id} get delete patch

get

delete

patch

/iot/mqtt/brokers/print post

post

/iot/mqtt/brokers/reset post

post

/iot/mqtt/brokers/set post

post

/iot/mqtt/subscriptions get put

get

put

/iot/mqtt/subscriptions/{id} get delete patch

get

delete

patch

/iot/mqtt/subscriptions/print post

post

/iot/mqtt/subscriptions/recv/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ip

/ip/address get put

get

put

/ip/address/{id} get delete patch

get

delete

patch

/ip/address/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ip/arp get put

get

put

/ip/arp/{id} get delete patch

get

delete

patch

/ip/arp/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ip/cloud/advanced/{id} get patch

get

patch

/ip/cloud/{id} get patch

get

patch

/ip/dhcp-client get put

get

put

/ip/dhcp-client/add post

post

/ip/dhcp-client/{id} get delete patch

get

delete

patch

/ip/dhcp-client/option get put

get

put

/ip/dhcp-client/option/{id} get delete patch

get

delete

patch

/ip/dhcp-client/option/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ip/dhcp-client/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ip/dhcp-client/reset post

post

/ip/dhcp-client/set post

post

/ip/dhcp-relay get put

get

put

/ip/dhcp-relay/add post

post

/ip/dhcp-relay/{id} get delete patch

get

delete

patch

/ip/dhcp-relay/monitor post

post

/ip/dhcp-relay/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ip/dhcp-relay/reset post

post

/ip/dhcp-relay/set post

post

/ip/dhcp-server get put

get

put

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

add-arp: (any)
address-pool: (any)
allow-dual-stack-queue: (any)
always-broadcast: (any)
authoritative: (any)
bootp-lease-time: (any)
bootp-support: (any)
client-mac-limit: (any)
comment: (any)
conflict-detection: (any)
copy-from: (any)
delay-threshold: (any)
dhcp-option-set: (any)
disabled: (any)
insert-queue-before: (any)
interface: (any)
lease-script: (any)
lease-time: (any)
name: (any)
parent-queue: (any)
relay: (any)
server-address: (any)
use-framed-as-classless: (any)
use-radius: (any)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ip/dhcp-server/add post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

add-arp: (any)
address-pool: (any)
allow-dual-stack-queue: (any)
always-broadcast: (any)
authoritative: (any)
bootp-lease-time: (any)
bootp-support: (any)
client-mac-limit: (any)
comment: (any)
conflict-detection: (any)
copy-from: (any)
delay-threshold: (any)
dhcp-option-set: (any)
disabled: (any)
insert-queue-before: (any)
interface: (any)
lease-script: (any)
lease-time: (any)
name: (any)
parent-queue: (any)
relay: (any)
server-address: (any)
use-framed-as-classless: (any)
use-radius: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ip/dhcp-server/alert get put

get

put

/ip/dhcp-server/alert/add post

post

/ip/dhcp-server/alert/{id} get delete patch

get

delete

patch

/ip/dhcp-server/alert/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ip/dhcp-server/alert/set post

post

/ip/dhcp-server/config/{id} get patch

get

patch

/ip/dhcp-server/{id} get delete patch

get

delete

patch

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

URI Parameters

id: required(string)

Body

Media type: application/json

Type: object

Properties

add-arp: (any)
address-pool: (any)
allow-dual-stack-queue: (any)
always-broadcast: (any)
authoritative: (any)
bootp-lease-time: (any)
bootp-support: (any)
client-mac-limit: (any)
comment: (any)
conflict-detection: (any)
delay-threshold: (any)
dhcp-option-set: (any)
disabled: (any)
insert-queue-before: (any)
interface: (any)
lease-script: (any)
lease-time: (any)
name: (any)
numbers: (any)
parent-queue: (any)
relay: (any)
server-address: (any)
use-framed-as-classless: (any)
use-radius: (any)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ip/dhcp-server/lease get put

get

put

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

address: (any)
address-lists: (any)
allow-dual-stack-queue: (any)
always-broadcast: (any)
block-access: (any)
client-id: (any)
comment: (any)
copy-from: (any)
dhcp-option: (any)
dhcp-option-set: (any)
disabled: (any)
insert-queue-before: (any)
lease-time: (any)
mac-address: (any)
parent-queue: (any)
queue-type: (any)
rate-limit: (any)
routes: (any)
server: (any)
use-src-mac: (any)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ip/dhcp-server/lease/add post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

address: (any)
address-lists: (any)
allow-dual-stack-queue: (any)
always-broadcast: (any)
block-access: (any)
client-id: (any)
comment: (any)
copy-from: (any)
dhcp-option: (any)
dhcp-option-set: (any)
disabled: (any)
insert-queue-before: (any)
lease-time: (any)
mac-address: (any)
parent-queue: (any)
queue-type: (any)
rate-limit: (any)
routes: (any)
server: (any)
use-src-mac: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ip/dhcp-server/lease/{id} get delete patch

get

delete

patch

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

URI Parameters

id: required(string)

Body

Media type: application/json

Type: object

Properties

address: (any)
address-lists: (any)
allow-dual-stack-queue: (any)
always-broadcast: (any)
block-access: (any)
client-id: (any)
comment: (any)
dhcp-option: (any)
dhcp-option-set: (any)
disabled: (any)
insert-queue-before: (any)
lease-time: (any)
mac-address: (any)
numbers: (any)
parent-queue: (any)
queue-type: (any)
rate-limit: (any)
routes: (any)
server: (any)
use-src-mac: (any)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ip/dhcp-server/lease/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

active: (any)
append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ip/dhcp-server/lease/reset post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

address: (any)
address-lists: (any)
allow-dual-stack-queue: (any)
always-broadcast: (any)
block-access: (any)
client-id: (any)
comment: (any)
dhcp-option: (any)
dhcp-option-set: (any)
disabled: (any)
insert-queue-before: (any)
lease-time: (any)
mac-address: (any)
numbers: (any)
parent-queue: (any)
queue-type: (any)
rate-limit: (any)
routes: (any)
server: (any)
use-src-mac: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ip/dhcp-server/lease/set post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

address: (any)
address-lists: (any)
allow-dual-stack-queue: (any)
always-broadcast: (any)
block-access: (any)
client-id: (any)
comment: (any)
dhcp-option: (any)
dhcp-option-set: (any)
disabled: (any)
insert-queue-before: (any)
lease-time: (any)
mac-address: (any)
numbers: (any)
parent-queue: (any)
queue-type: (any)
rate-limit: (any)
routes: (any)
server: (any)
use-src-mac: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ip/dhcp-server/matcher get put

get

put

/ip/dhcp-server/matcher/add post

post

/ip/dhcp-server/matcher/{id} get delete patch

get

delete

patch

/ip/dhcp-server/matcher/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ip/dhcp-server/matcher/set post

post

/ip/dhcp-server/network get put

get

put

/ip/dhcp-server/network/add post

post

/ip/dhcp-server/network/{id} get delete patch

get

delete

patch

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

URI Parameters

id: required(string)

Body

Media type: application/json

Type: object

Properties

address: (any)
boot-file-name: (any)
caps-manager: (any)
comment: (any)
dhcp-option: (any)
dhcp-option-set: (any)
dns-none: (any)
dns-server: (any)
domain: (any)
gateway: (any)
netmask: (any)
next-server: (any)
ntp-server: (any)
numbers: (any)
wins-server: (any)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ip/dhcp-server/network/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ip/dhcp-server/network/reset post

post

/ip/dhcp-server/network/set post

post

/ip/dhcp-server/option get put

get

put

/ip/dhcp-server/option/{id} get delete patch

get

delete

patch

/ip/dhcp-server/option/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ip/dhcp-server/option/sets get put

get

put

/ip/dhcp-server/option/sets/{id} get delete patch

get

delete

patch

/ip/dhcp-server/option/sets/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ip/dhcp-server/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ip/dhcp-server/reset post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

add-arp: (any)
address-pool: (any)
allow-dual-stack-queue: (any)
always-broadcast: (any)
authoritative: (any)
bootp-lease-time: (any)
bootp-support: (any)
client-mac-limit: (any)
comment: (any)
conflict-detection: (any)
delay-threshold: (any)
dhcp-option-set: (any)
disabled: (any)
insert-queue-before: (any)
interface: (any)
lease-script: (any)
lease-time: (any)
name: (any)
numbers: (any)
parent-queue: (any)
relay: (any)
server-address: (any)
use-framed-as-classless: (any)
use-radius: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ip/dhcp-server/set post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

add-arp: (any)
address-pool: (any)
allow-dual-stack-queue: (any)
always-broadcast: (any)
authoritative: (any)
bootp-lease-time: (any)
bootp-support: (any)
client-mac-limit: (any)
comment: (any)
conflict-detection: (any)
delay-threshold: (any)
dhcp-option-set: (any)
disabled: (any)
insert-queue-before: (any)
interface: (any)
lease-script: (any)
lease-time: (any)
name: (any)
numbers: (any)
parent-queue: (any)
relay: (any)
server-address: (any)
use-framed-as-classless: (any)
use-radius: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ip/dns/cache/all/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ip/dns/cache/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ip/dns/{id} get patch

get

patch

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

URI Parameters

id: required(string)

Body

Media type: application/json

Type: object

Properties

address-list-extra-time: (any)
allow-remote-requests: (any)
cache-max-ttl: (any)
cache-size: (any)
doh-max-concurrent-queries: (any)
doh-max-server-connections: (any)
doh-timeout: (any)
max-concurrent-queries: (any)
max-concurrent-tcp-sessions: (any)
max-udp-packet-size: (any)
query-server-timeout: (any)
query-total-timeout: (any)
servers: (any)
use-doh-server: (any)
verify-doh-cert: (any)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ip/dns/set post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

address-list-extra-time: (any)
allow-remote-requests: (any)
cache-max-ttl: (any)
cache-size: (any)
doh-max-concurrent-queries: (any)
doh-max-server-connections: (any)
doh-timeout: (any)
max-concurrent-queries: (any)
max-concurrent-tcp-sessions: (any)
max-udp-packet-size: (any)
query-server-timeout: (any)
query-total-timeout: (any)
servers: (any)
use-doh-server: (any)
verify-doh-cert: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ip/dns/static/{id} get delete

get

delete

/ip/dns/static/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ip/firewall/address-list get put

get

put

/ip/firewall/address-list/{id} get delete patch

get

delete

patch

/ip/firewall/address-list/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ip/firewall/address-list/reset post

post

/ip/firewall/calea get put

get

put

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

action: (any)
address-list: (any)
address-list-timeout: (any)
chain: (any)
comment: (any)
connection-bytes: (any)
connection-limit: (any)
connection-mark: (any)
connection-rate: (any)
connection-type: (any)
content: (any)
copy-from: (any)
disabled: (any)
dscp: (any)
dst-address: (any)
dst-address-list: (any)
dst-address-type: (any)
dst-limit: (any)
dst-port: (any)
fragment: (any)
hotspot: (any)
icmp-options: (any)
in-bridge-port: (any)
in-bridge-port-list: (any)
in-interface: (any)
in-interface-list: (any)
ingress-priority: (any)
ipsec-policy: (any)
ipv4-options: (any)
layer7-protocol: (any)
limit: (any)
log: (any)
log-prefix: (any)
nth: (any)
out-bridge-port: (any)
out-bridge-port-list: (any)
out-interface: (any)
out-interface-list: (any)
packet-mark: (any)
packet-size: (any)
per-connection-classifier: (any)
place-before: (any)
port: (any)
priority: (any)
protocol: (any)
psd: (any)
random: (any)
realm: (any)
routing-mark: (any)
sniff-id: (any)
sniff-target: (any)
sniff-target-port: (any)
src-address: (any)
src-address-list: (any)
src-address-type: (any)
src-mac-address: (any)
src-port: (any)
tcp-mss: (any)
time: (any)
tls-host: (any)
ttl: (any)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ip/firewall/calea/add post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

action: (any)
address-list: (any)
address-list-timeout: (any)
chain: (any)
comment: (any)
connection-bytes: (any)
connection-limit: (any)
connection-mark: (any)
connection-rate: (any)
connection-type: (any)
content: (any)
copy-from: (any)
disabled: (any)
dscp: (any)
dst-address: (any)
dst-address-list: (any)
dst-address-type: (any)
dst-limit: (any)
dst-port: (any)
fragment: (any)
hotspot: (any)
icmp-options: (any)
in-bridge-port: (any)
in-bridge-port-list: (any)
in-interface: (any)
in-interface-list: (any)
ingress-priority: (any)
ipsec-policy: (any)
ipv4-options: (any)
layer7-protocol: (any)
limit: (any)
log: (any)
log-prefix: (any)
nth: (any)
out-bridge-port: (any)
out-bridge-port-list: (any)
out-interface: (any)
out-interface-list: (any)
packet-mark: (any)
packet-size: (any)
per-connection-classifier: (any)
place-before: (any)
port: (any)
priority: (any)
protocol: (any)
psd: (any)
random: (any)
realm: (any)
routing-mark: (any)
sniff-id: (any)
sniff-target: (any)
sniff-target-port: (any)
src-address: (any)
src-address-list: (any)
src-address-type: (any)
src-mac-address: (any)
src-port: (any)
tcp-mss: (any)
time: (any)
tls-host: (any)
ttl: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ip/firewall/calea/{id} get delete patch

get

delete

patch

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

URI Parameters

id: required(string)

Body

Media type: application/json

Type: object

Properties

action: (any)
address-list: (any)
address-list-timeout: (any)
chain: (any)
comment: (any)
connection-bytes: (any)
connection-limit: (any)
connection-mark: (any)
connection-rate: (any)
connection-type: (any)
content: (any)
disabled: (any)
dscp: (any)
dst-address: (any)
dst-address-list: (any)
dst-address-type: (any)
dst-limit: (any)
dst-port: (any)
fragment: (any)
hotspot: (any)
icmp-options: (any)
in-bridge-port: (any)
in-bridge-port-list: (any)
in-interface: (any)
in-interface-list: (any)
ingress-priority: (any)
ipsec-policy: (any)
ipv4-options: (any)
layer7-protocol: (any)
limit: (any)
log: (any)
log-prefix: (any)
nth: (any)
numbers: (any)
out-bridge-port: (any)
out-bridge-port-list: (any)
out-interface: (any)
out-interface-list: (any)
packet-mark: (any)
packet-size: (any)
per-connection-classifier: (any)
port: (any)
priority: (any)
protocol: (any)
psd: (any)
random: (any)
realm: (any)
routing-mark: (any)
sniff-id: (any)
sniff-target: (any)
sniff-target-port: (any)
src-address: (any)
src-address-list: (any)
src-address-type: (any)
src-mac-address: (any)
src-port: (any)
tcp-mss: (any)
time: (any)
tls-host: (any)
ttl: (any)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ip/firewall/calea/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
count-only: (any)
detail: (any)
file: (any)
filter: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
stats: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ip/firewall/calea/reset post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

action: (any)
address-list: (any)
address-list-timeout: (any)
chain: (any)
comment: (any)
connection-bytes: (any)
connection-limit: (any)
connection-mark: (any)
connection-rate: (any)
connection-type: (any)
content: (any)
disabled: (any)
dscp: (any)
dst-address: (any)
dst-address-list: (any)
dst-address-type: (any)
dst-limit: (any)
dst-port: (any)
fragment: (any)
hotspot: (any)
icmp-options: (any)
in-bridge-port: (any)
in-bridge-port-list: (any)
in-interface: (any)
in-interface-list: (any)
ingress-priority: (any)
ipsec-policy: (any)
ipv4-options: (any)
layer7-protocol: (any)
limit: (any)
log: (any)
log-prefix: (any)
nth: (any)
numbers: (any)
out-bridge-port: (any)
out-bridge-port-list: (any)
out-interface: (any)
out-interface-list: (any)
packet-mark: (any)
packet-size: (any)
per-connection-classifier: (any)
port: (any)
priority: (any)
protocol: (any)
psd: (any)
random: (any)
realm: (any)
routing-mark: (any)
sniff-id: (any)
sniff-target: (any)
sniff-target-port: (any)
src-address: (any)
src-address-list: (any)
src-address-type: (any)
src-mac-address: (any)
src-port: (any)
tcp-mss: (any)
time: (any)
tls-host: (any)
ttl: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ip/firewall/calea/set post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

action: (any)
address-list: (any)
address-list-timeout: (any)
chain: (any)
comment: (any)
connection-bytes: (any)
connection-limit: (any)
connection-mark: (any)
connection-rate: (any)
connection-type: (any)
content: (any)
disabled: (any)
dscp: (any)
dst-address: (any)
dst-address-list: (any)
dst-address-type: (any)
dst-limit: (any)
dst-port: (any)
fragment: (any)
hotspot: (any)
icmp-options: (any)
in-bridge-port: (any)
in-bridge-port-list: (any)
in-interface: (any)
in-interface-list: (any)
ingress-priority: (any)
ipsec-policy: (any)
ipv4-options: (any)
layer7-protocol: (any)
limit: (any)
log: (any)
log-prefix: (any)
nth: (any)
numbers: (any)
out-bridge-port: (any)
out-bridge-port-list: (any)
out-interface: (any)
out-interface-list: (any)
packet-mark: (any)
packet-size: (any)
per-connection-classifier: (any)
port: (any)
priority: (any)
protocol: (any)
psd: (any)
random: (any)
realm: (any)
routing-mark: (any)
sniff-id: (any)
sniff-target: (any)
sniff-target-port: (any)
src-address: (any)
src-address-list: (any)
src-address-type: (any)
src-mac-address: (any)
src-port: (any)
tcp-mss: (any)
time: (any)
tls-host: (any)
ttl: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ip/firewall/connection/{id} get delete

get

delete

/ip/firewall/connection/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ip/firewall/connection/tracking/{id} get patch

get

patch

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

URI Parameters

id: required(string)

Body

Media type: application/json

Type: object

Properties

enabled: (any)
generic-timeout: (any)
icmp-timeout: (any)
loose-tcp-tracking: (any)
tcp-close-timeout: (any)
tcp-close-wait-timeout: (any)
tcp-established-timeout: (any)
tcp-fin-wait-timeout: (any)
tcp-last-ack-timeout: (any)
tcp-max-retrans-timeout: (any)
tcp-syn-received-timeout: (any)
tcp-syn-sent-timeout: (any)
tcp-time-wait-timeout: (any)
tcp-unacked-timeout: (any)
udp-stream-timeout: (any)
udp-timeout: (any)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ip/firewall/connection/tracking/set post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

enabled: (any)
generic-timeout: (any)
icmp-timeout: (any)
loose-tcp-tracking: (any)
tcp-close-timeout: (any)
tcp-close-wait-timeout: (any)
tcp-established-timeout: (any)
tcp-fin-wait-timeout: (any)
tcp-last-ack-timeout: (any)
tcp-max-retrans-timeout: (any)
tcp-syn-received-timeout: (any)
tcp-syn-sent-timeout: (any)
tcp-time-wait-timeout: (any)
tcp-unacked-timeout: (any)
udp-stream-timeout: (any)
udp-timeout: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ip/firewall/filter get put

get

put

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

action: (any)
address-list: (any)
address-list-timeout: (any)
chain: (any)
comment: (any)
connection-bytes: (any)
connection-limit: (any)
connection-mark: (any)
connection-nat-state: (any)
connection-rate: (any)
connection-state: (any)
connection-type: (any)
content: (any)
copy-from: (any)
disabled: (any)
dscp: (any)
dst-address: (any)
dst-address-list: (any)
dst-address-type: (any)
dst-limit: (any)
dst-port: (any)
fragment: (any)
hotspot: (any)
hw-offload: (any)
icmp-options: (any)
in-bridge-port: (any)
in-bridge-port-list: (any)
in-interface: (any)
in-interface-list: (any)
ingress-priority: (any)
ipsec-policy: (any)
ipv4-options: (any)
jump-target: (any)
layer7-protocol: (any)
limit: (any)
log: (any)
log-prefix: (any)
nth: (any)
out-bridge-port: (any)
out-bridge-port-list: (any)
out-interface: (any)
out-interface-list: (any)
p2p: (any)
packet-mark: (any)
packet-size: (any)
per-connection-classifier: (any)
place-before: (any)
port: (any)
priority: (any)
protocol: (any)
psd: (any)
random: (any)
realm: (any)
reject-with: (any)
routing-mark: (any)
src-address: (any)
src-address-list: (any)
src-address-type: (any)
src-mac-address: (any)
src-port: (any)
tcp-flags: (any)
tcp-mss: (any)
time: (any)
tls-host: (any)
ttl: (any)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ip/firewall/filter/add post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

action: (any)
address-list: (any)
address-list-timeout: (any)
chain: (any)
comment: (any)
connection-bytes: (any)
connection-limit: (any)
connection-mark: (any)
connection-nat-state: (any)
connection-rate: (any)
connection-state: (any)
connection-type: (any)
content: (any)
copy-from: (any)
disabled: (any)
dscp: (any)
dst-address: (any)
dst-address-list: (any)
dst-address-type: (any)
dst-limit: (any)
dst-port: (any)
fragment: (any)
hotspot: (any)
hw-offload: (any)
icmp-options: (any)
in-bridge-port: (any)
in-bridge-port-list: (any)
in-interface: (any)
in-interface-list: (any)
ingress-priority: (any)
ipsec-policy: (any)
ipv4-options: (any)
jump-target: (any)
layer7-protocol: (any)
limit: (any)
log: (any)
log-prefix: (any)
nth: (any)
out-bridge-port: (any)
out-bridge-port-list: (any)
out-interface: (any)
out-interface-list: (any)
p2p: (any)
packet-mark: (any)
packet-size: (any)
per-connection-classifier: (any)
place-before: (any)
port: (any)
priority: (any)
protocol: (any)
psd: (any)
random: (any)
realm: (any)
reject-with: (any)
routing-mark: (any)
src-address: (any)
src-address-list: (any)
src-address-type: (any)
src-mac-address: (any)
src-port: (any)
tcp-flags: (any)
tcp-mss: (any)
time: (any)
tls-host: (any)
ttl: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ip/firewall/filter/{id} get delete patch

get

delete

patch

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

URI Parameters

id: required(string)

Body

Media type: application/json

Type: object

Properties

action: (any)
address-list: (any)
address-list-timeout: (any)
chain: (any)
comment: (any)
connection-bytes: (any)
connection-limit: (any)
connection-mark: (any)
connection-nat-state: (any)
connection-rate: (any)
connection-state: (any)
connection-type: (any)
content: (any)
disabled: (any)
dscp: (any)
dst-address: (any)
dst-address-list: (any)
dst-address-type: (any)
dst-limit: (any)
dst-port: (any)
fragment: (any)
hotspot: (any)
hw-offload: (any)
icmp-options: (any)
in-bridge-port: (any)
in-bridge-port-list: (any)
in-interface: (any)
in-interface-list: (any)
ingress-priority: (any)
ipsec-policy: (any)
ipv4-options: (any)
jump-target: (any)
layer7-protocol: (any)
limit: (any)
log: (any)
log-prefix: (any)
nth: (any)
numbers: (any)
out-bridge-port: (any)
out-bridge-port-list: (any)
out-interface: (any)
out-interface-list: (any)
p2p: (any)
packet-mark: (any)
packet-size: (any)
per-connection-classifier: (any)
port: (any)
priority: (any)
protocol: (any)
psd: (any)
random: (any)
realm: (any)
reject-with: (any)
routing-mark: (any)
src-address: (any)
src-address-list: (any)
src-address-type: (any)
src-mac-address: (any)
src-port: (any)
tcp-flags: (any)
tcp-mss: (any)
time: (any)
tls-host: (any)
ttl: (any)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ip/firewall/filter/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

all: (any)
append: (any)
as-value: (any)
chain: (any)
count-only: (any)
detail: (any)
dynamic: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
static: (any)
stats: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ip/firewall/filter/reset post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

action: (any)
address-list: (any)
address-list-timeout: (any)
chain: (any)
comment: (any)
connection-bytes: (any)
connection-limit: (any)
connection-mark: (any)
connection-nat-state: (any)
connection-rate: (any)
connection-state: (any)
connection-type: (any)
content: (any)
disabled: (any)
dscp: (any)
dst-address: (any)
dst-address-list: (any)
dst-address-type: (any)
dst-limit: (any)
dst-port: (any)
fragment: (any)
hotspot: (any)
hw-offload: (any)
icmp-options: (any)
in-bridge-port: (any)
in-bridge-port-list: (any)
in-interface: (any)
in-interface-list: (any)
ingress-priority: (any)
ipsec-policy: (any)
ipv4-options: (any)
jump-target: (any)
layer7-protocol: (any)
limit: (any)
log: (any)
log-prefix: (any)
nth: (any)
numbers: (any)
out-bridge-port: (any)
out-bridge-port-list: (any)
out-interface: (any)
out-interface-list: (any)
p2p: (any)
packet-mark: (any)
packet-size: (any)
per-connection-classifier: (any)
port: (any)
priority: (any)
protocol: (any)
psd: (any)
random: (any)
realm: (any)
reject-with: (any)
routing-mark: (any)
src-address: (any)
src-address-list: (any)
src-address-type: (any)
src-mac-address: (any)
src-port: (any)
tcp-flags: (any)
tcp-mss: (any)
time: (any)
tls-host: (any)
ttl: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ip/firewall/filter/set post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

action: (any)
address-list: (any)
address-list-timeout: (any)
chain: (any)
comment: (any)
connection-bytes: (any)
connection-limit: (any)
connection-mark: (any)
connection-nat-state: (any)
connection-rate: (any)
connection-state: (any)
connection-type: (any)
content: (any)
disabled: (any)
dscp: (any)
dst-address: (any)
dst-address-list: (any)
dst-address-type: (any)
dst-limit: (any)
dst-port: (any)
fragment: (any)
hotspot: (any)
hw-offload: (any)
icmp-options: (any)
in-bridge-port: (any)
in-bridge-port-list: (any)
in-interface: (any)
in-interface-list: (any)
ingress-priority: (any)
ipsec-policy: (any)
ipv4-options: (any)
jump-target: (any)
layer7-protocol: (any)
limit: (any)
log: (any)
log-prefix: (any)
nth: (any)
numbers: (any)
out-bridge-port: (any)
out-bridge-port-list: (any)
out-interface: (any)
out-interface-list: (any)
p2p: (any)
packet-mark: (any)
packet-size: (any)
per-connection-classifier: (any)
port: (any)
priority: (any)
protocol: (any)
psd: (any)
random: (any)
realm: (any)
reject-with: (any)
routing-mark: (any)
src-address: (any)
src-address-list: (any)
src-address-type: (any)
src-mac-address: (any)
src-port: (any)
tcp-flags: (any)
tcp-mss: (any)
time: (any)
tls-host: (any)
ttl: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ip/firewall/layer7-protocol get put

get

put

/ip/firewall/layer7-protocol/{id} get delete patch

get

delete

patch

/ip/firewall/layer7-protocol/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ip/firewall/mangle get put

get

put

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

action: (any)
address-list: (any)
address-list-timeout: (any)
chain: (any)
comment: (any)
connection-bytes: (any)
connection-limit: (any)
connection-mark: (any)
connection-nat-state: (any)
connection-rate: (any)
connection-state: (any)
connection-type: (any)
content: (any)
copy-from: (any)
disabled: (any)
dscp: (any)
dst-address: (any)
dst-address-list: (any)
dst-address-type: (any)
dst-limit: (any)
dst-port: (any)
fragment: (any)
hotspot: (any)
icmp-options: (any)
in-bridge-port: (any)
in-bridge-port-list: (any)
in-interface: (any)
in-interface-list: (any)
ingress-priority: (any)
ipsec-policy: (any)
ipv4-options: (any)
jump-target: (any)
layer7-protocol: (any)
limit: (any)
log: (any)
log-prefix: (any)
new-connection-mark: (any)
new-dscp: (any)
new-mss: (any)
new-packet-mark: (any)
new-priority: (any)
new-routing-mark: (any)
new-ttl: (any)
nth: (any)
out-bridge-port: (any)
out-bridge-port-list: (any)
out-interface: (any)
out-interface-list: (any)
p2p: (any)
packet-mark: (any)
packet-size: (any)
passthrough: (any)
per-connection-classifier: (any)
place-before: (any)
port: (any)
priority: (any)
protocol: (any)
psd: (any)
random: (any)
realm: (any)
route-dst: (any)
routing-mark: (any)
sniff-id: (any)
sniff-target: (any)
sniff-target-port: (any)
src-address: (any)
src-address-list: (any)
src-address-type: (any)
src-mac-address: (any)
src-port: (any)
tcp-flags: (any)
tcp-mss: (any)
time: (any)
tls-host: (any)
ttl: (any)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ip/firewall/mangle/add post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

action: (any)
address-list: (any)
address-list-timeout: (any)
chain: (any)
comment: (any)
connection-bytes: (any)
connection-limit: (any)
connection-mark: (any)
connection-nat-state: (any)
connection-rate: (any)
connection-state: (any)
connection-type: (any)
content: (any)
copy-from: (any)
disabled: (any)
dscp: (any)
dst-address: (any)
dst-address-list: (any)
dst-address-type: (any)
dst-limit: (any)
dst-port: (any)
fragment: (any)
hotspot: (any)
icmp-options: (any)
in-bridge-port: (any)
in-bridge-port-list: (any)
in-interface: (any)
in-interface-list: (any)
ingress-priority: (any)
ipsec-policy: (any)
ipv4-options: (any)
jump-target: (any)
layer7-protocol: (any)
limit: (any)
log: (any)
log-prefix: (any)
new-connection-mark: (any)
new-dscp: (any)
new-mss: (any)
new-packet-mark: (any)
new-priority: (any)
new-routing-mark: (any)
new-ttl: (any)
nth: (any)
out-bridge-port: (any)
out-bridge-port-list: (any)
out-interface: (any)
out-interface-list: (any)
p2p: (any)
packet-mark: (any)
packet-size: (any)
passthrough: (any)
per-connection-classifier: (any)
place-before: (any)
port: (any)
priority: (any)
protocol: (any)
psd: (any)
random: (any)
realm: (any)
route-dst: (any)
routing-mark: (any)
sniff-id: (any)
sniff-target: (any)
sniff-target-port: (any)
src-address: (any)
src-address-list: (any)
src-address-type: (any)
src-mac-address: (any)
src-port: (any)
tcp-flags: (any)
tcp-mss: (any)
time: (any)
tls-host: (any)
ttl: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ip/firewall/mangle/{id} get delete patch

get

delete

patch

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

URI Parameters

id: required(string)

Body

Media type: application/json

Type: object

Properties

action: (any)
address-list: (any)
address-list-timeout: (any)
chain: (any)
comment: (any)
connection-bytes: (any)
connection-limit: (any)
connection-mark: (any)
connection-nat-state: (any)
connection-rate: (any)
connection-state: (any)
connection-type: (any)
content: (any)
disabled: (any)
dscp: (any)
dst-address: (any)
dst-address-list: (any)
dst-address-type: (any)
dst-limit: (any)
dst-port: (any)
fragment: (any)
hotspot: (any)
icmp-options: (any)
in-bridge-port: (any)
in-bridge-port-list: (any)
in-interface: (any)
in-interface-list: (any)
ingress-priority: (any)
ipsec-policy: (any)
ipv4-options: (any)
jump-target: (any)
layer7-protocol: (any)
limit: (any)
log: (any)
log-prefix: (any)
new-connection-mark: (any)
new-dscp: (any)
new-mss: (any)
new-packet-mark: (any)
new-priority: (any)
new-routing-mark: (any)
new-ttl: (any)
nth: (any)
numbers: (any)
out-bridge-port: (any)
out-bridge-port-list: (any)
out-interface: (any)
out-interface-list: (any)
p2p: (any)
packet-mark: (any)
packet-size: (any)
passthrough: (any)
per-connection-classifier: (any)
port: (any)
priority: (any)
protocol: (any)
psd: (any)
random: (any)
realm: (any)
route-dst: (any)
routing-mark: (any)
sniff-id: (any)
sniff-target: (any)
sniff-target-port: (any)
src-address: (any)
src-address-list: (any)
src-address-type: (any)
src-mac-address: (any)
src-port: (any)
tcp-flags: (any)
tcp-mss: (any)
time: (any)
tls-host: (any)
ttl: (any)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ip/firewall/mangle/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

all: (any)
append: (any)
as-value: (any)
chain: (any)
count-only: (any)
detail: (any)
dynamic: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
static: (any)
stats: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ip/firewall/mangle/reset post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

action: (any)
address-list: (any)
address-list-timeout: (any)
chain: (any)
comment: (any)
connection-bytes: (any)
connection-limit: (any)
connection-mark: (any)
connection-nat-state: (any)
connection-rate: (any)
connection-state: (any)
connection-type: (any)
content: (any)
disabled: (any)
dscp: (any)
dst-address: (any)
dst-address-list: (any)
dst-address-type: (any)
dst-limit: (any)
dst-port: (any)
fragment: (any)
hotspot: (any)
icmp-options: (any)
in-bridge-port: (any)
in-bridge-port-list: (any)
in-interface: (any)
in-interface-list: (any)
ingress-priority: (any)
ipsec-policy: (any)
ipv4-options: (any)
jump-target: (any)
layer7-protocol: (any)
limit: (any)
log: (any)
log-prefix: (any)
new-connection-mark: (any)
new-dscp: (any)
new-mss: (any)
new-packet-mark: (any)
new-priority: (any)
new-routing-mark: (any)
new-ttl: (any)
nth: (any)
numbers: (any)
out-bridge-port: (any)
out-bridge-port-list: (any)
out-interface: (any)
out-interface-list: (any)
p2p: (any)
packet-mark: (any)
packet-size: (any)
passthrough: (any)
per-connection-classifier: (any)
port: (any)
priority: (any)
protocol: (any)
psd: (any)
random: (any)
realm: (any)
route-dst: (any)
routing-mark: (any)
sniff-id: (any)
sniff-target: (any)
sniff-target-port: (any)
src-address: (any)
src-address-list: (any)
src-address-type: (any)
src-mac-address: (any)
src-port: (any)
tcp-flags: (any)
tcp-mss: (any)
time: (any)
tls-host: (any)
ttl: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ip/firewall/mangle/set post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

action: (any)
address-list: (any)
address-list-timeout: (any)
chain: (any)
comment: (any)
connection-bytes: (any)
connection-limit: (any)
connection-mark: (any)
connection-nat-state: (any)
connection-rate: (any)
connection-state: (any)
connection-type: (any)
content: (any)
disabled: (any)
dscp: (any)
dst-address: (any)
dst-address-list: (any)
dst-address-type: (any)
dst-limit: (any)
dst-port: (any)
fragment: (any)
hotspot: (any)
icmp-options: (any)
in-bridge-port: (any)
in-bridge-port-list: (any)
in-interface: (any)
in-interface-list: (any)
ingress-priority: (any)
ipsec-policy: (any)
ipv4-options: (any)
jump-target: (any)
layer7-protocol: (any)
limit: (any)
log: (any)
log-prefix: (any)
new-connection-mark: (any)
new-dscp: (any)
new-mss: (any)
new-packet-mark: (any)
new-priority: (any)
new-routing-mark: (any)
new-ttl: (any)
nth: (any)
numbers: (any)
out-bridge-port: (any)
out-bridge-port-list: (any)
out-interface: (any)
out-interface-list: (any)
p2p: (any)
packet-mark: (any)
packet-size: (any)
passthrough: (any)
per-connection-classifier: (any)
port: (any)
priority: (any)
protocol: (any)
psd: (any)
random: (any)
realm: (any)
route-dst: (any)
routing-mark: (any)
sniff-id: (any)
sniff-target: (any)
sniff-target-port: (any)
src-address: (any)
src-address-list: (any)
src-address-type: (any)
src-mac-address: (any)
src-port: (any)
tcp-flags: (any)
tcp-mss: (any)
time: (any)
tls-host: (any)
ttl: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ip/firewall/nat get put

get

put

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

action: (any)
address-list: (any)
address-list-timeout: (any)
chain: (any)
comment: (any)
connection-bytes: (any)
connection-limit: (any)
connection-mark: (any)
connection-rate: (any)
connection-type: (any)
content: (any)
copy-from: (any)
disabled: (any)
dscp: (any)
dst-address: (any)
dst-address-list: (any)
dst-address-type: (any)
dst-limit: (any)
dst-port: (any)
fragment: (any)
hotspot: (any)
icmp-options: (any)
in-bridge-port: (any)
in-bridge-port-list: (any)
in-interface: (any)
in-interface-list: (any)
ingress-priority: (any)
ipsec-policy: (any)
ipv4-options: (any)
jump-target: (any)
layer7-protocol: (any)
limit: (any)
log: (any)
log-prefix: (any)
nth: (any)
out-bridge-port: (any)
out-bridge-port-list: (any)
out-interface: (any)
out-interface-list: (any)
packet-mark: (any)
packet-size: (any)
per-connection-classifier: (any)
place-before: (any)
port: (any)
priority: (any)
protocol: (any)
psd: (any)
random: (any)
randomise-ports: (any)
realm: (any)
routing-mark: (any)
same-not-by-dst: (any)
src-address: (any)
src-address-list: (any)
src-address-type: (any)
src-mac-address: (any)
src-port: (any)
tcp-mss: (any)
time: (any)
tls-host: (any)
to-addresses: (any)
to-ports: (any)
ttl: (any)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ip/firewall/nat/add post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

action: (any)
address-list: (any)
address-list-timeout: (any)
chain: (any)
comment: (any)
connection-bytes: (any)
connection-limit: (any)
connection-mark: (any)
connection-rate: (any)
connection-type: (any)
content: (any)
copy-from: (any)
disabled: (any)
dscp: (any)
dst-address: (any)
dst-address-list: (any)
dst-address-type: (any)
dst-limit: (any)
dst-port: (any)
fragment: (any)
hotspot: (any)
icmp-options: (any)
in-bridge-port: (any)
in-bridge-port-list: (any)
in-interface: (any)
in-interface-list: (any)
ingress-priority: (any)
ipsec-policy: (any)
ipv4-options: (any)
jump-target: (any)
layer7-protocol: (any)
limit: (any)
log: (any)
log-prefix: (any)
nth: (any)
out-bridge-port: (any)
out-bridge-port-list: (any)
out-interface: (any)
out-interface-list: (any)
packet-mark: (any)
packet-size: (any)
per-connection-classifier: (any)
place-before: (any)
port: (any)
priority: (any)
protocol: (any)
psd: (any)
random: (any)
randomise-ports: (any)
realm: (any)
routing-mark: (any)
same-not-by-dst: (any)
src-address: (any)
src-address-list: (any)
src-address-type: (any)
src-mac-address: (any)
src-port: (any)
tcp-mss: (any)
time: (any)
tls-host: (any)
to-addresses: (any)
to-ports: (any)
ttl: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ip/firewall/nat/{id} get delete patch

get

delete

patch

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

URI Parameters

id: required(string)

Body

Media type: application/json

Type: object

Properties

action: (any)
address-list: (any)
address-list-timeout: (any)
chain: (any)
comment: (any)
connection-bytes: (any)
connection-limit: (any)
connection-mark: (any)
connection-rate: (any)
connection-type: (any)
content: (any)
disabled: (any)
dscp: (any)
dst-address: (any)
dst-address-list: (any)
dst-address-type: (any)
dst-limit: (any)
dst-port: (any)
fragment: (any)
hotspot: (any)
icmp-options: (any)
in-bridge-port: (any)
in-bridge-port-list: (any)
in-interface: (any)
in-interface-list: (any)
ingress-priority: (any)
ipsec-policy: (any)
ipv4-options: (any)
jump-target: (any)
layer7-protocol: (any)
limit: (any)
log: (any)
log-prefix: (any)
nth: (any)
numbers: (any)
out-bridge-port: (any)
out-bridge-port-list: (any)
out-interface: (any)
out-interface-list: (any)
packet-mark: (any)
packet-size: (any)
per-connection-classifier: (any)
port: (any)
priority: (any)
protocol: (any)
psd: (any)
random: (any)
randomise-ports: (any)
realm: (any)
routing-mark: (any)
same-not-by-dst: (any)
src-address: (any)
src-address-list: (any)
src-address-type: (any)
src-mac-address: (any)
src-port: (any)
tcp-mss: (any)
time: (any)
tls-host: (any)
to-addresses: (any)
to-ports: (any)
ttl: (any)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ip/firewall/nat/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

all: (any)
append: (any)
as-value: (any)
chain: (any)
count-only: (any)
detail: (any)
dynamic: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
static: (any)
stats: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ip/firewall/nat/reset post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

action: (any)
address-list: (any)
address-list-timeout: (any)
chain: (any)
comment: (any)
connection-bytes: (any)
connection-limit: (any)
connection-mark: (any)
connection-rate: (any)
connection-type: (any)
content: (any)
disabled: (any)
dscp: (any)
dst-address: (any)
dst-address-list: (any)
dst-address-type: (any)
dst-limit: (any)
dst-port: (any)
fragment: (any)
hotspot: (any)
icmp-options: (any)
in-bridge-port: (any)
in-bridge-port-list: (any)
in-interface: (any)
in-interface-list: (any)
ingress-priority: (any)
ipsec-policy: (any)
ipv4-options: (any)
jump-target: (any)
layer7-protocol: (any)
limit: (any)
log: (any)
log-prefix: (any)
nth: (any)
numbers: (any)
out-bridge-port: (any)
out-bridge-port-list: (any)
out-interface: (any)
out-interface-list: (any)
packet-mark: (any)
packet-size: (any)
per-connection-classifier: (any)
port: (any)
priority: (any)
protocol: (any)
psd: (any)
random: (any)
randomise-ports: (any)
realm: (any)
routing-mark: (any)
same-not-by-dst: (any)
src-address: (any)
src-address-list: (any)
src-address-type: (any)
src-mac-address: (any)
src-port: (any)
tcp-mss: (any)
time: (any)
tls-host: (any)
to-addresses: (any)
to-ports: (any)
ttl: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ip/firewall/nat/set post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

action: (any)
address-list: (any)
address-list-timeout: (any)
chain: (any)
comment: (any)
connection-bytes: (any)
connection-limit: (any)
connection-mark: (any)
connection-rate: (any)
connection-type: (any)
content: (any)
disabled: (any)
dscp: (any)
dst-address: (any)
dst-address-list: (any)
dst-address-type: (any)
dst-limit: (any)
dst-port: (any)
fragment: (any)
hotspot: (any)
icmp-options: (any)
in-bridge-port: (any)
in-bridge-port-list: (any)
in-interface: (any)
in-interface-list: (any)
ingress-priority: (any)
ipsec-policy: (any)
ipv4-options: (any)
jump-target: (any)
layer7-protocol: (any)
limit: (any)
log: (any)
log-prefix: (any)
nth: (any)
numbers: (any)
out-bridge-port: (any)
out-bridge-port-list: (any)
out-interface: (any)
out-interface-list: (any)
packet-mark: (any)
packet-size: (any)
per-connection-classifier: (any)
port: (any)
priority: (any)
protocol: (any)
psd: (any)
random: (any)
randomise-ports: (any)
realm: (any)
routing-mark: (any)
same-not-by-dst: (any)
src-address: (any)
src-address-list: (any)
src-address-type: (any)
src-mac-address: (any)
src-port: (any)
tcp-mss: (any)
time: (any)
tls-host: (any)
to-addresses: (any)
to-ports: (any)
ttl: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ip/firewall/raw get put

get

put

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

action: (any)
address-list: (any)
address-list-timeout: (any)
chain: (any)
comment: (any)
content: (any)
copy-from: (any)
disabled: (any)
dscp: (any)
dst-address: (any)
dst-address-list: (any)
dst-address-type: (any)
dst-limit: (any)
dst-port: (any)
fragment: (any)
hotspot: (any)
icmp-options: (any)
in-bridge-port: (any)
in-bridge-port-list: (any)
in-interface: (any)
in-interface-list: (any)
ingress-priority: (any)
ipsec-policy: (any)
ipv4-options: (any)
jump-target: (any)
limit: (any)
log: (any)
log-prefix: (any)
nth: (any)
out-bridge-port: (any)
out-bridge-port-list: (any)
out-interface: (any)
out-interface-list: (any)
packet-mark: (any)
packet-size: (any)
per-connection-classifier: (any)
place-before: (any)
port: (any)
priority: (any)
protocol: (any)
psd: (any)
random: (any)
src-address: (any)
src-address-list: (any)
src-address-type: (any)
src-mac-address: (any)
src-port: (any)
tcp-flags: (any)
tcp-mss: (any)
time: (any)
tls-host: (any)
ttl: (any)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ip/firewall/raw/add post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

action: (any)
address-list: (any)
address-list-timeout: (any)
chain: (any)
comment: (any)
content: (any)
copy-from: (any)
disabled: (any)
dscp: (any)
dst-address: (any)
dst-address-list: (any)
dst-address-type: (any)
dst-limit: (any)
dst-port: (any)
fragment: (any)
hotspot: (any)
icmp-options: (any)
in-bridge-port: (any)
in-bridge-port-list: (any)
in-interface: (any)
in-interface-list: (any)
ingress-priority: (any)
ipsec-policy: (any)
ipv4-options: (any)
jump-target: (any)
limit: (any)
log: (any)
log-prefix: (any)
nth: (any)
out-bridge-port: (any)
out-bridge-port-list: (any)
out-interface: (any)
out-interface-list: (any)
packet-mark: (any)
packet-size: (any)
per-connection-classifier: (any)
place-before: (any)
port: (any)
priority: (any)
protocol: (any)
psd: (any)
random: (any)
src-address: (any)
src-address-list: (any)
src-address-type: (any)
src-mac-address: (any)
src-port: (any)
tcp-flags: (any)
tcp-mss: (any)
time: (any)
tls-host: (any)
ttl: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ip/firewall/raw/{id} get delete patch

get

delete

patch

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

URI Parameters

id: required(string)

Body

Media type: application/json

Type: object

Properties

action: (any)
address-list: (any)
address-list-timeout: (any)
chain: (any)
comment: (any)
content: (any)
disabled: (any)
dscp: (any)
dst-address: (any)
dst-address-list: (any)
dst-address-type: (any)
dst-limit: (any)
dst-port: (any)
fragment: (any)
hotspot: (any)
icmp-options: (any)
in-bridge-port: (any)
in-bridge-port-list: (any)
in-interface: (any)
in-interface-list: (any)
ingress-priority: (any)
ipsec-policy: (any)
ipv4-options: (any)
jump-target: (any)
limit: (any)
log: (any)
log-prefix: (any)
nth: (any)
numbers: (any)
out-bridge-port: (any)
out-bridge-port-list: (any)
out-interface: (any)
out-interface-list: (any)
packet-mark: (any)
packet-size: (any)
per-connection-classifier: (any)
port: (any)
priority: (any)
protocol: (any)
psd: (any)
random: (any)
src-address: (any)
src-address-list: (any)
src-address-type: (any)
src-mac-address: (any)
src-port: (any)
tcp-flags: (any)
tcp-mss: (any)
time: (any)
tls-host: (any)
ttl: (any)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ip/firewall/raw/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

all: (any)
append: (any)
as-value: (any)
chain: (any)
count-only: (any)
detail: (any)
dynamic: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
static: (any)
stats: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ip/firewall/raw/reset post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

action: (any)
address-list: (any)
address-list-timeout: (any)
chain: (any)
comment: (any)
content: (any)
disabled: (any)
dscp: (any)
dst-address: (any)
dst-address-list: (any)
dst-address-type: (any)
dst-limit: (any)
dst-port: (any)
fragment: (any)
hotspot: (any)
icmp-options: (any)
in-bridge-port: (any)
in-bridge-port-list: (any)
in-interface: (any)
in-interface-list: (any)
ingress-priority: (any)
ipsec-policy: (any)
ipv4-options: (any)
jump-target: (any)
limit: (any)
log: (any)
log-prefix: (any)
nth: (any)
numbers: (any)
out-bridge-port: (any)
out-bridge-port-list: (any)
out-interface: (any)
out-interface-list: (any)
packet-mark: (any)
packet-size: (any)
per-connection-classifier: (any)
port: (any)
priority: (any)
protocol: (any)
psd: (any)
random: (any)
src-address: (any)
src-address-list: (any)
src-address-type: (any)
src-mac-address: (any)
src-port: (any)
tcp-flags: (any)
tcp-mss: (any)
time: (any)
tls-host: (any)
ttl: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ip/firewall/raw/set post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

action: (any)
address-list: (any)
address-list-timeout: (any)
chain: (any)
comment: (any)
content: (any)
disabled: (any)
dscp: (any)
dst-address: (any)
dst-address-list: (any)
dst-address-type: (any)
dst-limit: (any)
dst-port: (any)
fragment: (any)
hotspot: (any)
icmp-options: (any)
in-bridge-port: (any)
in-bridge-port-list: (any)
in-interface: (any)
in-interface-list: (any)
ingress-priority: (any)
ipsec-policy: (any)
ipv4-options: (any)
jump-target: (any)
limit: (any)
log: (any)
log-prefix: (any)
nth: (any)
numbers: (any)
out-bridge-port: (any)
out-bridge-port-list: (any)
out-interface: (any)
out-interface-list: (any)
packet-mark: (any)
packet-size: (any)
per-connection-classifier: (any)
port: (any)
priority: (any)
protocol: (any)
psd: (any)
random: (any)
src-address: (any)
src-address-list: (any)
src-address-type: (any)
src-mac-address: (any)
src-port: (any)
tcp-flags: (any)
tcp-mss: (any)
time: (any)
tls-host: (any)
ttl: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ip/firewall/service-port/{id} get patch

get

patch

/ip/firewall/service-port/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ip/hotspot get put

get

put

/ip/hotspot/active get put

get

put

/ip/hotspot/active/{id} get delete patch

get

delete

patch

/ip/hotspot/active/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
oid: (any)
proplist: (any)
show-ids: (any)
stats: (any)
status: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ip/hotspot/add post

post

/ip/hotspot/cookie/{id} get delete

get

delete

/ip/hotspot/cookie/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ip/hotspot/{id} get delete patch

get

delete

patch

/ip/hotspot/host/{id} get delete

get

delete

/ip/hotspot/host/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
bytes: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
packets: (any)
proplist: (any)
show-ids: (any)
status: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ip/hotspot/ip-binding/{id} get delete

get

delete

/ip/hotspot/ip-binding/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ip/hotspot/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ip/hotspot/profile get put

get

put

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

copy-from: (any)
dns-name: (any)
hotspot-address: (any)
html-directory: (any)
html-directory-override: (any)
http-cookie-lifetime: (any)
http-proxy: (any)
install-hotspot-queue: (any)
login-by: (any)
mac-auth-mode: (any)
mac-auth-password: (any)
name: (any)
nas-port-type: (any)
radius-accounting: (any)
radius-default-domain: (any)
radius-interim-update: (any)
radius-location-id: (any)
radius-location-name: (any)
radius-mac-format: (any)
rate-limit: (any)
smtp-server: (any)
split-user-domain: (any)
ssl-certificate: (any)
trial-uptime-limit: (any)
trial-uptime-reset: (any)
trial-user-profile: (any)
use-radius: (any)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ip/hotspot/profile/add post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

copy-from: (any)
dns-name: (any)
hotspot-address: (any)
html-directory: (any)
html-directory-override: (any)
http-cookie-lifetime: (any)
http-proxy: (any)
install-hotspot-queue: (any)
login-by: (any)
mac-auth-mode: (any)
mac-auth-password: (any)
name: (any)
nas-port-type: (any)
radius-accounting: (any)
radius-default-domain: (any)
radius-interim-update: (any)
radius-location-id: (any)
radius-location-name: (any)
radius-mac-format: (any)
rate-limit: (any)
smtp-server: (any)
split-user-domain: (any)
ssl-certificate: (any)
trial-uptime-limit: (any)
trial-uptime-reset: (any)
trial-user-profile: (any)
use-radius: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ip/hotspot/profile/{id} get delete patch

get

delete

patch

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

URI Parameters

id: required(string)

Body

Media type: application/json

Type: object

Properties

dns-name: (any)
hotspot-address: (any)
html-directory: (any)
html-directory-override: (any)
http-cookie-lifetime: (any)
http-proxy: (any)
install-hotspot-queue: (any)
login-by: (any)
mac-auth-mode: (any)
mac-auth-password: (any)
name: (any)
nas-port-type: (any)
numbers: (any)
radius-accounting: (any)
radius-default-domain: (any)
radius-interim-update: (any)
radius-location-id: (any)
radius-location-name: (any)
radius-mac-format: (any)
rate-limit: (any)
smtp-server: (any)
split-user-domain: (any)
ssl-certificate: (any)
trial-uptime-limit: (any)
trial-uptime-reset: (any)
trial-user-profile: (any)
use-radius: (any)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ip/hotspot/profile/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ip/hotspot/profile/reset post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

dns-name: (any)
hotspot-address: (any)
html-directory: (any)
html-directory-override: (any)
http-cookie-lifetime: (any)
http-proxy: (any)
install-hotspot-queue: (any)
login-by: (any)
mac-auth-mode: (any)
mac-auth-password: (any)
name: (any)
nas-port-type: (any)
numbers: (any)
radius-accounting: (any)
radius-default-domain: (any)
radius-interim-update: (any)
radius-location-id: (any)
radius-location-name: (any)
radius-mac-format: (any)
rate-limit: (any)
smtp-server: (any)
split-user-domain: (any)
ssl-certificate: (any)
trial-uptime-limit: (any)
trial-uptime-reset: (any)
trial-user-profile: (any)
use-radius: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ip/hotspot/profile/set post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

dns-name: (any)
hotspot-address: (any)
html-directory: (any)
html-directory-override: (any)
http-cookie-lifetime: (any)
http-proxy: (any)
install-hotspot-queue: (any)
login-by: (any)
mac-auth-mode: (any)
mac-auth-password: (any)
name: (any)
nas-port-type: (any)
numbers: (any)
radius-accounting: (any)
radius-default-domain: (any)
radius-interim-update: (any)
radius-location-id: (any)
radius-location-name: (any)
radius-mac-format: (any)
rate-limit: (any)
smtp-server: (any)
split-user-domain: (any)
ssl-certificate: (any)
trial-uptime-limit: (any)
trial-uptime-reset: (any)
trial-user-profile: (any)
use-radius: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ip/hotspot/reset post

post

/ip/hotspot/service-port/{id} get patch

get

patch

/ip/hotspot/service-port/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ip/hotspot/set post

post

/ip/hotspot/user get put

get

put

/ip/hotspot/user/add post

post

/ip/hotspot/user/{id} get delete patch

get

delete

patch

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

URI Parameters

id: required(string)

Body

Media type: application/json

Type: object

Properties

address: (any)
comment: (any)
disabled: (any)
email: (any)
limit-bytes-in: (any)
limit-bytes-out: (any)
limit-bytes-total: (any)
limit-uptime: (any)
mac-address: (any)
name: (any)
numbers: (any)
password: (any)
profile: (any)
routes: (any)
server: (any)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ip/hotspot/user/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
bytes: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
packets: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ip/hotspot/user/profile get put

get

put

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

add-mac-cookie: (any)
address-list: (any)
address-pool: (any)
advertise: (any)
advertise-interval: (any)
advertise-timeout: (any)
advertise-url: (any)
copy-from: (any)
idle-timeout: (any)
incoming-filter: (any)
incoming-packet-mark: (any)
insert-queue-before: (any)
keepalive-timeout: (any)
mac-cookie-timeout: (any)
name: (any)
on-login: (any)
on-logout: (any)
open-status-page: (any)
outgoing-filter: (any)
outgoing-packet-mark: (any)
parent-queue: (any)
queue-type: (any)
rate-limit: (any)
session-timeout: (any)
shared-users: (any)
status-autorefresh: (any)
transparent-proxy: (any)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ip/hotspot/user/profile/add post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

add-mac-cookie: (any)
address-list: (any)
address-pool: (any)
advertise: (any)
advertise-interval: (any)
advertise-timeout: (any)
advertise-url: (any)
copy-from: (any)
idle-timeout: (any)
incoming-filter: (any)
incoming-packet-mark: (any)
insert-queue-before: (any)
keepalive-timeout: (any)
mac-cookie-timeout: (any)
name: (any)
on-login: (any)
on-logout: (any)
open-status-page: (any)
outgoing-filter: (any)
outgoing-packet-mark: (any)
parent-queue: (any)
queue-type: (any)
rate-limit: (any)
session-timeout: (any)
shared-users: (any)
status-autorefresh: (any)
transparent-proxy: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ip/hotspot/user/profile/{id} get delete patch

get

delete

patch

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

URI Parameters

id: required(string)

Body

Media type: application/json

Type: object

Properties

add-mac-cookie: (any)
address-list: (any)
address-pool: (any)
advertise: (any)
advertise-interval: (any)
advertise-timeout: (any)
advertise-url: (any)
idle-timeout: (any)
incoming-filter: (any)
incoming-packet-mark: (any)
insert-queue-before: (any)
keepalive-timeout: (any)
mac-cookie-timeout: (any)
name: (any)
numbers: (any)
on-login: (any)
on-logout: (any)
open-status-page: (any)
outgoing-filter: (any)
outgoing-packet-mark: (any)
parent-queue: (any)
queue-type: (any)
rate-limit: (any)
session-timeout: (any)
shared-users: (any)
status-autorefresh: (any)
transparent-proxy: (any)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ip/hotspot/user/profile/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ip/hotspot/user/profile/reset post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

add-mac-cookie: (any)
address-list: (any)
address-pool: (any)
advertise: (any)
advertise-interval: (any)
advertise-timeout: (any)
advertise-url: (any)
idle-timeout: (any)
incoming-filter: (any)
incoming-packet-mark: (any)
insert-queue-before: (any)
keepalive-timeout: (any)
mac-cookie-timeout: (any)
name: (any)
numbers: (any)
on-login: (any)
on-logout: (any)
open-status-page: (any)
outgoing-filter: (any)
outgoing-packet-mark: (any)
parent-queue: (any)
queue-type: (any)
rate-limit: (any)
session-timeout: (any)
shared-users: (any)
status-autorefresh: (any)
transparent-proxy: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ip/hotspot/user/profile/set post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

add-mac-cookie: (any)
address-list: (any)
address-pool: (any)
advertise: (any)
advertise-interval: (any)
advertise-timeout: (any)
advertise-url: (any)
idle-timeout: (any)
incoming-filter: (any)
incoming-packet-mark: (any)
insert-queue-before: (any)
keepalive-timeout: (any)
mac-cookie-timeout: (any)
name: (any)
numbers: (any)
on-login: (any)
on-logout: (any)
open-status-page: (any)
outgoing-filter: (any)
outgoing-packet-mark: (any)
parent-queue: (any)
queue-type: (any)
rate-limit: (any)
session-timeout: (any)
shared-users: (any)
status-autorefresh: (any)
transparent-proxy: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ip/hotspot/user/reset post

post

/ip/hotspot/user/set post

post

/ip/hotspot/walled-garden get put

get

put

/ip/hotspot/walled-garden/add post

post

/ip/hotspot/walled-garden/{id} get delete patch

get

delete

patch

/ip/hotspot/walled-garden/ip get put

get

put

/ip/hotspot/walled-garden/ip/add post

post

/ip/hotspot/walled-garden/ip/{id} get delete patch

get

delete

patch

/ip/hotspot/walled-garden/ip/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ip/hotspot/walled-garden/ip/reset post

post

/ip/hotspot/walled-garden/ip/set post

post

/ip/hotspot/walled-garden/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ip/hotspot/walled-garden/reset post

post

/ip/hotspot/walled-garden/set post

post

/ip/ipsec/active-peers get put

get

put

/ip/ipsec/active-peers/{id} get delete patch

get

delete

patch

/ip/ipsec/active-peers/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
stats: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ip/ipsec/identity get put

get

put

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

auth-method: (any)
certificate: (any)
comment: (any)
copy-from: (any)
disabled: (any)
eap-methods: (any)
generate-policy: (any)
key: (any)
match-by: (any)
mode-config: (any)
my-id: (any)
notrack-chain: (any)
password: (any)
peer: (any)
policy-template-group: (any)
remote-certificate: (any)
remote-id: (any)
remote-key: (any)
secret: (any)
username: (any)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ip/ipsec/identity/add post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

auth-method: (any)
certificate: (any)
comment: (any)
copy-from: (any)
disabled: (any)
eap-methods: (any)
generate-policy: (any)
key: (any)
match-by: (any)
mode-config: (any)
my-id: (any)
notrack-chain: (any)
password: (any)
peer: (any)
policy-template-group: (any)
remote-certificate: (any)
remote-id: (any)
remote-key: (any)
secret: (any)
username: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ip/ipsec/identity/{id} get delete patch

get

delete

patch

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

URI Parameters

id: required(string)

Body

Media type: application/json

Type: object

Properties

auth-method: (any)
certificate: (any)
comment: (any)
disabled: (any)
eap-methods: (any)
generate-policy: (any)
key: (any)
match-by: (any)
mode-config: (any)
my-id: (any)
notrack-chain: (any)
numbers: (any)
password: (any)
peer: (any)
policy-template-group: (any)
remote-certificate: (any)
remote-id: (any)
remote-key: (any)
secret: (any)
username: (any)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ip/ipsec/identity/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ip/ipsec/identity/reset post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

auth-method: (any)
certificate: (any)
comment: (any)
disabled: (any)
eap-methods: (any)
generate-policy: (any)
key: (any)
match-by: (any)
mode-config: (any)
my-id: (any)
notrack-chain: (any)
numbers: (any)
password: (any)
peer: (any)
policy-template-group: (any)
remote-certificate: (any)
remote-id: (any)
remote-key: (any)
secret: (any)
username: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ip/ipsec/identity/set post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

auth-method: (any)
certificate: (any)
comment: (any)
disabled: (any)
eap-methods: (any)
generate-policy: (any)
key: (any)
match-by: (any)
mode-config: (any)
my-id: (any)
notrack-chain: (any)
numbers: (any)
password: (any)
peer: (any)
policy-template-group: (any)
remote-certificate: (any)
remote-id: (any)
remote-key: (any)
secret: (any)
username: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ip/ipsec/installed-sa/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ip/ipsec/installed-sa/reset post

post

/ip/ipsec/key/{id} get delete patch

get

delete

patch

/ip/ipsec/key/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ip/ipsec/mode-config get put

get

put

/ip/ipsec/mode-config/add post

post

/ip/ipsec/mode-config/{id} get delete patch

get

delete

patch

/ip/ipsec/mode-config/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ip/ipsec/mode-config/reset post

post

/ip/ipsec/mode-config/set post

post

/ip/ipsec/peer get put

get

put

/ip/ipsec/peer/add post

post

/ip/ipsec/peer/{id} get delete patch

get

delete

patch

/ip/ipsec/peer/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ip/ipsec/peer/reset post

post

/ip/ipsec/peer/set post

post

/ip/ipsec/policy get put

get

put

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

action: (any)
comment: (any)
copy-from: (any)
disabled: (any)
dst-address: (any)
dst-port: (any)
group: (any)
ipsec-protocols: (any)
level: (any)
peer: (any)
place-before: (any)
proposal: (any)
protocol: (any)
sa-dst-address: (any)
sa-src-address: (any)
src-address: (any)
src-port: (any)
template: (any)
tunnel: (any)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ip/ipsec/policy/add post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

action: (any)
comment: (any)
copy-from: (any)
disabled: (any)
dst-address: (any)
dst-port: (any)
group: (any)
ipsec-protocols: (any)
level: (any)
peer: (any)
place-before: (any)
proposal: (any)
protocol: (any)
sa-dst-address: (any)
sa-src-address: (any)
src-address: (any)
src-port: (any)
template: (any)
tunnel: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ip/ipsec/policy/{id} get delete patch

get

delete

patch

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

URI Parameters

id: required(string)

Body

Media type: application/json

Type: object

Properties

action: (any)
comment: (any)
disabled: (any)
dst-address: (any)
dst-port: (any)
group: (any)
ipsec-protocols: (any)
level: (any)
numbers: (any)
peer: (any)
proposal: (any)
protocol: (any)
sa-dst-address: (any)
sa-src-address: (any)
src-address: (any)
src-port: (any)
template: (any)
tunnel: (any)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ip/ipsec/policy/group get put

get

put

/ip/ipsec/policy/group/{id} get delete patch

get

delete

patch

/ip/ipsec/policy/group/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ip/ipsec/policy/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ip/ipsec/policy/reset post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

action: (any)
comment: (any)
disabled: (any)
dst-address: (any)
dst-port: (any)
group: (any)
ipsec-protocols: (any)
level: (any)
numbers: (any)
peer: (any)
proposal: (any)
protocol: (any)
sa-dst-address: (any)
sa-src-address: (any)
src-address: (any)
src-port: (any)
template: (any)
tunnel: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ip/ipsec/policy/set post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

action: (any)
comment: (any)
disabled: (any)
dst-address: (any)
dst-port: (any)
group: (any)
ipsec-protocols: (any)
level: (any)
numbers: (any)
peer: (any)
proposal: (any)
protocol: (any)
sa-dst-address: (any)
sa-src-address: (any)
src-address: (any)
src-port: (any)
template: (any)
tunnel: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ip/ipsec/profile get put

get

put

/ip/ipsec/profile/add post

post

/ip/ipsec/profile/{id} get delete patch

get

delete

patch

/ip/ipsec/profile/print post

post

/ip/ipsec/profile/reset post

post

/ip/ipsec/profile/set post

post

/ip/ipsec/proposal get put

get

put

/ip/ipsec/proposal/add post

post

/ip/ipsec/proposal/{id} get delete patch

get

delete

patch

/ip/ipsec/proposal/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ip/ipsec/proposal/reset post

post

/ip/ipsec/proposal/set post

post

/ip/ipsec/settings/{id} get patch

get

patch

/ip/kid-control get put

get

put

/ip/kid-control/add post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

copy-from: (any)
disabled: (any)
fri: (any)
mon: (any)
name: (any)
rate-limit: (any)
sat: (any)
sun: (any)
thu: (any)
tue: (any)
tur-fri: (any)
tur-mon: (any)
tur-sat: (any)
tur-sun: (any)
tur-thu: (any)
tur-tue: (any)
tur-wed: (any)
wed: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ip/kid-control/device get put

get

put

/ip/kid-control/device/{id} get delete patch

get

delete

patch

/ip/kid-control/device/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

activity: (any)
all: (any)
append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
dynamic: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
static: (any)
stats: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ip/kid-control/{id} get delete patch

get

delete

patch

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

URI Parameters

id: required(string)

Body

Media type: application/json

Type: object

Properties

disabled: (any)
fri: (any)
mon: (any)
name: (any)
numbers: (any)
rate-limit: (any)
sat: (any)
sun: (any)
thu: (any)
tue: (any)
tur-fri: (any)
tur-mon: (any)
tur-sat: (any)
tur-sun: (any)
tur-thu: (any)
tur-tue: (any)
tur-wed: (any)
wed: (any)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ip/kid-control/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ip/kid-control/reset post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

disabled: (any)
fri: (any)
mon: (any)
name: (any)
numbers: (any)
rate-limit: (any)
sat: (any)
sun: (any)
thu: (any)
tue: (any)
tur-fri: (any)
tur-mon: (any)
tur-sat: (any)
tur-sun: (any)
tur-thu: (any)
tur-tue: (any)
tur-wed: (any)
wed: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ip/kid-control/set post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

disabled: (any)
fri: (any)
mon: (any)
name: (any)
numbers: (any)
rate-limit: (any)
sat: (any)
sun: (any)
thu: (any)
tue: (any)
tur-fri: (any)
tur-mon: (any)
tur-sat: (any)
tur-sun: (any)
tur-thu: (any)
tur-tue: (any)
tur-wed: (any)
wed: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ip/neighbor/discovery-settings/{id} get patch

get

patch

/ip/neighbor/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
oid: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ip/packing get put

get

put

/ip/packing/{id} get delete patch

get

delete

patch

/ip/packing/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ip/pool get put

get

put

/ip/pool/{id} get delete patch

get

delete

patch

/ip/pool/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ip/pool/used/{id} get patch

get

patch

/ip/pool/used/print post

post

/ip/proxy/access get put

get

put

/ip/proxy/access/add post

post

/ip/proxy/access/{id} get delete patch

get

delete

patch

/ip/proxy/access/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ip/proxy/access/reset post

post

/ip/proxy/access/set post

post

/ip/proxy/cache get put

get

put

/ip/proxy/cache/add post

post

/ip/proxy/cache/{id} get delete patch

get

delete

patch

/ip/proxy/cache/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ip/proxy/cache/reset post

post

/ip/proxy/cache/set post

post

/ip/proxy/cache-contents get put

get

put

/ip/proxy/cache-contents/{id} get delete

get

delete

/ip/proxy/cache-contents/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ip/proxy/connections/{id} get delete patch

get

delete

patch

/ip/proxy/connections/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ip/proxy/direct get put

get

put

/ip/proxy/direct/add post

post

/ip/proxy/direct/{id} get delete patch

get

delete

patch

/ip/proxy/direct/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ip/proxy/direct/reset post

post

/ip/proxy/direct/set post

post

/ip/proxy/{id} get patch

get

patch

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

URI Parameters

id: required(string)

Body

Media type: application/json

Type: object

Properties

always-from-cache: (any)
anonymous: (any)
cache-administrator: (any)
cache-hit-dscp: (any)
cache-on-disk: (any)
cache-path: (any)
enabled: (any)
max-cache-object-size: (any)
max-cache-size: (any)
max-client-connections: (any)
max-fresh-time: (any)
max-server-connections: (any)
parent-proxy: (any)
parent-proxy-port: (any)
port: (any)
serialize-connections: (any)
src-address: (any)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ip/proxy/set post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

always-from-cache: (any)
anonymous: (any)
cache-administrator: (any)
cache-hit-dscp: (any)
cache-on-disk: (any)
cache-path: (any)
enabled: (any)
max-cache-object-size: (any)
max-cache-size: (any)
max-client-connections: (any)
max-fresh-time: (any)
max-server-connections: (any)
parent-proxy: (any)
parent-proxy-port: (any)
port: (any)
serialize-connections: (any)
src-address: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ip/route get put

get

put

/ip/route/add post

post

/ip/route/{id} get delete patch

get

delete

patch

/ip/route/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
stats: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ip/route/reset post

post

/ip/route/set post

post

/ip/service/{id} get patch

get

patch

/ip/service/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ip/settings/{id} get patch

get

patch

/ip/settings/set post

post

/ip/smb/{id} get patch

get

patch

/ip/smb/shares get put

get

put

/ip/smb/shares/{id} get delete patch

get

delete

patch

/ip/smb/shares/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ip/smb/users get put

get

put

/ip/smb/users/{id} get delete patch

get

delete

patch

/ip/smb/users/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ip/socks/access get put

get

put

/ip/socks/access/add post

post

/ip/socks/access/{id} get delete patch

get

delete

patch

/ip/socks/access/print post

post

/ip/socks/access/reset post

post

/ip/socks/access/set post

post

/ip/socks/connections/{id} get delete

get

delete

/ip/socks/connections/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ip/socks/{id} get patch

get

patch

/ip/socks/users get put

get

put

/ip/socks/users/{id} get delete patch

get

delete

patch

/ip/socks/users/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ip/ssh/{id} get patch

get

patch

/ip/tftp get put

get

put

/ip/tftp/add post

post

/ip/tftp/{id} get delete patch

get

delete

patch

/ip/tftp/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ip/tftp/reset post

post

/ip/tftp/set post

post

/ip/tftp/settings/{id} get patch

get

patch

/ip/traffic-flow/{id} get patch

get

patch

/ip/traffic-flow/ipfix/{id} get patch

get

patch

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

URI Parameters

id: required(string)

Body

Media type: application/json

Type: object

Properties

bytes: (any)
dst-address: (any)
dst-address-mask: (any)
dst-mac-address: (any)
dst-port: (any)
first-forwarded: (any)
gateway: (any)
icmp-code: (any)
icmp-type: (any)
igmp-type: (any)
in-interface: (any)
ip-header-length: (any)
ip-total-length: (any)
ipv6-flow-label: (any)
is-multicast: (any)
last-forwarded: (any)
nat-dst-address: (any)
nat-dst-port: (any)
nat-events: (any)
nat-src-address: (any)
nat-src-port: (any)
out-interface: (any)
packets: (any)
protocol: (any)
src-address: (any)
src-address-mask: (any)
src-mac-address: (any)
src-port: (any)
sys-init-time: (any)
tcp-ack-num: (any)
tcp-flags: (any)
tcp-seq-num: (any)
tcp-window-size: (any)
tos: (any)
ttl: (any)
udp-length: (any)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ip/traffic-flow/ipfix/set post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

bytes: (any)
dst-address: (any)
dst-address-mask: (any)
dst-mac-address: (any)
dst-port: (any)
first-forwarded: (any)
gateway: (any)
icmp-code: (any)
icmp-type: (any)
igmp-type: (any)
in-interface: (any)
ip-header-length: (any)
ip-total-length: (any)
ipv6-flow-label: (any)
is-multicast: (any)
last-forwarded: (any)
nat-dst-address: (any)
nat-dst-port: (any)
nat-events: (any)
nat-src-address: (any)
nat-src-port: (any)
out-interface: (any)
packets: (any)
protocol: (any)
src-address: (any)
src-address-mask: (any)
src-mac-address: (any)
src-port: (any)
sys-init-time: (any)
tcp-ack-num: (any)
tcp-flags: (any)
tcp-seq-num: (any)
tcp-window-size: (any)
tos: (any)
ttl: (any)
udp-length: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ip/traffic-flow/monitor post

post

/ip/traffic-flow/set post

post

/ip/traffic-flow/target get put

get

put

/ip/traffic-flow/target/add post

post

/ip/traffic-flow/target/{id} get delete patch

get

delete

patch

/ip/traffic-flow/target/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ip/traffic-flow/target/reset post

post

/ip/traffic-flow/target/set post

post

/ip/upnp/{id} get patch

get

patch

/ip/upnp/interfaces/{id} get delete

get

delete

/ip/upnp/interfaces/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ip/vrf get put

get

put

/ip/vrf/{id} get delete patch

get

delete

patch

/ip/vrf/print post

post

/ipv6

/ipv6/address get put

get

put

/ipv6/address/add post

post

/ipv6/address/{id} get delete patch

get

delete

patch

/ipv6/address/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ipv6/address/reset post

post

/ipv6/address/set post

post

/ipv6/dhcp-client get put

get

put

/ipv6/dhcp-client/add post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

add-default-route: (any)
comment: (any)
copy-from: (any)
default-route-distance: (any)
dhcp-options: (any)
disabled: (any)
interface: (any)
pool-name: (any)
pool-prefix-length: (any)
prefix-hint: (any)
rapid-commit: (any)
request: (any)
script: (any)
use-interface-duid: (any)
use-peer-dns: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ipv6/dhcp-client/{id} get delete patch

get

delete

patch

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

URI Parameters

id: required(string)

Body

Media type: application/json

Type: object

Properties

add-default-route: (any)
comment: (any)
default-route-distance: (any)
dhcp-options: (any)
disabled: (any)
interface: (any)
numbers: (any)
pool-name: (any)
pool-prefix-length: (any)
prefix-hint: (any)
rapid-commit: (any)
request: (any)
script: (any)
use-interface-duid: (any)
use-peer-dns: (any)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ipv6/dhcp-client/option get put

get

put

/ipv6/dhcp-client/option/{id} get delete patch

get

delete

patch

/ipv6/dhcp-client/option/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ipv6/dhcp-client/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ipv6/dhcp-client/reset post

post

/ipv6/dhcp-client/set post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

add-default-route: (any)
comment: (any)
default-route-distance: (any)
dhcp-options: (any)
disabled: (any)
interface: (any)
numbers: (any)
pool-name: (any)
pool-prefix-length: (any)
prefix-hint: (any)
rapid-commit: (any)
request: (any)
script: (any)
use-interface-duid: (any)
use-peer-dns: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ipv6/dhcp-relay get put

get

put

/ipv6/dhcp-relay/add post

post

/ipv6/dhcp-relay/{id} get delete patch

get

delete

patch

/ipv6/dhcp-relay/monitor post

post

/ipv6/dhcp-relay/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ipv6/dhcp-relay/reset post

post

/ipv6/dhcp-relay/set post

post

/ipv6/dhcp-server get put

get

put

/ipv6/dhcp-server/add post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

address-pool: (any)
allow-dual-stack-queue: (any)
binding-script: (any)
comment: (any)
copy-from: (any)
dhcp-option: (any)
disabled: (any)
insert-queue-before: (any)
interface: (any)
lease-time: (any)
name: (any)
parent-queue: (any)
preference: (any)
rapid-commit: (any)
route-distance: (any)
use-radius: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ipv6/dhcp-server/binding get put

get

put

/ipv6/dhcp-server/binding/add post

post

/ipv6/dhcp-server/binding/{id} get delete patch

get

delete

patch

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

URI Parameters

id: required(string)

Body

Media type: application/json

Type: object

Properties

address: (any)
address-lists: (any)
allow-dual-stack-queue: (any)
comment: (any)
dhcp-option: (any)
disabled: (any)
duid: (any)
iaid: (any)
insert-queue-before: (any)
life-time: (any)
numbers: (any)
prefix-pool: (any)
queue-type: (any)
rate-limit: (any)
server: (any)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ipv6/dhcp-server/binding/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

active: (any)
append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ipv6/dhcp-server/binding/reset post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

address: (any)
address-lists: (any)
allow-dual-stack-queue: (any)
comment: (any)
dhcp-option: (any)
disabled: (any)
duid: (any)
iaid: (any)
insert-queue-before: (any)
life-time: (any)
numbers: (any)
prefix-pool: (any)
queue-type: (any)
rate-limit: (any)
server: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ipv6/dhcp-server/binding/set post

post

/ipv6/dhcp-server/{id} get delete patch

get

delete

patch

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

URI Parameters

id: required(string)

Body

Media type: application/json

Type: object

Properties

address-pool: (any)
allow-dual-stack-queue: (any)
binding-script: (any)
comment: (any)
dhcp-option: (any)
disabled: (any)
insert-queue-before: (any)
interface: (any)
lease-time: (any)
name: (any)
numbers: (any)
parent-queue: (any)
preference: (any)
rapid-commit: (any)
route-distance: (any)
use-radius: (any)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ipv6/dhcp-server/option get put

get

put

/ipv6/dhcp-server/option/{id} get delete patch

get

delete

patch

/ipv6/dhcp-server/option/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ipv6/dhcp-server/option/sets get put

get

put

/ipv6/dhcp-server/option/sets/{id} get delete patch

get

delete

patch

/ipv6/dhcp-server/option/sets/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ipv6/dhcp-server/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ipv6/dhcp-server/reset post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

address-pool: (any)
allow-dual-stack-queue: (any)
binding-script: (any)
comment: (any)
dhcp-option: (any)
disabled: (any)
insert-queue-before: (any)
interface: (any)
lease-time: (any)
name: (any)
numbers: (any)
parent-queue: (any)
preference: (any)
rapid-commit: (any)
route-distance: (any)
use-radius: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ipv6/dhcp-server/set post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

address-pool: (any)
allow-dual-stack-queue: (any)
binding-script: (any)
comment: (any)
dhcp-option: (any)
disabled: (any)
insert-queue-before: (any)
interface: (any)
lease-time: (any)
name: (any)
numbers: (any)
parent-queue: (any)
preference: (any)
rapid-commit: (any)
route-distance: (any)
use-radius: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ipv6/firewall/address-list get put

get

put

/ipv6/firewall/address-list/add post

post

/ipv6/firewall/address-list/{id} get delete patch

get

delete

patch

/ipv6/firewall/address-list/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ipv6/firewall/address-list/reset post

post

/ipv6/firewall/address-list/set post

post

/ipv6/firewall/connection/{id} get delete

get

delete

/ipv6/firewall/connection/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ipv6/firewall/filter get put

get

put

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

action: (any)
address-list: (any)
address-list-timeout: (any)
chain: (any)
comment: (any)
connection-bytes: (any)
connection-limit: (any)
connection-mark: (any)
connection-nat-state: (any)
connection-rate: (any)
connection-state: (any)
connection-type: (any)
content: (any)
copy-from: (any)
disabled: (any)
dscp: (any)
dst-address: (any)
dst-address-list: (any)
dst-address-type: (any)
dst-limit: (any)
dst-port: (any)
headers: (any)
hop-limit: (any)
icmp-options: (any)
in-bridge-port: (any)
in-bridge-port-list: (any)
in-interface: (any)
in-interface-list: (any)
ingress-priority: (any)
ipsec-policy: (any)
jump-target: (any)
limit: (any)
log: (any)
log-prefix: (any)
nth: (any)
out-bridge-port: (any)
out-bridge-port-list: (any)
out-interface: (any)
out-interface-list: (any)
packet-mark: (any)
packet-size: (any)
per-connection-classifier: (any)
place-before: (any)
port: (any)
priority: (any)
protocol: (any)
random: (any)
reject-with: (any)
routing-mark: (any)
src-address: (any)
src-address-list: (any)
src-address-type: (any)
src-mac-address: (any)
src-port: (any)
tcp-flags: (any)
tcp-mss: (any)
time: (any)
tls-host: (any)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ipv6/firewall/filter/add post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

action: (any)
address-list: (any)
address-list-timeout: (any)
chain: (any)
comment: (any)
connection-bytes: (any)
connection-limit: (any)
connection-mark: (any)
connection-nat-state: (any)
connection-rate: (any)
connection-state: (any)
connection-type: (any)
content: (any)
copy-from: (any)
disabled: (any)
dscp: (any)
dst-address: (any)
dst-address-list: (any)
dst-address-type: (any)
dst-limit: (any)
dst-port: (any)
headers: (any)
hop-limit: (any)
icmp-options: (any)
in-bridge-port: (any)
in-bridge-port-list: (any)
in-interface: (any)
in-interface-list: (any)
ingress-priority: (any)
ipsec-policy: (any)
jump-target: (any)
limit: (any)
log: (any)
log-prefix: (any)
nth: (any)
out-bridge-port: (any)
out-bridge-port-list: (any)
out-interface: (any)
out-interface-list: (any)
packet-mark: (any)
packet-size: (any)
per-connection-classifier: (any)
place-before: (any)
port: (any)
priority: (any)
protocol: (any)
random: (any)
reject-with: (any)
routing-mark: (any)
src-address: (any)
src-address-list: (any)
src-address-type: (any)
src-mac-address: (any)
src-port: (any)
tcp-flags: (any)
tcp-mss: (any)
time: (any)
tls-host: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ipv6/firewall/filter/{id} get delete patch

get

delete

patch

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

URI Parameters

id: required(string)

Body

Media type: application/json

Type: object

Properties

action: (any)
address-list: (any)
address-list-timeout: (any)
chain: (any)
comment: (any)
connection-bytes: (any)
connection-limit: (any)
connection-mark: (any)
connection-nat-state: (any)
connection-rate: (any)
connection-state: (any)
connection-type: (any)
content: (any)
disabled: (any)
dscp: (any)
dst-address: (any)
dst-address-list: (any)
dst-address-type: (any)
dst-limit: (any)
dst-port: (any)
headers: (any)
hop-limit: (any)
icmp-options: (any)
in-bridge-port: (any)
in-bridge-port-list: (any)
in-interface: (any)
in-interface-list: (any)
ingress-priority: (any)
ipsec-policy: (any)
jump-target: (any)
limit: (any)
log: (any)
log-prefix: (any)
nth: (any)
numbers: (any)
out-bridge-port: (any)
out-bridge-port-list: (any)
out-interface: (any)
out-interface-list: (any)
packet-mark: (any)
packet-size: (any)
per-connection-classifier: (any)
port: (any)
priority: (any)
protocol: (any)
random: (any)
reject-with: (any)
routing-mark: (any)
src-address: (any)
src-address-list: (any)
src-address-type: (any)
src-mac-address: (any)
src-port: (any)
tcp-flags: (any)
tcp-mss: (any)
time: (any)
tls-host: (any)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ipv6/firewall/filter/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
stats: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ipv6/firewall/filter/reset post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

action: (any)
address-list: (any)
address-list-timeout: (any)
chain: (any)
comment: (any)
connection-bytes: (any)
connection-limit: (any)
connection-mark: (any)
connection-nat-state: (any)
connection-rate: (any)
connection-state: (any)
connection-type: (any)
content: (any)
disabled: (any)
dscp: (any)
dst-address: (any)
dst-address-list: (any)
dst-address-type: (any)
dst-limit: (any)
dst-port: (any)
headers: (any)
hop-limit: (any)
icmp-options: (any)
in-bridge-port: (any)
in-bridge-port-list: (any)
in-interface: (any)
in-interface-list: (any)
ingress-priority: (any)
ipsec-policy: (any)
jump-target: (any)
limit: (any)
log: (any)
log-prefix: (any)
nth: (any)
numbers: (any)
out-bridge-port: (any)
out-bridge-port-list: (any)
out-interface: (any)
out-interface-list: (any)
packet-mark: (any)
packet-size: (any)
per-connection-classifier: (any)
port: (any)
priority: (any)
protocol: (any)
random: (any)
reject-with: (any)
routing-mark: (any)
src-address: (any)
src-address-list: (any)
src-address-type: (any)
src-mac-address: (any)
src-port: (any)
tcp-flags: (any)
tcp-mss: (any)
time: (any)
tls-host: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ipv6/firewall/filter/set post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

action: (any)
address-list: (any)
address-list-timeout: (any)
chain: (any)
comment: (any)
connection-bytes: (any)
connection-limit: (any)
connection-mark: (any)
connection-nat-state: (any)
connection-rate: (any)
connection-state: (any)
connection-type: (any)
content: (any)
disabled: (any)
dscp: (any)
dst-address: (any)
dst-address-list: (any)
dst-address-type: (any)
dst-limit: (any)
dst-port: (any)
headers: (any)
hop-limit: (any)
icmp-options: (any)
in-bridge-port: (any)
in-bridge-port-list: (any)
in-interface: (any)
in-interface-list: (any)
ingress-priority: (any)
ipsec-policy: (any)
jump-target: (any)
limit: (any)
log: (any)
log-prefix: (any)
nth: (any)
numbers: (any)
out-bridge-port: (any)
out-bridge-port-list: (any)
out-interface: (any)
out-interface-list: (any)
packet-mark: (any)
packet-size: (any)
per-connection-classifier: (any)
port: (any)
priority: (any)
protocol: (any)
random: (any)
reject-with: (any)
routing-mark: (any)
src-address: (any)
src-address-list: (any)
src-address-type: (any)
src-mac-address: (any)
src-port: (any)
tcp-flags: (any)
tcp-mss: (any)
time: (any)
tls-host: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ipv6/firewall/mangle get put

get

put

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

action: (any)
address-list: (any)
address-list-timeout: (any)
chain: (any)
comment: (any)
connection-bytes: (any)
connection-limit: (any)
connection-mark: (any)
connection-nat-state: (any)
connection-rate: (any)
connection-state: (any)
connection-type: (any)
content: (any)
copy-from: (any)
disabled: (any)
dscp: (any)
dst-address: (any)
dst-address-list: (any)
dst-address-type: (any)
dst-limit: (any)
dst-port: (any)
dst-prefix: (any)
headers: (any)
hop-limit: (any)
icmp-options: (any)
in-bridge-port: (any)
in-bridge-port-list: (any)
in-interface: (any)
in-interface-list: (any)
ingress-priority: (any)
ipsec-policy: (any)
jump-target: (any)
limit: (any)
log: (any)
log-prefix: (any)
new-connection-mark: (any)
new-dscp: (any)
new-hop-limit: (any)
new-mss: (any)
new-packet-mark: (any)
new-priority: (any)
new-routing-mark: (any)
nth: (any)
out-bridge-port: (any)
out-bridge-port-list: (any)
out-interface: (any)
out-interface-list: (any)
packet-mark: (any)
packet-size: (any)
passthrough: (any)
per-connection-classifier: (any)
place-before: (any)
port: (any)
priority: (any)
protocol: (any)
random: (any)
routing-mark: (any)
sniff-id: (any)
sniff-target: (any)
sniff-target-port: (any)
src-address: (any)
src-address-list: (any)
src-address-type: (any)
src-mac-address: (any)
src-port: (any)
src-prefix: (any)
tcp-flags: (any)
tcp-mss: (any)
time: (any)
tls-host: (any)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ipv6/firewall/mangle/add post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

action: (any)
address-list: (any)
address-list-timeout: (any)
chain: (any)
comment: (any)
connection-bytes: (any)
connection-limit: (any)
connection-mark: (any)
connection-nat-state: (any)
connection-rate: (any)
connection-state: (any)
connection-type: (any)
content: (any)
copy-from: (any)
disabled: (any)
dscp: (any)
dst-address: (any)
dst-address-list: (any)
dst-address-type: (any)
dst-limit: (any)
dst-port: (any)
dst-prefix: (any)
headers: (any)
hop-limit: (any)
icmp-options: (any)
in-bridge-port: (any)
in-bridge-port-list: (any)
in-interface: (any)
in-interface-list: (any)
ingress-priority: (any)
ipsec-policy: (any)
jump-target: (any)
limit: (any)
log: (any)
log-prefix: (any)
new-connection-mark: (any)
new-dscp: (any)
new-hop-limit: (any)
new-mss: (any)
new-packet-mark: (any)
new-priority: (any)
new-routing-mark: (any)
nth: (any)
out-bridge-port: (any)
out-bridge-port-list: (any)
out-interface: (any)
out-interface-list: (any)
packet-mark: (any)
packet-size: (any)
passthrough: (any)
per-connection-classifier: (any)
place-before: (any)
port: (any)
priority: (any)
protocol: (any)
random: (any)
routing-mark: (any)
sniff-id: (any)
sniff-target: (any)
sniff-target-port: (any)
src-address: (any)
src-address-list: (any)
src-address-type: (any)
src-mac-address: (any)
src-port: (any)
src-prefix: (any)
tcp-flags: (any)
tcp-mss: (any)
time: (any)
tls-host: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ipv6/firewall/mangle/{id} get delete patch

get

delete

patch

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

URI Parameters

id: required(string)

Body

Media type: application/json

Type: object

Properties

action: (any)
address-list: (any)
address-list-timeout: (any)
chain: (any)
comment: (any)
connection-bytes: (any)
connection-limit: (any)
connection-mark: (any)
connection-nat-state: (any)
connection-rate: (any)
connection-state: (any)
connection-type: (any)
content: (any)
disabled: (any)
dscp: (any)
dst-address: (any)
dst-address-list: (any)
dst-address-type: (any)
dst-limit: (any)
dst-port: (any)
dst-prefix: (any)
headers: (any)
hop-limit: (any)
icmp-options: (any)
in-bridge-port: (any)
in-bridge-port-list: (any)
in-interface: (any)
in-interface-list: (any)
ingress-priority: (any)
ipsec-policy: (any)
jump-target: (any)
limit: (any)
log: (any)
log-prefix: (any)
new-connection-mark: (any)
new-dscp: (any)
new-hop-limit: (any)
new-mss: (any)
new-packet-mark: (any)
new-priority: (any)
new-routing-mark: (any)
nth: (any)
numbers: (any)
out-bridge-port: (any)
out-bridge-port-list: (any)
out-interface: (any)
out-interface-list: (any)
packet-mark: (any)
packet-size: (any)
passthrough: (any)
per-connection-classifier: (any)
port: (any)
priority: (any)
protocol: (any)
random: (any)
routing-mark: (any)
sniff-id: (any)
sniff-target: (any)
sniff-target-port: (any)
src-address: (any)
src-address-list: (any)
src-address-type: (any)
src-mac-address: (any)
src-port: (any)
src-prefix: (any)
tcp-flags: (any)
tcp-mss: (any)
time: (any)
tls-host: (any)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ipv6/firewall/mangle/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
stats: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ipv6/firewall/mangle/reset post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

action: (any)
address-list: (any)
address-list-timeout: (any)
chain: (any)
comment: (any)
connection-bytes: (any)
connection-limit: (any)
connection-mark: (any)
connection-nat-state: (any)
connection-rate: (any)
connection-state: (any)
connection-type: (any)
content: (any)
disabled: (any)
dscp: (any)
dst-address: (any)
dst-address-list: (any)
dst-address-type: (any)
dst-limit: (any)
dst-port: (any)
dst-prefix: (any)
headers: (any)
hop-limit: (any)
icmp-options: (any)
in-bridge-port: (any)
in-bridge-port-list: (any)
in-interface: (any)
in-interface-list: (any)
ingress-priority: (any)
ipsec-policy: (any)
jump-target: (any)
limit: (any)
log: (any)
log-prefix: (any)
new-connection-mark: (any)
new-dscp: (any)
new-hop-limit: (any)
new-mss: (any)
new-packet-mark: (any)
new-priority: (any)
new-routing-mark: (any)
nth: (any)
numbers: (any)
out-bridge-port: (any)
out-bridge-port-list: (any)
out-interface: (any)
out-interface-list: (any)
packet-mark: (any)
packet-size: (any)
passthrough: (any)
per-connection-classifier: (any)
port: (any)
priority: (any)
protocol: (any)
random: (any)
routing-mark: (any)
sniff-id: (any)
sniff-target: (any)
sniff-target-port: (any)
src-address: (any)
src-address-list: (any)
src-address-type: (any)
src-mac-address: (any)
src-port: (any)
src-prefix: (any)
tcp-flags: (any)
tcp-mss: (any)
time: (any)
tls-host: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ipv6/firewall/mangle/set post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

action: (any)
address-list: (any)
address-list-timeout: (any)
chain: (any)
comment: (any)
connection-bytes: (any)
connection-limit: (any)
connection-mark: (any)
connection-nat-state: (any)
connection-rate: (any)
connection-state: (any)
connection-type: (any)
content: (any)
disabled: (any)
dscp: (any)
dst-address: (any)
dst-address-list: (any)
dst-address-type: (any)
dst-limit: (any)
dst-port: (any)
dst-prefix: (any)
headers: (any)
hop-limit: (any)
icmp-options: (any)
in-bridge-port: (any)
in-bridge-port-list: (any)
in-interface: (any)
in-interface-list: (any)
ingress-priority: (any)
ipsec-policy: (any)
jump-target: (any)
limit: (any)
log: (any)
log-prefix: (any)
new-connection-mark: (any)
new-dscp: (any)
new-hop-limit: (any)
new-mss: (any)
new-packet-mark: (any)
new-priority: (any)
new-routing-mark: (any)
nth: (any)
numbers: (any)
out-bridge-port: (any)
out-bridge-port-list: (any)
out-interface: (any)
out-interface-list: (any)
packet-mark: (any)
packet-size: (any)
passthrough: (any)
per-connection-classifier: (any)
port: (any)
priority: (any)
protocol: (any)
random: (any)
routing-mark: (any)
sniff-id: (any)
sniff-target: (any)
sniff-target-port: (any)
src-address: (any)
src-address-list: (any)
src-address-type: (any)
src-mac-address: (any)
src-port: (any)
src-prefix: (any)
tcp-flags: (any)
tcp-mss: (any)
time: (any)
tls-host: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ipv6/firewall/nat get put

get

put

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

action: (any)
address-list: (any)
address-list-timeout: (any)
chain: (any)
comment: (any)
connection-bytes: (any)
connection-limit: (any)
connection-mark: (any)
connection-rate: (any)
connection-state: (any)
connection-type: (any)
content: (any)
copy-from: (any)
disabled: (any)
dscp: (any)
dst-address: (any)
dst-address-list: (any)
dst-address-type: (any)
dst-limit: (any)
dst-port: (any)
headers: (any)
hop-limit: (any)
icmp-options: (any)
in-bridge-port: (any)
in-bridge-port-list: (any)
in-interface: (any)
in-interface-list: (any)
ingress-priority: (any)
ipsec-policy: (any)
jump-target: (any)
limit: (any)
log: (any)
log-prefix: (any)
nth: (any)
out-bridge-port: (any)
out-bridge-port-list: (any)
out-interface: (any)
out-interface-list: (any)
packet-mark: (any)
packet-size: (any)
per-connection-classifier: (any)
place-before: (any)
port: (any)
priority: (any)
protocol: (any)
random: (any)
routing-mark: (any)
src-address: (any)
src-address-list: (any)
src-address-type: (any)
src-mac-address: (any)
src-port: (any)
tcp-flags: (any)
tcp-mss: (any)
time: (any)
tls-host: (any)
to-address: (any)
to-ports: (any)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ipv6/firewall/nat/add post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

action: (any)
address-list: (any)
address-list-timeout: (any)
chain: (any)
comment: (any)
connection-bytes: (any)
connection-limit: (any)
connection-mark: (any)
connection-rate: (any)
connection-state: (any)
connection-type: (any)
content: (any)
copy-from: (any)
disabled: (any)
dscp: (any)
dst-address: (any)
dst-address-list: (any)
dst-address-type: (any)
dst-limit: (any)
dst-port: (any)
headers: (any)
hop-limit: (any)
icmp-options: (any)
in-bridge-port: (any)
in-bridge-port-list: (any)
in-interface: (any)
in-interface-list: (any)
ingress-priority: (any)
ipsec-policy: (any)
jump-target: (any)
limit: (any)
log: (any)
log-prefix: (any)
nth: (any)
out-bridge-port: (any)
out-bridge-port-list: (any)
out-interface: (any)
out-interface-list: (any)
packet-mark: (any)
packet-size: (any)
per-connection-classifier: (any)
place-before: (any)
port: (any)
priority: (any)
protocol: (any)
random: (any)
routing-mark: (any)
src-address: (any)
src-address-list: (any)
src-address-type: (any)
src-mac-address: (any)
src-port: (any)
tcp-flags: (any)
tcp-mss: (any)
time: (any)
tls-host: (any)
to-address: (any)
to-ports: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ipv6/firewall/nat/{id} get delete patch

get

delete

patch

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

URI Parameters

id: required(string)

Body

Media type: application/json

Type: object

Properties

action: (any)
address-list: (any)
address-list-timeout: (any)
chain: (any)
comment: (any)
connection-bytes: (any)
connection-limit: (any)
connection-mark: (any)
connection-rate: (any)
connection-state: (any)
connection-type: (any)
content: (any)
disabled: (any)
dscp: (any)
dst-address: (any)
dst-address-list: (any)
dst-address-type: (any)
dst-limit: (any)
dst-port: (any)
headers: (any)
hop-limit: (any)
icmp-options: (any)
in-bridge-port: (any)
in-bridge-port-list: (any)
in-interface: (any)
in-interface-list: (any)
ingress-priority: (any)
ipsec-policy: (any)
jump-target: (any)
limit: (any)
log: (any)
log-prefix: (any)
nth: (any)
numbers: (any)
out-bridge-port: (any)
out-bridge-port-list: (any)
out-interface: (any)
out-interface-list: (any)
packet-mark: (any)
packet-size: (any)
per-connection-classifier: (any)
port: (any)
priority: (any)
protocol: (any)
random: (any)
routing-mark: (any)
src-address: (any)
src-address-list: (any)
src-address-type: (any)
src-mac-address: (any)
src-port: (any)
tcp-flags: (any)
tcp-mss: (any)
time: (any)
tls-host: (any)
to-address: (any)
to-ports: (any)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ipv6/firewall/nat/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
count-only: (any)
detail: (any)
dynamic: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
static: (any)
stats: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ipv6/firewall/nat/reset post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

action: (any)
address-list: (any)
address-list-timeout: (any)
chain: (any)
comment: (any)
connection-bytes: (any)
connection-limit: (any)
connection-mark: (any)
connection-rate: (any)
connection-state: (any)
connection-type: (any)
content: (any)
disabled: (any)
dscp: (any)
dst-address: (any)
dst-address-list: (any)
dst-address-type: (any)
dst-limit: (any)
dst-port: (any)
headers: (any)
hop-limit: (any)
icmp-options: (any)
in-bridge-port: (any)
in-bridge-port-list: (any)
in-interface: (any)
in-interface-list: (any)
ingress-priority: (any)
ipsec-policy: (any)
jump-target: (any)
limit: (any)
log: (any)
log-prefix: (any)
nth: (any)
numbers: (any)
out-bridge-port: (any)
out-bridge-port-list: (any)
out-interface: (any)
out-interface-list: (any)
packet-mark: (any)
packet-size: (any)
per-connection-classifier: (any)
port: (any)
priority: (any)
protocol: (any)
random: (any)
routing-mark: (any)
src-address: (any)
src-address-list: (any)
src-address-type: (any)
src-mac-address: (any)
src-port: (any)
tcp-flags: (any)
tcp-mss: (any)
time: (any)
tls-host: (any)
to-address: (any)
to-ports: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ipv6/firewall/nat/set post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

action: (any)
address-list: (any)
address-list-timeout: (any)
chain: (any)
comment: (any)
connection-bytes: (any)
connection-limit: (any)
connection-mark: (any)
connection-rate: (any)
connection-state: (any)
connection-type: (any)
content: (any)
disabled: (any)
dscp: (any)
dst-address: (any)
dst-address-list: (any)
dst-address-type: (any)
dst-limit: (any)
dst-port: (any)
headers: (any)
hop-limit: (any)
icmp-options: (any)
in-bridge-port: (any)
in-bridge-port-list: (any)
in-interface: (any)
in-interface-list: (any)
ingress-priority: (any)
ipsec-policy: (any)
jump-target: (any)
limit: (any)
log: (any)
log-prefix: (any)
nth: (any)
numbers: (any)
out-bridge-port: (any)
out-bridge-port-list: (any)
out-interface: (any)
out-interface-list: (any)
packet-mark: (any)
packet-size: (any)
per-connection-classifier: (any)
port: (any)
priority: (any)
protocol: (any)
random: (any)
routing-mark: (any)
src-address: (any)
src-address-list: (any)
src-address-type: (any)
src-mac-address: (any)
src-port: (any)
tcp-flags: (any)
tcp-mss: (any)
time: (any)
tls-host: (any)
to-address: (any)
to-ports: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ipv6/firewall/raw get put

get

put

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

action: (any)
address-list: (any)
address-list-timeout: (any)
chain: (any)
comment: (any)
content: (any)
copy-from: (any)
disabled: (any)
dscp: (any)
dst-address: (any)
dst-address-list: (any)
dst-address-type: (any)
dst-limit: (any)
dst-port: (any)
headers: (any)
hop-limit: (any)
icmp-options: (any)
in-bridge-port: (any)
in-bridge-port-list: (any)
in-interface: (any)
in-interface-list: (any)
ingress-priority: (any)
ipsec-policy: (any)
jump-target: (any)
limit: (any)
log: (any)
log-prefix: (any)
nth: (any)
out-bridge-port: (any)
out-bridge-port-list: (any)
out-interface: (any)
out-interface-list: (any)
packet-mark: (any)
packet-size: (any)
per-connection-classifier: (any)
place-before: (any)
port: (any)
priority: (any)
protocol: (any)
random: (any)
src-address: (any)
src-address-list: (any)
src-address-type: (any)
src-mac-address: (any)
src-port: (any)
tcp-flags: (any)
tcp-mss: (any)
time: (any)
tls-host: (any)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ipv6/firewall/raw/add post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

action: (any)
address-list: (any)
address-list-timeout: (any)
chain: (any)
comment: (any)
content: (any)
copy-from: (any)
disabled: (any)
dscp: (any)
dst-address: (any)
dst-address-list: (any)
dst-address-type: (any)
dst-limit: (any)
dst-port: (any)
headers: (any)
hop-limit: (any)
icmp-options: (any)
in-bridge-port: (any)
in-bridge-port-list: (any)
in-interface: (any)
in-interface-list: (any)
ingress-priority: (any)
ipsec-policy: (any)
jump-target: (any)
limit: (any)
log: (any)
log-prefix: (any)
nth: (any)
out-bridge-port: (any)
out-bridge-port-list: (any)
out-interface: (any)
out-interface-list: (any)
packet-mark: (any)
packet-size: (any)
per-connection-classifier: (any)
place-before: (any)
port: (any)
priority: (any)
protocol: (any)
random: (any)
src-address: (any)
src-address-list: (any)
src-address-type: (any)
src-mac-address: (any)
src-port: (any)
tcp-flags: (any)
tcp-mss: (any)
time: (any)
tls-host: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ipv6/firewall/raw/{id} get delete patch

get

delete

patch

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

URI Parameters

id: required(string)

Body

Media type: application/json

Type: object

Properties

action: (any)
address-list: (any)
address-list-timeout: (any)
chain: (any)
comment: (any)
content: (any)
disabled: (any)
dscp: (any)
dst-address: (any)
dst-address-list: (any)
dst-address-type: (any)
dst-limit: (any)
dst-port: (any)
headers: (any)
hop-limit: (any)
icmp-options: (any)
in-bridge-port: (any)
in-bridge-port-list: (any)
in-interface: (any)
in-interface-list: (any)
ingress-priority: (any)
ipsec-policy: (any)
jump-target: (any)
limit: (any)
log: (any)
log-prefix: (any)
nth: (any)
numbers: (any)
out-bridge-port: (any)
out-bridge-port-list: (any)
out-interface: (any)
out-interface-list: (any)
packet-mark: (any)
packet-size: (any)
per-connection-classifier: (any)
port: (any)
priority: (any)
protocol: (any)
random: (any)
src-address: (any)
src-address-list: (any)
src-address-type: (any)
src-mac-address: (any)
src-port: (any)
tcp-flags: (any)
tcp-mss: (any)
time: (any)
tls-host: (any)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ipv6/firewall/raw/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
stats: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ipv6/firewall/raw/reset post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

action: (any)
address-list: (any)
address-list-timeout: (any)
chain: (any)
comment: (any)
content: (any)
disabled: (any)
dscp: (any)
dst-address: (any)
dst-address-list: (any)
dst-address-type: (any)
dst-limit: (any)
dst-port: (any)
headers: (any)
hop-limit: (any)
icmp-options: (any)
in-bridge-port: (any)
in-bridge-port-list: (any)
in-interface: (any)
in-interface-list: (any)
ingress-priority: (any)
ipsec-policy: (any)
jump-target: (any)
limit: (any)
log: (any)
log-prefix: (any)
nth: (any)
numbers: (any)
out-bridge-port: (any)
out-bridge-port-list: (any)
out-interface: (any)
out-interface-list: (any)
packet-mark: (any)
packet-size: (any)
per-connection-classifier: (any)
port: (any)
priority: (any)
protocol: (any)
random: (any)
src-address: (any)
src-address-list: (any)
src-address-type: (any)
src-mac-address: (any)
src-port: (any)
tcp-flags: (any)
tcp-mss: (any)
time: (any)
tls-host: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ipv6/firewall/raw/set post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

action: (any)
address-list: (any)
address-list-timeout: (any)
chain: (any)
comment: (any)
content: (any)
disabled: (any)
dscp: (any)
dst-address: (any)
dst-address-list: (any)
dst-address-type: (any)
dst-limit: (any)
dst-port: (any)
headers: (any)
hop-limit: (any)
icmp-options: (any)
in-bridge-port: (any)
in-bridge-port-list: (any)
in-interface: (any)
in-interface-list: (any)
ingress-priority: (any)
ipsec-policy: (any)
jump-target: (any)
limit: (any)
log: (any)
log-prefix: (any)
nth: (any)
numbers: (any)
out-bridge-port: (any)
out-bridge-port-list: (any)
out-interface: (any)
out-interface-list: (any)
packet-mark: (any)
packet-size: (any)
per-connection-classifier: (any)
port: (any)
priority: (any)
protocol: (any)
random: (any)
src-address: (any)
src-address-list: (any)
src-address-type: (any)
src-mac-address: (any)
src-port: (any)
tcp-flags: (any)
tcp-mss: (any)
time: (any)
tls-host: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ipv6/nd get put

get

put

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

advertise-dns: (any)
advertise-mac-address: (any)
comment: (any)
copy-from: (any)
disabled: (any)
dns: (any)
hop-limit: (any)
interface: (any)
managed-address-configuration: (any)
mtu: (any)
other-configuration: (any)
pref64: (any)
ra-delay: (any)
ra-interval: (any)
ra-lifetime: (any)
ra-preference: (any)
reachable-time: (any)
retransmit-interval: (any)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ipv6/nd/add post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

advertise-dns: (any)
advertise-mac-address: (any)
comment: (any)
copy-from: (any)
disabled: (any)
dns: (any)
hop-limit: (any)
interface: (any)
managed-address-configuration: (any)
mtu: (any)
other-configuration: (any)
pref64: (any)
ra-delay: (any)
ra-interval: (any)
ra-lifetime: (any)
ra-preference: (any)
reachable-time: (any)
retransmit-interval: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ipv6/nd/{id} get delete patch

get

delete

patch

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

URI Parameters

id: required(string)

Body

Media type: application/json

Type: object

Properties

advertise-dns: (any)
advertise-mac-address: (any)
comment: (any)
disabled: (any)
dns: (any)
hop-limit: (any)
interface: (any)
managed-address-configuration: (any)
mtu: (any)
numbers: (any)
other-configuration: (any)
pref64: (any)
ra-delay: (any)
ra-interval: (any)
ra-lifetime: (any)
ra-preference: (any)
reachable-time: (any)
retransmit-interval: (any)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ipv6/nd/prefix get put

get

put

/ipv6/nd/prefix/add post

post

/ipv6/nd/prefix/default/{id} get patch

get

patch

/ipv6/nd/prefix/{id} get delete patch

get

delete

patch

/ipv6/nd/prefix/print post

post

/ipv6/nd/prefix/reset post

post

/ipv6/nd/prefix/set post

post

/ipv6/nd/print post

post

/ipv6/nd/reset post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

advertise-dns: (any)
advertise-mac-address: (any)
comment: (any)
disabled: (any)
dns: (any)
hop-limit: (any)
interface: (any)
managed-address-configuration: (any)
mtu: (any)
numbers: (any)
other-configuration: (any)
pref64: (any)
ra-delay: (any)
ra-interval: (any)
ra-lifetime: (any)
ra-preference: (any)
reachable-time: (any)
retransmit-interval: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ipv6/nd/set post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

advertise-dns: (any)
advertise-mac-address: (any)
comment: (any)
disabled: (any)
dns: (any)
hop-limit: (any)
interface: (any)
managed-address-configuration: (any)
mtu: (any)
numbers: (any)
other-configuration: (any)
pref64: (any)
ra-delay: (any)
ra-interval: (any)
ra-lifetime: (any)
ra-preference: (any)
reachable-time: (any)
retransmit-interval: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ipv6/neighbor/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ipv6/pool get put

get

put

/ipv6/pool/{id} get delete patch

get

delete

patch

/ipv6/pool/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ipv6/pool/used/print post

post

/ipv6/route get put

get

put

/ipv6/route/add post

post

/ipv6/route/{id} get delete patch

get

delete

patch

/ipv6/route/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
stats: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ipv6/route/reset post

post

/ipv6/route/set post

post

/ipv6/settings/{id} get patch

get

patch

/jobname

/len

/local

/log

/log/print post

post

/mpls

/mpls/forwarding-table/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/mpls/interface get put

get

put

/mpls/interface/{id} get delete patch

get

delete

patch

/mpls/interface/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/mpls/ldp get put

get

put

/mpls/ldp/accept-filter get put

get

put

/mpls/ldp/accept-filter/add post

post

/mpls/ldp/accept-filter/{id} get delete patch

get

delete

patch

/mpls/ldp/accept-filter/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/mpls/ldp/add post

post

/mpls/ldp/advertise-filter get put

get

put

/mpls/ldp/advertise-filter/add post

post

/mpls/ldp/advertise-filter/{id} get delete patch

get

delete

patch

/mpls/ldp/advertise-filter/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/mpls/ldp/advertise-filter/reset post

post

/mpls/ldp/{id} get delete patch

get

delete

patch

/mpls/ldp/interface get put

get

put

/mpls/ldp/interface/add post

post

/mpls/ldp/interface/{id} get delete patch

get

delete

patch

/mpls/ldp/interface/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/mpls/ldp/interface/reset post

post

/mpls/ldp/interface/set post

post

/mpls/ldp/local-mapping get put

get

put

/mpls/ldp/local-mapping/{id} get delete patch

get

delete

patch

/mpls/ldp/local-mapping/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/mpls/ldp/neighbor get put

get

put

/mpls/ldp/neighbor/{id} get delete patch

get

delete

patch

/mpls/ldp/neighbor/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/mpls/ldp/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/mpls/ldp/remote-mapping get put

get

put

/mpls/ldp/remote-mapping/{id} get delete patch

get

delete

patch

/mpls/ldp/remote-mapping/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/mpls/ldp/reset post

post

/mpls/ldp/set post

post

/mpls/settings/{id} get patch

get

patch

/mpls/traffic-eng/flow/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/mpls/traffic-eng/interface get put

get

put

/mpls/traffic-eng/interface/add post

post

/mpls/traffic-eng/interface/{id} get delete patch

get

delete

patch

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

URI Parameters

id: required(string)

Body

Media type: application/json

Type: object

Properties

bandwidth: (any)
blockade-k-factor: (any)
comment: (any)
disabled: (any)
down-flood-thresholds: (any)
igp-flood-period: (any)
interface: (any)
k-factor: (any)
numbers: (any)
refresh-time: (any)
resource-class: (any)
te-metric: (any)
up-flood-thresholds: (any)
use-udp: (any)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/mpls/traffic-eng/interface/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/mpls/traffic-eng/interface/reset post

post

/mpls/traffic-eng/interface/set post

post

/mpls/traffic-eng/path get put

get

put

/mpls/traffic-eng/path/add post

post

/mpls/traffic-eng/path/{id} get delete patch

get

delete

patch

/mpls/traffic-eng/path/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/mpls/traffic-eng/path/reset post

post

/mpls/traffic-eng/path/set post

post

/mpls/traffic-eng/tunnel get put

get

put

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

affinity-exclude: (any)
affinity-include-all: (any)
affinity-include-any: (any)
auto-bandwidth-avg-interval: (any)
auto-bandwidth-range: (any)
auto-bandwidth-reserve: (any)
auto-bandwidth-update-interval: (any)
bandwidth: (any)
bandwidth-limit: (any)
comment: (any)
copy-from: (any)
disabled: (any)
from-address: (any)
holding-priority: (any)
name: (any)
primary-path: (any)
primary-retry-interval: (any)
record-route: (any)
reoptimize-interval: (any)
secondary-paths: (any)
secondary-standby: (any)
setup-priority: (any)
to-address: (any)
vrf: (any)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/mpls/traffic-eng/tunnel/add post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

affinity-exclude: (any)
affinity-include-all: (any)
affinity-include-any: (any)
auto-bandwidth-avg-interval: (any)
auto-bandwidth-range: (any)
auto-bandwidth-reserve: (any)
auto-bandwidth-update-interval: (any)
bandwidth: (any)
bandwidth-limit: (any)
comment: (any)
copy-from: (any)
disabled: (any)
from-address: (any)
holding-priority: (any)
name: (any)
primary-path: (any)
primary-retry-interval: (any)
record-route: (any)
reoptimize-interval: (any)
secondary-paths: (any)
secondary-standby: (any)
setup-priority: (any)
to-address: (any)
vrf: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/mpls/traffic-eng/tunnel/{id} get delete patch

get

delete

patch

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

URI Parameters

id: required(string)

Body

Media type: application/json

Type: object

Properties

affinity-exclude: (any)
affinity-include-all: (any)
affinity-include-any: (any)
auto-bandwidth-avg-interval: (any)
auto-bandwidth-range: (any)
auto-bandwidth-reserve: (any)
auto-bandwidth-update-interval: (any)
bandwidth: (any)
bandwidth-limit: (any)
comment: (any)
disabled: (any)
from-address: (any)
holding-priority: (any)
name: (any)
numbers: (any)
primary-path: (any)
primary-retry-interval: (any)
record-route: (any)
reoptimize-interval: (any)
secondary-paths: (any)
secondary-standby: (any)
setup-priority: (any)
to-address: (any)
vrf: (any)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/mpls/traffic-eng/tunnel/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/mpls/traffic-eng/tunnel/reset post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

affinity-exclude: (any)
affinity-include-all: (any)
affinity-include-any: (any)
auto-bandwidth-avg-interval: (any)
auto-bandwidth-range: (any)
auto-bandwidth-reserve: (any)
auto-bandwidth-update-interval: (any)
bandwidth: (any)
bandwidth-limit: (any)
comment: (any)
disabled: (any)
from-address: (any)
holding-priority: (any)
name: (any)
numbers: (any)
primary-path: (any)
primary-retry-interval: (any)
record-route: (any)
reoptimize-interval: (any)
secondary-paths: (any)
secondary-standby: (any)
setup-priority: (any)
to-address: (any)
vrf: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/mpls/traffic-eng/tunnel/set post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

affinity-exclude: (any)
affinity-include-all: (any)
affinity-include-any: (any)
auto-bandwidth-avg-interval: (any)
auto-bandwidth-range: (any)
auto-bandwidth-reserve: (any)
auto-bandwidth-update-interval: (any)
bandwidth: (any)
bandwidth-limit: (any)
comment: (any)
disabled: (any)
from-address: (any)
holding-priority: (any)
name: (any)
numbers: (any)
primary-path: (any)
primary-retry-interval: (any)
record-route: (any)
reoptimize-interval: (any)
secondary-paths: (any)
secondary-standby: (any)
setup-priority: (any)
to-address: (any)
vrf: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/nothing

/parse

/partitions

/partitions/copy-to post

post

/partitions/{id} get patch

get

patch

/partitions/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/partitions/restore-config-from post

post

/partitions/save-config-to post

post

/password

/pick

/ping

/ping post

post

/port

/port/{id} get delete patch

get

delete

patch

/port/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
stats: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/port/remote-access get put

get

put

/port/remote-access/add post

post

/port/remote-access/{id} get delete patch

get

delete

patch

/port/remote-access/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/port/remote-access/reset post

post

/port/remote-access/set post

post

/ppp

/ppp/aaa/{id} get patch

get

patch

/ppp/active/{id} get delete

get

delete

/ppp/active/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ppp/l2tp-secret get put

get

put

/ppp/l2tp-secret/{id} get delete patch

get

delete

patch

/ppp/l2tp-secret/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ppp/profile get put

get

put

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

address-list: (any)
bridge: (any)
bridge-horizon: (any)
bridge-learning: (any)
bridge-path-cost: (any)
bridge-port-priority: (any)
change-tcp-mss: (any)
comment: (any)
copy-from: (any)
dhcpv6-pd-pool: (any)
dns-server: (any)
idle-timeout: (any)
incoming-filter: (any)
insert-queue-before: (any)
interface-list: (any)
local-address: (any)
name: (any)
on-down: (any)
on-up: (any)
only-one: (any)
outgoing-filter: (any)
parent-queue: (any)
queue-type: (any)
rate-limit: (any)
remote-address: (any)
remote-ipv6-prefix-pool: (any)
session-timeout: (any)
use-compression: (any)
use-encryption: (any)
use-ipv6: (any)
use-mpls: (any)
use-upnp: (any)
wins-server: (any)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ppp/profile/add post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

address-list: (any)
bridge: (any)
bridge-horizon: (any)
bridge-learning: (any)
bridge-path-cost: (any)
bridge-port-priority: (any)
change-tcp-mss: (any)
comment: (any)
copy-from: (any)
dhcpv6-pd-pool: (any)
dns-server: (any)
idle-timeout: (any)
incoming-filter: (any)
insert-queue-before: (any)
interface-list: (any)
local-address: (any)
name: (any)
on-down: (any)
on-up: (any)
only-one: (any)
outgoing-filter: (any)
parent-queue: (any)
queue-type: (any)
rate-limit: (any)
remote-address: (any)
remote-ipv6-prefix-pool: (any)
session-timeout: (any)
use-compression: (any)
use-encryption: (any)
use-ipv6: (any)
use-mpls: (any)
use-upnp: (any)
wins-server: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ppp/profile/{id} get delete patch

get

delete

patch

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

URI Parameters

id: required(string)

Body

Media type: application/json

Type: object

Properties

address-list: (any)
bridge: (any)
bridge-horizon: (any)
bridge-learning: (any)
bridge-path-cost: (any)
bridge-port-priority: (any)
change-tcp-mss: (any)
comment: (any)
dhcpv6-pd-pool: (any)
dns-server: (any)
idle-timeout: (any)
incoming-filter: (any)
insert-queue-before: (any)
interface-list: (any)
local-address: (any)
name: (any)
numbers: (any)
on-down: (any)
on-up: (any)
only-one: (any)
outgoing-filter: (any)
parent-queue: (any)
queue-type: (any)
rate-limit: (any)
remote-address: (any)
remote-ipv6-prefix-pool: (any)
session-timeout: (any)
use-compression: (any)
use-encryption: (any)
use-ipv6: (any)
use-mpls: (any)
use-upnp: (any)
wins-server: (any)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ppp/profile/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ppp/profile/reset post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

address-list: (any)
bridge: (any)
bridge-horizon: (any)
bridge-learning: (any)
bridge-path-cost: (any)
bridge-port-priority: (any)
change-tcp-mss: (any)
comment: (any)
dhcpv6-pd-pool: (any)
dns-server: (any)
idle-timeout: (any)
incoming-filter: (any)
insert-queue-before: (any)
interface-list: (any)
local-address: (any)
name: (any)
numbers: (any)
on-down: (any)
on-up: (any)
only-one: (any)
outgoing-filter: (any)
parent-queue: (any)
queue-type: (any)
rate-limit: (any)
remote-address: (any)
remote-ipv6-prefix-pool: (any)
session-timeout: (any)
use-compression: (any)
use-encryption: (any)
use-ipv6: (any)
use-mpls: (any)
use-upnp: (any)
wins-server: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ppp/profile/set post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

address-list: (any)
bridge: (any)
bridge-horizon: (any)
bridge-learning: (any)
bridge-path-cost: (any)
bridge-port-priority: (any)
change-tcp-mss: (any)
comment: (any)
dhcpv6-pd-pool: (any)
dns-server: (any)
idle-timeout: (any)
incoming-filter: (any)
insert-queue-before: (any)
interface-list: (any)
local-address: (any)
name: (any)
numbers: (any)
on-down: (any)
on-up: (any)
only-one: (any)
outgoing-filter: (any)
parent-queue: (any)
queue-type: (any)
rate-limit: (any)
remote-address: (any)
remote-ipv6-prefix-pool: (any)
session-timeout: (any)
use-compression: (any)
use-encryption: (any)
use-ipv6: (any)
use-mpls: (any)
use-upnp: (any)
wins-server: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ppp/secret get put

get

put

/ppp/secret/add post

post

/ppp/secret/{id} get delete patch

get

delete

patch

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

URI Parameters

id: required(string)

Body

Media type: application/json

Type: object

Properties

caller-id: (any)
comment: (any)
disabled: (any)
ipv6-routes: (any)
limit-bytes-in: (any)
limit-bytes-out: (any)
local-address: (any)
name: (any)
numbers: (any)
password: (any)
profile: (any)
remote-address: (any)
remote-ipv6-prefix: (any)
routes: (any)
service: (any)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ppp/secret/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/ppp/secret/reset post

post

/ppp/secret/set post

post

/put

/queue

/queue/type get put

get

put

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

bfifo-limit: (any)
cake-ack-filter: (any)
cake-atm: (any)
cake-autorate-ingress: (any)
cake-bandwidth: (any)
cake-diffserv: (any)
cake-flowmode: (any)
cake-memlimit: (any)
cake-mpu: (any)
cake-nat: (any)
cake-overhead: (any)
cake-overhead-scheme: (any)
cake-rtt: (any)
cake-rtt-scheme: (any)
cake-wash: (any)
codel-ce-threshold: (any)
codel-ecn: (any)
codel-interval: (any)
codel-limit: (any)
codel-target: (any)
copy-from: (any)
fq-codel-ce-threshold: (any)
fq-codel-ecn: (any)
fq-codel-flows: (any)
fq-codel-interval: (any)
fq-codel-limit: (any)
fq-codel-memlimit: (any)
fq-codel-quantum: (any)
fq-codel-target: (any)
kind: (any)
mq-pfifo-limit: (any)
name: (any)
pcq-burst-rate: (any)
pcq-burst-threshold: (any)
pcq-burst-time: (any)
pcq-classifier: (any)
pcq-dst-address-mask: (any)
pcq-dst-address6-mask: (any)
pcq-limit: (any)
pcq-rate: (any)
pcq-src-address-mask: (any)
pcq-src-address6-mask: (any)
pcq-total-limit: (any)
pfifo-limit: (any)
red-avg-packet: (any)
red-burst: (any)
red-limit: (any)
red-max-threshold: (any)
red-min-threshold: (any)
sfq-allot: (any)
sfq-perturb: (any)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/queue/type/add post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

bfifo-limit: (any)
cake-ack-filter: (any)
cake-atm: (any)
cake-autorate-ingress: (any)
cake-bandwidth: (any)
cake-diffserv: (any)
cake-flowmode: (any)
cake-memlimit: (any)
cake-mpu: (any)
cake-nat: (any)
cake-overhead: (any)
cake-overhead-scheme: (any)
cake-rtt: (any)
cake-rtt-scheme: (any)
cake-wash: (any)
codel-ce-threshold: (any)
codel-ecn: (any)
codel-interval: (any)
codel-limit: (any)
codel-target: (any)
copy-from: (any)
fq-codel-ce-threshold: (any)
fq-codel-ecn: (any)
fq-codel-flows: (any)
fq-codel-interval: (any)
fq-codel-limit: (any)
fq-codel-memlimit: (any)
fq-codel-quantum: (any)
fq-codel-target: (any)
kind: (any)
mq-pfifo-limit: (any)
name: (any)
pcq-burst-rate: (any)
pcq-burst-threshold: (any)
pcq-burst-time: (any)
pcq-classifier: (any)
pcq-dst-address-mask: (any)
pcq-dst-address6-mask: (any)
pcq-limit: (any)
pcq-rate: (any)
pcq-src-address-mask: (any)
pcq-src-address6-mask: (any)
pcq-total-limit: (any)
pfifo-limit: (any)
red-avg-packet: (any)
red-burst: (any)
red-limit: (any)
red-max-threshold: (any)
red-min-threshold: (any)
sfq-allot: (any)
sfq-perturb: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/queue/type/{id} get delete patch

get

delete

patch

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

URI Parameters

id: required(string)

Body

Media type: application/json

Type: object

Properties

bfifo-limit: (any)
cake-ack-filter: (any)
cake-atm: (any)
cake-autorate-ingress: (any)
cake-bandwidth: (any)
cake-diffserv: (any)
cake-flowmode: (any)
cake-memlimit: (any)
cake-mpu: (any)
cake-nat: (any)
cake-overhead: (any)
cake-overhead-scheme: (any)
cake-rtt: (any)
cake-rtt-scheme: (any)
cake-wash: (any)
codel-ce-threshold: (any)
codel-ecn: (any)
codel-interval: (any)
codel-limit: (any)
codel-target: (any)
fq-codel-ce-threshold: (any)
fq-codel-ecn: (any)
fq-codel-flows: (any)
fq-codel-interval: (any)
fq-codel-limit: (any)
fq-codel-memlimit: (any)
fq-codel-quantum: (any)
fq-codel-target: (any)
kind: (any)
mq-pfifo-limit: (any)
name: (any)
numbers: (any)
pcq-burst-rate: (any)
pcq-burst-threshold: (any)
pcq-burst-time: (any)
pcq-classifier: (any)
pcq-dst-address-mask: (any)
pcq-dst-address6-mask: (any)
pcq-limit: (any)
pcq-rate: (any)
pcq-src-address-mask: (any)
pcq-src-address6-mask: (any)
pcq-total-limit: (any)
pfifo-limit: (any)
red-avg-packet: (any)
red-burst: (any)
red-limit: (any)
red-max-threshold: (any)
red-min-threshold: (any)
sfq-allot: (any)
sfq-perturb: (any)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/queue/type/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/queue/type/reset post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

bfifo-limit: (any)
cake-ack-filter: (any)
cake-atm: (any)
cake-autorate-ingress: (any)
cake-bandwidth: (any)
cake-diffserv: (any)
cake-flowmode: (any)
cake-memlimit: (any)
cake-mpu: (any)
cake-nat: (any)
cake-overhead: (any)
cake-overhead-scheme: (any)
cake-rtt: (any)
cake-rtt-scheme: (any)
cake-wash: (any)
codel-ce-threshold: (any)
codel-ecn: (any)
codel-interval: (any)
codel-limit: (any)
codel-target: (any)
fq-codel-ce-threshold: (any)
fq-codel-ecn: (any)
fq-codel-flows: (any)
fq-codel-interval: (any)
fq-codel-limit: (any)
fq-codel-memlimit: (any)
fq-codel-quantum: (any)
fq-codel-target: (any)
kind: (any)
mq-pfifo-limit: (any)
name: (any)
numbers: (any)
pcq-burst-rate: (any)
pcq-burst-threshold: (any)
pcq-burst-time: (any)
pcq-classifier: (any)
pcq-dst-address-mask: (any)
pcq-dst-address6-mask: (any)
pcq-limit: (any)
pcq-rate: (any)
pcq-src-address-mask: (any)
pcq-src-address6-mask: (any)
pcq-total-limit: (any)
pfifo-limit: (any)
red-avg-packet: (any)
red-burst: (any)
red-limit: (any)
red-max-threshold: (any)
red-min-threshold: (any)
sfq-allot: (any)
sfq-perturb: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/queue/type/set post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

bfifo-limit: (any)
cake-ack-filter: (any)
cake-atm: (any)
cake-autorate-ingress: (any)
cake-bandwidth: (any)
cake-diffserv: (any)
cake-flowmode: (any)
cake-memlimit: (any)
cake-mpu: (any)
cake-nat: (any)
cake-overhead: (any)
cake-overhead-scheme: (any)
cake-rtt: (any)
cake-rtt-scheme: (any)
cake-wash: (any)
codel-ce-threshold: (any)
codel-ecn: (any)
codel-interval: (any)
codel-limit: (any)
codel-target: (any)
fq-codel-ce-threshold: (any)
fq-codel-ecn: (any)
fq-codel-flows: (any)
fq-codel-interval: (any)
fq-codel-limit: (any)
fq-codel-memlimit: (any)
fq-codel-quantum: (any)
fq-codel-target: (any)
kind: (any)
mq-pfifo-limit: (any)
name: (any)
numbers: (any)
pcq-burst-rate: (any)
pcq-burst-threshold: (any)
pcq-burst-time: (any)
pcq-classifier: (any)
pcq-dst-address-mask: (any)
pcq-dst-address6-mask: (any)
pcq-limit: (any)
pcq-rate: (any)
pcq-src-address-mask: (any)
pcq-src-address6-mask: (any)
pcq-total-limit: (any)
pfifo-limit: (any)
red-avg-packet: (any)
red-burst: (any)
red-limit: (any)
red-max-threshold: (any)
red-min-threshold: (any)
sfq-allot: (any)
sfq-perturb: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/queue/interface/{id} get patch

get

patch

/queue/interface/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/queue/simple get put

get

put

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

bucket-size: (any)
burst-limit: (any)
burst-threshold: (any)
burst-time: (any)
comment: (any)
copy-from: (any)
disabled: (any)
dst: (any)
limit-at: (any)
max-limit: (any)
name: (any)
packet-marks: (any)
parent: (any)
place-before: (any)
priority: (any)
queue: (any)
target: (any)
time: (any)
total-bucket-size: (any)
total-burst-limit: (any)
total-burst-threshold: (any)
total-burst-time: (any)
total-limit-at: (any)
total-max-limit: (any)
total-priority: (any)
total-queue: (any)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/queue/simple/add post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

bucket-size: (any)
burst-limit: (any)
burst-threshold: (any)
burst-time: (any)
comment: (any)
copy-from: (any)
disabled: (any)
dst: (any)
limit-at: (any)
max-limit: (any)
name: (any)
packet-marks: (any)
parent: (any)
place-before: (any)
priority: (any)
queue: (any)
target: (any)
time: (any)
total-bucket-size: (any)
total-burst-limit: (any)
total-burst-threshold: (any)
total-burst-time: (any)
total-limit-at: (any)
total-max-limit: (any)
total-priority: (any)
total-queue: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/queue/simple/{id} get delete patch

get

delete

patch

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

URI Parameters

id: required(string)

Body

Media type: application/json

Type: object

Properties

bucket-size: (any)
burst-limit: (any)
burst-threshold: (any)
burst-time: (any)
comment: (any)
disabled: (any)
dst: (any)
limit-at: (any)
max-limit: (any)
name: (any)
numbers: (any)
packet-marks: (any)
parent: (any)
priority: (any)
queue: (any)
target: (any)
time: (any)
total-bucket-size: (any)
total-burst-limit: (any)
total-burst-threshold: (any)
total-burst-time: (any)
total-limit-at: (any)
total-max-limit: (any)
total-priority: (any)
total-queue: (any)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/queue/simple/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
bytes: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
oid: (any)
packets: (any)
proplist: (any)
rate: (any)
show-ids: (any)
stats: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/queue/simple/reset post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

bucket-size: (any)
burst-limit: (any)
burst-threshold: (any)
burst-time: (any)
comment: (any)
disabled: (any)
dst: (any)
limit-at: (any)
max-limit: (any)
name: (any)
numbers: (any)
packet-marks: (any)
parent: (any)
priority: (any)
queue: (any)
target: (any)
time: (any)
total-bucket-size: (any)
total-burst-limit: (any)
total-burst-threshold: (any)
total-burst-time: (any)
total-limit-at: (any)
total-max-limit: (any)
total-priority: (any)
total-queue: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/queue/simple/set post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

bucket-size: (any)
burst-limit: (any)
burst-threshold: (any)
burst-time: (any)
comment: (any)
disabled: (any)
dst: (any)
limit-at: (any)
max-limit: (any)
name: (any)
numbers: (any)
packet-marks: (any)
parent: (any)
priority: (any)
queue: (any)
target: (any)
time: (any)
total-bucket-size: (any)
total-burst-limit: (any)
total-burst-threshold: (any)
total-burst-time: (any)
total-limit-at: (any)
total-max-limit: (any)
total-priority: (any)
total-queue: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/queue/tree get put

get

put

/queue/tree/add post

post

/queue/tree/{id} get delete patch

get

delete

patch

/queue/tree/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
bytes: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
oid: (any)
packets: (any)
proplist: (any)
rate: (any)
show-ids: (any)
stats: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/queue/tree/reset post

post

/queue/tree/set post

post

/quit

/radius

/radius get put

get

put

/radius/add post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

accounting-backup: (any)
accounting-port: (any)
address: (any)
authentication-port: (any)
called-id: (any)
certificate: (any)
comment: (any)
copy-from: (any)
disabled: (any)
domain: (any)
place-before: (any)
protocol: (any)
realm: (any)
secret: (any)
service: (any)
src-address: (any)
timeout: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/radius/{id} get delete patch

get

delete

patch

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

URI Parameters

id: required(string)

Body

Media type: application/json

Type: object

Properties

accounting-backup: (any)
accounting-port: (any)
address: (any)
authentication-port: (any)
called-id: (any)
certificate: (any)
comment: (any)
disabled: (any)
domain: (any)
numbers: (any)
protocol: (any)
realm: (any)
secret: (any)
service: (any)
src-address: (any)
timeout: (any)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/radius/incoming/{id} get patch

get

patch

/radius/incoming/monitor post

post

/radius/monitor post

post

/radius/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/radius/reset post

post

/radius/set post

post

/redo

/resolve

/retry

/return

/rndnum

/rndstr

/routing

/routing/bfd/configuration get put

get

put

/routing/bfd/configuration/add post

post

/routing/bfd/configuration/{id} get delete patch

get

delete

patch

/routing/bfd/configuration/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/routing/bfd/configuration/reset post

post

/routing/bfd/configuration/set post

post

/routing/bfd/session/print post

post

/routing/bgp/advertisements/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/routing/bgp/connection get put

get

put

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

add-path-out: (any)
address-families: (any)
as: (any)
cisco-vpls-nlri-len-fmt: (any)
cluster-id: (any)
comment: (any)
connect: (any)
copy-from: (any)
disabled: (any)
hold-time: (any)
input.accept-communities: (any)
input.accept-ext-communities: (any)
input.accept-large-communities: (any)
input.accept-nlri: (any)
input.accept-unknown: (any)
input.affinity: (any)
input.allow-as: (any)
input.filter: (any)
input.ignore-as-path-len: (any)
input.limit-process-routes-ipv4: (any)
input.limit-process-routes-ipv6: (any)
keepalive-time: (any)
listen: (any)
local.address: (any)
local.port: (any)
local.role: (any)
local.ttl: (any)
multihop: (any)
name: (any)
nexthop-choice: (any)
output.affinity: (any)
output.as-override: (any)
output.default-originate: (any)
output.default-prepend: (any)
output.filter-chain: (any)
output.filter-select: (any)
output.keep-sent-attributes: (any)
output.network: (any)
output.no-client-to-client-reflection: (any)
output.no-early-cut: (any)
output.redistribute: (any)
output.remove-private-as: (any)
remote.address: (any)
remote.allowed-as: (any)
remote.as: (any)
remote.port: (any)
remote.ttl: (any)
router-id: (any)
routing-table: (any)
save-to: (any)
tcp-md5-key: (any)
templates: (any)
use-bfd: (any)
vrf: (any)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/routing/bgp/connection/add post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

add-path-out: (any)
address-families: (any)
as: (any)
cisco-vpls-nlri-len-fmt: (any)
cluster-id: (any)
comment: (any)
connect: (any)
copy-from: (any)
disabled: (any)
hold-time: (any)
input.accept-communities: (any)
input.accept-ext-communities: (any)
input.accept-large-communities: (any)
input.accept-nlri: (any)
input.accept-unknown: (any)
input.affinity: (any)
input.allow-as: (any)
input.filter: (any)
input.ignore-as-path-len: (any)
input.limit-process-routes-ipv4: (any)
input.limit-process-routes-ipv6: (any)
keepalive-time: (any)
listen: (any)
local.address: (any)
local.port: (any)
local.role: (any)
local.ttl: (any)
multihop: (any)
name: (any)
nexthop-choice: (any)
output.affinity: (any)
output.as-override: (any)
output.default-originate: (any)
output.default-prepend: (any)
output.filter-chain: (any)
output.filter-select: (any)
output.keep-sent-attributes: (any)
output.network: (any)
output.no-client-to-client-reflection: (any)
output.no-early-cut: (any)
output.redistribute: (any)
output.remove-private-as: (any)
remote.address: (any)
remote.allowed-as: (any)
remote.as: (any)
remote.port: (any)
remote.ttl: (any)
router-id: (any)
routing-table: (any)
save-to: (any)
tcp-md5-key: (any)
templates: (any)
use-bfd: (any)
vrf: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/routing/bgp/connection/{id} get delete patch

get

delete

patch

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

URI Parameters

id: required(string)

Body

Media type: application/json

Type: object

Properties

add-path-out: (any)
address-families: (any)
as: (any)
cisco-vpls-nlri-len-fmt: (any)
cluster-id: (any)
comment: (any)
connect: (any)
disabled: (any)
hold-time: (any)
input.accept-communities: (any)
input.accept-ext-communities: (any)
input.accept-large-communities: (any)
input.accept-nlri: (any)
input.accept-unknown: (any)
input.affinity: (any)
input.allow-as: (any)
input.filter: (any)
input.ignore-as-path-len: (any)
input.limit-process-routes-ipv4: (any)
input.limit-process-routes-ipv6: (any)
keepalive-time: (any)
listen: (any)
local.address: (any)
local.port: (any)
local.role: (any)
local.ttl: (any)
multihop: (any)
name: (any)
nexthop-choice: (any)
numbers: (any)
output.affinity: (any)
output.as-override: (any)
output.default-originate: (any)
output.default-prepend: (any)
output.filter-chain: (any)
output.filter-select: (any)
output.keep-sent-attributes: (any)
output.network: (any)
output.no-client-to-client-reflection: (any)
output.no-early-cut: (any)
output.redistribute: (any)
output.remove-private-as: (any)
remote.address: (any)
remote.allowed-as: (any)
remote.as: (any)
remote.port: (any)
remote.ttl: (any)
router-id: (any)
routing-table: (any)
save-to: (any)
tcp-md5-key: (any)
templates: (any)
use-bfd: (any)
vrf: (any)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/routing/bgp/connection/print post

post

/routing/bgp/connection/reset post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

add-path-out: (any)
address-families: (any)
as: (any)
cisco-vpls-nlri-len-fmt: (any)
cluster-id: (any)
comment: (any)
connect: (any)
disabled: (any)
hold-time: (any)
input.accept-communities: (any)
input.accept-ext-communities: (any)
input.accept-large-communities: (any)
input.accept-nlri: (any)
input.accept-unknown: (any)
input.affinity: (any)
input.allow-as: (any)
input.filter: (any)
input.ignore-as-path-len: (any)
input.limit-process-routes-ipv4: (any)
input.limit-process-routes-ipv6: (any)
keepalive-time: (any)
listen: (any)
local.address: (any)
local.port: (any)
local.role: (any)
local.ttl: (any)
multihop: (any)
name: (any)
nexthop-choice: (any)
numbers: (any)
output.affinity: (any)
output.as-override: (any)
output.default-originate: (any)
output.default-prepend: (any)
output.filter-chain: (any)
output.filter-select: (any)
output.keep-sent-attributes: (any)
output.network: (any)
output.no-client-to-client-reflection: (any)
output.no-early-cut: (any)
output.redistribute: (any)
output.remove-private-as: (any)
remote.address: (any)
remote.allowed-as: (any)
remote.as: (any)
remote.port: (any)
remote.ttl: (any)
router-id: (any)
routing-table: (any)
save-to: (any)
tcp-md5-key: (any)
templates: (any)
use-bfd: (any)
vrf: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/routing/bgp/connection/set post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

add-path-out: (any)
address-families: (any)
as: (any)
cisco-vpls-nlri-len-fmt: (any)
cluster-id: (any)
comment: (any)
connect: (any)
disabled: (any)
hold-time: (any)
input.accept-communities: (any)
input.accept-ext-communities: (any)
input.accept-large-communities: (any)
input.accept-nlri: (any)
input.accept-unknown: (any)
input.affinity: (any)
input.allow-as: (any)
input.filter: (any)
input.ignore-as-path-len: (any)
input.limit-process-routes-ipv4: (any)
input.limit-process-routes-ipv6: (any)
keepalive-time: (any)
listen: (any)
local.address: (any)
local.port: (any)
local.role: (any)
local.ttl: (any)
multihop: (any)
name: (any)
nexthop-choice: (any)
numbers: (any)
output.affinity: (any)
output.as-override: (any)
output.default-originate: (any)
output.default-prepend: (any)
output.filter-chain: (any)
output.filter-select: (any)
output.keep-sent-attributes: (any)
output.network: (any)
output.no-client-to-client-reflection: (any)
output.no-early-cut: (any)
output.redistribute: (any)
output.remove-private-as: (any)
remote.address: (any)
remote.allowed-as: (any)
remote.as: (any)
remote.port: (any)
remote.ttl: (any)
router-id: (any)
routing-table: (any)
save-to: (any)
tcp-md5-key: (any)
templates: (any)
use-bfd: (any)
vrf: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/routing/bgp/session/print post

post

/routing/bgp/template get put

get

put

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

add-path-out: (any)
address-families: (any)
as: (any)
cisco-vpls-nlri-len-fmt: (any)
cluster-id: (any)
comment: (any)
copy-from: (any)
disabled: (any)
hold-time: (any)
input.accept-communities: (any)
input.accept-ext-communities: (any)
input.accept-large-communities: (any)
input.accept-nlri: (any)
input.accept-unknown: (any)
input.affinity: (any)
input.allow-as: (any)
input.filter: (any)
input.ignore-as-path-len: (any)
input.limit-process-routes-ipv4: (any)
input.limit-process-routes-ipv6: (any)
keepalive-time: (any)
multihop: (any)
name: (any)
nexthop-choice: (any)
output.affinity: (any)
output.as-override: (any)
output.default-originate: (any)
output.default-prepend: (any)
output.filter-chain: (any)
output.filter-select: (any)
output.keep-sent-attributes: (any)
output.network: (any)
output.no-client-to-client-reflection: (any)
output.no-early-cut: (any)
output.redistribute: (any)
output.remove-private-as: (any)
router-id: (any)
routing-table: (any)
save-to: (any)
templates: (any)
use-bfd: (any)
vrf: (any)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/routing/bgp/template/add post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

add-path-out: (any)
address-families: (any)
as: (any)
cisco-vpls-nlri-len-fmt: (any)
cluster-id: (any)
comment: (any)
copy-from: (any)
disabled: (any)
hold-time: (any)
input.accept-communities: (any)
input.accept-ext-communities: (any)
input.accept-large-communities: (any)
input.accept-nlri: (any)
input.accept-unknown: (any)
input.affinity: (any)
input.allow-as: (any)
input.filter: (any)
input.ignore-as-path-len: (any)
input.limit-process-routes-ipv4: (any)
input.limit-process-routes-ipv6: (any)
keepalive-time: (any)
multihop: (any)
name: (any)
nexthop-choice: (any)
output.affinity: (any)
output.as-override: (any)
output.default-originate: (any)
output.default-prepend: (any)
output.filter-chain: (any)
output.filter-select: (any)
output.keep-sent-attributes: (any)
output.network: (any)
output.no-client-to-client-reflection: (any)
output.no-early-cut: (any)
output.redistribute: (any)
output.remove-private-as: (any)
router-id: (any)
routing-table: (any)
save-to: (any)
templates: (any)
use-bfd: (any)
vrf: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/routing/bgp/template/{id} get delete patch

get

delete

patch

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

URI Parameters

id: required(string)

Body

Media type: application/json

Type: object

Properties

add-path-out: (any)
address-families: (any)
as: (any)
cisco-vpls-nlri-len-fmt: (any)
cluster-id: (any)
comment: (any)
disabled: (any)
hold-time: (any)
input.accept-communities: (any)
input.accept-ext-communities: (any)
input.accept-large-communities: (any)
input.accept-nlri: (any)
input.accept-unknown: (any)
input.affinity: (any)
input.allow-as: (any)
input.filter: (any)
input.ignore-as-path-len: (any)
input.limit-process-routes-ipv4: (any)
input.limit-process-routes-ipv6: (any)
keepalive-time: (any)
multihop: (any)
name: (any)
nexthop-choice: (any)
numbers: (any)
output.affinity: (any)
output.as-override: (any)
output.default-originate: (any)
output.default-prepend: (any)
output.filter-chain: (any)
output.filter-select: (any)
output.keep-sent-attributes: (any)
output.network: (any)
output.no-client-to-client-reflection: (any)
output.no-early-cut: (any)
output.redistribute: (any)
output.remove-private-as: (any)
router-id: (any)
routing-table: (any)
save-to: (any)
templates: (any)
use-bfd: (any)
vrf: (any)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/routing/bgp/template/print post

post

/routing/bgp/template/reset post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

add-path-out: (any)
address-families: (any)
as: (any)
cisco-vpls-nlri-len-fmt: (any)
cluster-id: (any)
comment: (any)
disabled: (any)
hold-time: (any)
input.accept-communities: (any)
input.accept-ext-communities: (any)
input.accept-large-communities: (any)
input.accept-nlri: (any)
input.accept-unknown: (any)
input.affinity: (any)
input.allow-as: (any)
input.filter: (any)
input.ignore-as-path-len: (any)
input.limit-process-routes-ipv4: (any)
input.limit-process-routes-ipv6: (any)
keepalive-time: (any)
multihop: (any)
name: (any)
nexthop-choice: (any)
numbers: (any)
output.affinity: (any)
output.as-override: (any)
output.default-originate: (any)
output.default-prepend: (any)
output.filter-chain: (any)
output.filter-select: (any)
output.keep-sent-attributes: (any)
output.network: (any)
output.no-client-to-client-reflection: (any)
output.no-early-cut: (any)
output.redistribute: (any)
output.remove-private-as: (any)
router-id: (any)
routing-table: (any)
save-to: (any)
templates: (any)
use-bfd: (any)
vrf: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/routing/bgp/template/set post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

add-path-out: (any)
address-families: (any)
as: (any)
cisco-vpls-nlri-len-fmt: (any)
cluster-id: (any)
comment: (any)
disabled: (any)
hold-time: (any)
input.accept-communities: (any)
input.accept-ext-communities: (any)
input.accept-large-communities: (any)
input.accept-nlri: (any)
input.accept-unknown: (any)
input.affinity: (any)
input.allow-as: (any)
input.filter: (any)
input.ignore-as-path-len: (any)
input.limit-process-routes-ipv4: (any)
input.limit-process-routes-ipv6: (any)
keepalive-time: (any)
multihop: (any)
name: (any)
nexthop-choice: (any)
numbers: (any)
output.affinity: (any)
output.as-override: (any)
output.default-originate: (any)
output.default-prepend: (any)
output.filter-chain: (any)
output.filter-select: (any)
output.keep-sent-attributes: (any)
output.network: (any)
output.no-client-to-client-reflection: (any)
output.no-early-cut: (any)
output.redistribute: (any)
output.remove-private-as: (any)
router-id: (any)
routing-table: (any)
save-to: (any)
templates: (any)
use-bfd: (any)
vrf: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/routing/bgp/vpls get put

get

put

/routing/bgp/vpls/add post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

bridge: (any)
bridge-cost: (any)
bridge-horizon: (any)
cisco-id: (any)
comment: (any)
copy-from: (any)
disabled: (any)
export-route-targets: (any)
import-route-targets: (any)
local-pref: (any)
name: (any)
pw-control-word: (any)
pw-l2mtu: (any)
pw-type: (any)
rd: (any)
site-id: (any)
vrf: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/routing/bgp/vpls/{id} get delete patch

get

delete

patch

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

URI Parameters

id: required(string)

Body

Media type: application/json

Type: object

Properties

bridge: (any)
bridge-cost: (any)
bridge-horizon: (any)
cisco-id: (any)
comment: (any)
disabled: (any)
export-route-targets: (any)
import-route-targets: (any)
local-pref: (any)
name: (any)
numbers: (any)
pw-control-word: (any)
pw-l2mtu: (any)
pw-type: (any)
rd: (any)
site-id: (any)
vrf: (any)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/routing/bgp/vpls/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
debug: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/routing/bgp/vpls/reset post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

bridge: (any)
bridge-cost: (any)
bridge-horizon: (any)
cisco-id: (any)
comment: (any)
disabled: (any)
export-route-targets: (any)
import-route-targets: (any)
local-pref: (any)
name: (any)
numbers: (any)
pw-control-word: (any)
pw-l2mtu: (any)
pw-type: (any)
rd: (any)
site-id: (any)
vrf: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/routing/bgp/vpls/set post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

bridge: (any)
bridge-cost: (any)
bridge-horizon: (any)
cisco-id: (any)
comment: (any)
disabled: (any)
export-route-targets: (any)
import-route-targets: (any)
local-pref: (any)
name: (any)
numbers: (any)
pw-control-word: (any)
pw-l2mtu: (any)
pw-type: (any)
rd: (any)
site-id: (any)
vrf: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/routing/bgp/vpn get put

get

put

/routing/bgp/vpn/add post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

comment: (any)
copy-from: (any)
disabled: (any)
export.filter-chain: (any)
export.filter-select: (any)
export.redistribute: (any)
export.route-targets: (any)
import.filter-chain: (any)
import.route-targets: (any)
import.router-id: (any)
label-allocation-policy: (any)
name: (any)
route-distinguisher: (any)
vrf: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/routing/bgp/vpn/{id} get delete patch

get

delete

patch

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

URI Parameters

id: required(string)

Body

Media type: application/json

Type: object

Properties

comment: (any)
disabled: (any)
export.filter-chain: (any)
export.filter-select: (any)
export.redistribute: (any)
export.route-targets: (any)
import.filter-chain: (any)
import.route-targets: (any)
import.router-id: (any)
label-allocation-policy: (any)
name: (any)
numbers: (any)
route-distinguisher: (any)
vrf: (any)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/routing/bgp/vpn/print post

post

/routing/bgp/vpn/reset post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

comment: (any)
disabled: (any)
export.filter-chain: (any)
export.filter-select: (any)
export.redistribute: (any)
export.route-targets: (any)
import.filter-chain: (any)
import.route-targets: (any)
import.router-id: (any)
label-allocation-policy: (any)
name: (any)
numbers: (any)
route-distinguisher: (any)
vrf: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/routing/bgp/vpn/set post

post

/routing/fantasy get put

get

put

/routing/fantasy/add post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

comment: (any)
copy-from: (any)
count: (any)
dealer-id: (any)
disabled: (any)
dst-address: (any)
gateway: (any)
instance-id: (any)
name: (any)
offset: (any)
prefix-length: (any)
priv-offs: (any)
priv-size: (any)
scope: (any)
seed: (any)
target-scope: (any)
use-hold: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/routing/fantasy/{id} get delete patch

get

delete

patch

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

URI Parameters

id: required(string)

Body

Media type: application/json

Type: object

Properties

comment: (any)
count: (any)
dealer-id: (any)
disabled: (any)
dst-address: (any)
gateway: (any)
instance-id: (any)
name: (any)
numbers: (any)
offset: (any)
prefix-length: (any)
priv-offs: (any)
priv-size: (any)
scope: (any)
seed: (any)
target-scope: (any)
use-hold: (any)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/routing/fantasy/print post

post

/routing/fantasy/reset post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

comment: (any)
count: (any)
dealer-id: (any)
disabled: (any)
dst-address: (any)
gateway: (any)
instance-id: (any)
name: (any)
numbers: (any)
offset: (any)
prefix-length: (any)
priv-offs: (any)
priv-size: (any)
scope: (any)
seed: (any)
target-scope: (any)
use-hold: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/routing/fantasy/set post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

comment: (any)
count: (any)
dealer-id: (any)
disabled: (any)
dst-address: (any)
gateway: (any)
instance-id: (any)
name: (any)
numbers: (any)
offset: (any)
prefix-length: (any)
priv-offs: (any)
priv-size: (any)
scope: (any)
seed: (any)
target-scope: (any)
use-hold: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/routing/filter/chain/print post

post

/routing/filter/community-ext-list get put

get

put

/routing/filter/community-ext-list/{id} get delete patch

get

delete

patch

/routing/filter/community-ext-list/print post

post

/routing/filter/community-large-list get put

get

put

/routing/filter/community-large-list/{id} get delete patch

get

delete

patch

/routing/filter/community-large-list/print post

post

/routing/filter/community-list get put

get

put

/routing/filter/community-list/add post

post

/routing/filter/community-list/{id} get delete patch

get

delete

patch

/routing/filter/community-list/print post

post

/routing/filter/num-list get put

get

put

/routing/filter/num-list/{id} get delete patch

get

delete

patch

/routing/filter/num-list/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/routing/filter/rule get put

get

put

/routing/filter/rule/{id} get delete patch

get

delete

patch

/routing/filter/rule/print post

post

/routing/filter/select-rule get put

get

put

/routing/filter/select-rule/add post

post

/routing/filter/select-rule/{id} get delete patch

get

delete

patch

/routing/filter/select-rule/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/routing/filter/select-rule/reset post

post

/routing/filter/select-rule/set post

post

/routing/gmp get put

get

put

/routing/gmp/{id} get delete patch

get

delete

patch

/routing/gmp/print post

post

/routing/id get put

get

put

/routing/id/{id} get delete patch

get

delete

patch

/routing/id/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/routing/igmp-proxy/{id} get patch

get

patch

/routing/igmp-proxy/interface get put

get

put

/routing/igmp-proxy/interface/add post

post

/routing/igmp-proxy/interface/{id} get delete patch

get

delete

patch

/routing/igmp-proxy/interface/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
status: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/routing/igmp-proxy/interface/reset post

post

/routing/igmp-proxy/interface/set post

post

/routing/igmp-proxy/mfc get put

get

put

/routing/igmp-proxy/mfc/{id} get delete patch

get

delete

patch

/routing/igmp-proxy/mfc/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/routing/nexthop/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
interval: (any)
proplist: (any)
show-ids: (any)
stats: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/routing/ospf/area/{id} get delete

get

delete

/routing/ospf/area/print post

post

/routing/ospf/area/range get put

get

put

/routing/ospf/area/range/{id} get delete patch

get

delete

patch

/routing/ospf/area/range/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/routing/ospf/instance get put

get

put

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

comment: (any)
copy-from: (any)
disabled: (any)
domain-id: (any)
domain-tag: (any)
in-filter-chain: (any)
mpls-te-address: (any)
mpls-te-area: (any)
name: (any)
originate-default: (any)
out-filter-chain: (any)
out-filter-select: (any)
redistribute: (any)
router-id: (any)
routing-table: (any)
use-dn: (any)
version: (any)
vrf: (any)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/routing/ospf/instance/add post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

comment: (any)
copy-from: (any)
disabled: (any)
domain-id: (any)
domain-tag: (any)
in-filter-chain: (any)
mpls-te-address: (any)
mpls-te-area: (any)
name: (any)
originate-default: (any)
out-filter-chain: (any)
out-filter-select: (any)
redistribute: (any)
router-id: (any)
routing-table: (any)
use-dn: (any)
version: (any)
vrf: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/routing/ospf/instance/{id} get delete patch

get

delete

patch

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

URI Parameters

id: required(string)

Body

Media type: application/json

Type: object

Properties

comment: (any)
disabled: (any)
domain-id: (any)
domain-tag: (any)
in-filter-chain: (any)
mpls-te-address: (any)
mpls-te-area: (any)
name: (any)
numbers: (any)
originate-default: (any)
out-filter-chain: (any)
out-filter-select: (any)
redistribute: (any)
router-id: (any)
routing-table: (any)
use-dn: (any)
version: (any)
vrf: (any)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/routing/ospf/instance/print post

post

/routing/ospf/instance/reset post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

comment: (any)
disabled: (any)
domain-id: (any)
domain-tag: (any)
in-filter-chain: (any)
mpls-te-address: (any)
mpls-te-area: (any)
name: (any)
numbers: (any)
originate-default: (any)
out-filter-chain: (any)
out-filter-select: (any)
redistribute: (any)
router-id: (any)
routing-table: (any)
use-dn: (any)
version: (any)
vrf: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/routing/ospf/instance/set post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

comment: (any)
disabled: (any)
domain-id: (any)
domain-tag: (any)
in-filter-chain: (any)
mpls-te-address: (any)
mpls-te-area: (any)
name: (any)
numbers: (any)
originate-default: (any)
out-filter-chain: (any)
out-filter-select: (any)
redistribute: (any)
router-id: (any)
routing-table: (any)
use-dn: (any)
version: (any)
vrf: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/routing/ospf/interface/print post

post

/routing/ospf/interface-template/{id} get delete

get

delete

/routing/ospf/interface-template/print post

post

/routing/ospf/lsa/print post

post

/routing/ospf/neighbor/{id} get patch

get

patch

/routing/ospf/neighbor/print post

post

/routing/ospf/static-neighbor get put

get

put

/routing/ospf/static-neighbor/add post

post

/routing/ospf/static-neighbor/{id} get delete patch

get

delete

patch

/routing/ospf/static-neighbor/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/routing/ospf/static-neighbor/set post

post

/routing/pimsm/bsr/candidate get put

get

put

/routing/pimsm/bsr/candidate/add post

post

/routing/pimsm/bsr/candidate/{id} get delete patch

get

delete

patch

/routing/pimsm/bsr/candidate/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/routing/pimsm/bsr/candidate/reset post

post

/routing/pimsm/bsr/candidate/set post

post

/routing/pimsm/bsr/print post

post

/routing/pimsm/bsr/rp-candidate get put

get

put

/routing/pimsm/bsr/rp-candidate/{id} get delete patch

get

delete

patch

/routing/pimsm/bsr/rp-candidate/print post

post

/routing/pimsm/bsr/rp-set/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/routing/pimsm/igmp-interface-template/{id} get patch

get

patch

/routing/pimsm/igmp-interface-template/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/routing/pimsm/instance get put

get

put

/routing/pimsm/instance/add post

post

/routing/pimsm/instance/{id} get delete patch

get

delete

patch

/routing/pimsm/instance/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/routing/pimsm/instance/reset post

post

/routing/pimsm/instance/set post

post

/routing/pimsm/interface/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/routing/pimsm/interface-template get put

get

put

/routing/pimsm/interface-template/add post

post

/routing/pimsm/interface-template/{id} get delete patch

get

delete

patch

/routing/pimsm/interface-template/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/routing/pimsm/interface-template/reset post

post

/routing/pimsm/interface-template/set post

post

/routing/pimsm/neighbor/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/routing/pimsm/static-rp get put

get

put

/routing/pimsm/static-rp/{id} get delete patch

get

delete

patch

/routing/pimsm/static-rp/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/routing/pimsm/uib-g/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/routing/pimsm/uib-sg/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/routing/rip/instance get put

get

put

/routing/rip/instance/add post

post

/routing/rip/instance/{id} get delete patch

get

delete

patch

/routing/rip/instance/print post

post

/routing/rip/instance/reset post

post

/routing/rip/instance/set post

post

/routing/rip/interface/print post

post

/routing/rip/interface-template get put

get

put

/routing/rip/interface-template/add post

post

/routing/rip/interface-template/{id} get delete patch

get

delete

patch

/routing/rip/interface-template/print post

post

/routing/rip/interface-template/reset post

post

/routing/rip/interface-template/set post

post

/routing/rip/keys get put

get

put

/routing/rip/keys/{id} get delete patch

get

delete

patch

/routing/rip/keys/print post

post

/routing/rip/neighbor/print post

post

/routing/rip/static-neighbor get put

get

put

/routing/rip/static-neighbor/{id} get delete patch

get

delete

patch

/routing/rip/static-neighbor/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/routing/route/{id} get patch

get

patch

/routing/route/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
interval: (any)
proplist: (any)
show-ids: (any)
stats: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/routing/route/rule/{id} get patch

get

patch

/routing/route/rule/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/routing/route/rule/reset post

post

/routing/route/rule/set post

post

/routing/rpki get put

get

put

/routing/rpki/add post

post

/routing/rpki/{id} get delete patch

get

delete

patch

/routing/rpki/print post

post

/routing/rpki/reset post

post

/routing/rpki/session/print post

post

/routing/rpki/set post

post

/routing/rule get put

get

put

/routing/rule/add post

post

/routing/rule/{id} get delete patch

get

delete

patch

/routing/rule/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/routing/rule/reset post

post

/routing/rule/set post

post

/routing/stats/info post

post

/routing/stats/memory/print post

post

/routing/stats/origin/print post

post

/routing/stats/pcap/print post

post

/routing/stats/process/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/routing/stats/step/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/routing/table get put

get

put

/routing/table/{id} get delete patch

get

delete

patch

/routing/table/print post

post

/rsync-daemon

/rsync-daemon/{id} get patch

get

patch

/set

/{id}

/snmp

/snmp/community get put

get

put

/snmp/community/add post

post

/snmp/community/{id} get delete patch

get

delete

patch

/snmp/community/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/snmp/community/reset post

post

/snmp/community/set post

post

/snmp/{id} get patch

get

patch

/snmp/set post

post

/special-login

/special-login get put

get

put

/special-login/{id} get delete patch

get

delete

patch

/special-login/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/system

/system/backup/cloud/download-file post

post

/system/backup/cloud/print post

post

/system/backup/cloud/remove-file post

post

/system/backup/cloud/upload-file post

post

/system/check-installation post

post

/system/clock/{id} get patch

get

patch

/system/clock/manual/{id} get patch

get

patch

/system/console get put

get

put

/system/console/{id} get delete patch

get

delete

patch

/system/console/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/system/device-mode/update post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

activation-timeout: (any)
append: (any)
as-value: (any)
bandwidth-test: (any)
container: (any)
do: (any)
duration: (any)
email: (any)
fetch: (any)
file: (any)
flagged: (any)
flagging-enabled: (any)
hotspot: (any)
interval: (any)
ipsec: (any)
l2tp: (any)
mode: (any)
once: (any)
pptp: (any)
proxy: (any)
romon: (any)
scheduler: (any)
smb: (any)
sniffer: (any)
socks: (any)
traffic-gen: (any)
without-paging: (any)
zerotier: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/system/gps/{id} get patch

get

patch

/system/gps/monitor post

post

/system/health/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
oid: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/system/health/settings/{id} get patch

get

patch

/system/health/settings/set post

post

/system/history/print post

post

/system/identity/{id} get patch

get

patch

/system/leds/{id} get delete

get

delete

/system/leds/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/system/leds/settings/{id} get patch

get

patch

/system/logging get put

get

put

/system/logging/action get put

get

put

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

bsd-syslog: (any)
comment: (any)
copy-from: (any)
disk-file-count: (any)
disk-file-name: (any)
disk-lines-per-file: (any)
disk-stop-on-full: (any)
email-start-tls: (any)
email-to: (any)
memory-lines: (any)
memory-stop-on-full: (any)
name: (any)
remember: (any)
remote: (any)
remote-port: (any)
src-address: (any)
syslog-facility: (any)
syslog-severity: (any)
syslog-time-format: (any)
target: (any)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/system/logging/action/add post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

bsd-syslog: (any)
comment: (any)
copy-from: (any)
disk-file-count: (any)
disk-file-name: (any)
disk-lines-per-file: (any)
disk-stop-on-full: (any)
email-start-tls: (any)
email-to: (any)
memory-lines: (any)
memory-stop-on-full: (any)
name: (any)
remember: (any)
remote: (any)
remote-port: (any)
src-address: (any)
syslog-facility: (any)
syslog-severity: (any)
syslog-time-format: (any)
target: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/system/logging/action/{id} get delete patch

get

delete

patch

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

URI Parameters

id: required(string)

Body

Media type: application/json

Type: object

Properties

bsd-syslog: (any)
comment: (any)
disk-file-count: (any)
disk-file-name: (any)
disk-lines-per-file: (any)
disk-stop-on-full: (any)
email-start-tls: (any)
email-to: (any)
memory-lines: (any)
memory-stop-on-full: (any)
name: (any)
numbers: (any)
remember: (any)
remote: (any)
remote-port: (any)
src-address: (any)
syslog-facility: (any)
syslog-severity: (any)
syslog-time-format: (any)
target: (any)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/system/logging/action/print post

post

/system/logging/action/reset post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

bsd-syslog: (any)
comment: (any)
disk-file-count: (any)
disk-file-name: (any)
disk-lines-per-file: (any)
disk-stop-on-full: (any)
email-start-tls: (any)
email-to: (any)
memory-lines: (any)
memory-stop-on-full: (any)
name: (any)
numbers: (any)
remember: (any)
remote: (any)
remote-port: (any)
src-address: (any)
syslog-facility: (any)
syslog-severity: (any)
syslog-time-format: (any)
target: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/system/logging/action/set post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

bsd-syslog: (any)
comment: (any)
disk-file-count: (any)
disk-file-name: (any)
disk-lines-per-file: (any)
disk-stop-on-full: (any)
email-start-tls: (any)
email-to: (any)
memory-lines: (any)
memory-stop-on-full: (any)
name: (any)
numbers: (any)
remember: (any)
remote: (any)
remote-port: (any)
src-address: (any)
syslog-facility: (any)
syslog-severity: (any)
syslog-time-format: (any)
target: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/system/logging/{id} get delete patch

get

delete

patch

/system/logging/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/system/note/{id} get patch

get

patch

/system/ntp/client/{id} get patch

get

patch

/system/ntp/client/servers get put

get

put

/system/ntp/client/servers/add post

post

/system/ntp/client/servers/{id} get delete patch

get

delete

patch

/system/ntp/client/servers/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/system/ntp/client/servers/reset post

post

/system/ntp/client/servers/set post

post

/system/ntp/key get put

get

put

/system/ntp/key/{id} get delete patch

get

delete

patch

/system/ntp/key/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/system/ntp/server/{id} get patch

get

patch

/system/ntp/server/set post

post

/system/package/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/system/package/update/check-for-updates post

post

/system/package/update/download post

post

/system/package/update/{id} get patch

get

patch

/system/package/update/install post

post

/system/reset-configuration post

post

/system/resource/cpu/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
oid: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/system/resource/irq/{id} get patch

get

patch

/system/resource/irq/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
per-cpu-count: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/system/resource/irq/rps/{id} get patch

get

patch

/system/resource/irq/rps/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/system/resource/monitor post

post

/system/resource/pci/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/system/resource/usb/{id} get patch

get

patch

/system/resource/usb/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/system/resource/usb/set post

post

/system/resource/usb/settings/{id} get patch

get

patch

/system/routerboard/mode-button/{id} get patch

get

patch

/system/routerboard/reset-button/{id} get patch

get

patch

/system/routerboard/settings/{id} get patch

get

patch

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

URI Parameters

id: required(string)

Body

Media type: application/json

Type: object

Properties

auto-upgrade: (any)
baud-rate: (any)
boot-delay: (any)
boot-device: (any)
boot-os: (any)
boot-protocol: (any)
cpu-frequency: (any)
disable-pci: (any)
enable-jumper-reset: (any)
enter-setup-on: (any)
force-backup-booter: (any)
gpio-function: (any)
init-delay: (any)
preboot-etherboot: (any)
preboot-etherboot-server: (any)
protected-routerboot: (any)
reformat-hold-button: (any)
reformat-hold-button-max: (any)
regulatory-domain-ce: (any)
silent-boot: (any)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/system/routerboard/settings/set post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

auto-upgrade: (any)
baud-rate: (any)
boot-delay: (any)
boot-device: (any)
boot-os: (any)
boot-protocol: (any)
cpu-frequency: (any)
disable-pci: (any)
enable-jumper-reset: (any)
enter-setup-on: (any)
force-backup-booter: (any)
gpio-function: (any)
init-delay: (any)
preboot-etherboot: (any)
preboot-etherboot-server: (any)
protected-routerboot: (any)
reformat-hold-button: (any)
reformat-hold-button-max: (any)
regulatory-domain-ce: (any)
silent-boot: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/system/routerboard/wps-button/{id} get patch

get

patch

/system/scheduler get put

get

put

/system/scheduler/add post

post

/system/scheduler/{id} get delete patch

get

delete

patch

/system/scheduler/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/system/scheduler/reset post

post

/system/scheduler/set post

post

/system/script get put

get

put

/system/script/environment/{id} get delete patch

get

delete

patch

/system/script/environment/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/system/script/{id} get delete patch

get

delete

patch

/system/script/job/{id} get delete

get

delete

/system/script/job/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/system/script/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/system/upgrade/{id} get patch

get

patch

/system/upgrade/mirror/{id} get patch

get

patch

/system/upgrade/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/system/upgrade/upgrade-package-source get put

get

put

/system/upgrade/upgrade-package-source/{id} get delete patch

get

delete

patch

/system/upgrade/upgrade-package-source/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/system/ups get put

get

put

/system/ups/add post

post

/system/ups/{id} get delete patch

get

delete

patch

/system/ups/monitor post

post

/system/ups/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
oid: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/system/ups/reset post

post

/system/ups/set post

post

/system/watchdog/{id} get patch

get

patch

/system/watchdog/set post

post

/task

/task get put

get

put

/task/add post

post

/task/{id} get delete

get

delete

/task/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/terminal

/time

/timestamp

/toarray

/tobool

/toid

/toip

/toip6

/tonsec

/tonum

/tool

/tool/bandwidth-server/{id} get patch

get

patch

/tool/bandwidth-server/session/{id} get delete

get

delete

/tool/bandwidth-server/session/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/tool/bandwidth-test post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

address: (any)
append: (any)
as-value: (any)
connection-count: (any)
direction: (any)
do: (any)
duration: (any)
file: (any)
interval: (any)
local-tx-speed: (any)
local-udp-tx-size: (any)
once: (any)
password: (any)
protocol: (any)
random-data: (any)
remote-tx-speed: (any)
remote-udp-tx-size: (any)
user: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/tool/e-mail/{id} get patch

get

patch

/tool/e-mail/send post

post

/tool/fetch post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

address: (any)
as-value: (any)
ascii: (any)
certificate: (any)
check-certificate: (any)
dst-path: (any)
duration: (any)
host: (any)
http-data: (any)
http-header-field: (any)
http-method: (any)
keep-result: (any)
mode: (any)
once: (any)
output: (any)
password: (any)
port: (any)
src-address: (any)
src-path: (any)
upload: (any)
url: (any)
user: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/tool/flood-ping post

post

/tool/graphing/{id} get patch

get

patch

/tool/graphing/interface get put

get

put

/tool/graphing/interface/{id} get delete patch

get

delete

patch

/tool/graphing/interface/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/tool/graphing/queue get put

get

put

/tool/graphing/queue/add post

post

/tool/graphing/queue/{id} get delete patch

get

delete

patch

/tool/graphing/queue/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/tool/graphing/queue/reset post

post

/tool/graphing/queue/set post

post

/tool/graphing/resource get put

get

put

/tool/graphing/resource/{id} get delete patch

get

delete

patch

/tool/graphing/resource/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/tool/mac-server/{id} get patch

get

patch

/tool/mac-server/mac-winbox/{id} get patch

get

patch

/tool/mac-server/ping/{id} get patch

get

patch

/tool/mac-server/sessions/{id} get patch

get

patch

/tool/mac-server/sessions/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/tool/netwatch/{id} get delete

get

delete

/tool/netwatch/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
stats: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/tool/ping post

post

/tool/ping-speed post

post

/tool/romon/{id} get patch

get

patch

/tool/romon/port get put

get

put

/tool/romon/port/{id} get delete patch

get

delete

patch

/tool/romon/port/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/tool/sms/{id} get patch

get

patch

/tool/sms/inbox/{id} get delete

get

delete

/tool/sms/inbox/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/tool/sniffer/connection/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/tool/sniffer/{id} get patch

get

patch

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

URI Parameters

id: required(string)

Body

Media type: application/json

Type: object

Properties

file-limit: (any)
file-name: (any)
filter-cpu: (any)
filter-direction: (any)
filter-dst-ip-address: (any)
filter-dst-ipv6-address: (any)
filter-dst-mac-address: (any)
filter-dst-port: (any)
filter-interface: (any)
filter-ip-address: (any)
filter-ip-protocol: (any)
filter-ipv6-address: (any)
filter-mac-address: (any)
filter-mac-protocol: (any)
filter-operator-between-entries: (any)
filter-port: (any)
filter-size: (any)
filter-src-ip-address: (any)
filter-src-ipv6-address: (any)
filter-src-mac-address: (any)
filter-src-port: (any)
filter-stream: (any)
filter-vlan: (any)
memory-limit: (any)
memory-scroll: (any)
only-headers: (any)
streaming-enabled: (any)
streaming-server: (any)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/tool/sniffer/host/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/tool/sniffer/packet/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
raw: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/tool/sniffer/protocol/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/tool/sniffer/quick post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

as-value: (any)
cpu: (any)
direction: (any)
dst-ip-address: (any)
dst-ipv6-address: (any)
dst-mac-address: (any)
dst-port: (any)
duration: (any)
freeze-frame-interval: (any)
interface: (any)
ip-address: (any)
ip-protocol: (any)
ipv6-address: (any)
mac-address: (any)
mac-protocol: (any)
operator-between-entries: (any)
port: (any)
size: (any)
src-ip-address: (any)
src-ipv6-address: (any)
src-mac-address: (any)
src-port: (any)
vlan-id: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/tool/sniffer/set post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

file-limit: (any)
file-name: (any)
filter-cpu: (any)
filter-direction: (any)
filter-dst-ip-address: (any)
filter-dst-ipv6-address: (any)
filter-dst-mac-address: (any)
filter-dst-port: (any)
filter-interface: (any)
filter-ip-address: (any)
filter-ip-protocol: (any)
filter-ipv6-address: (any)
filter-mac-address: (any)
filter-mac-protocol: (any)
filter-operator-between-entries: (any)
filter-port: (any)
filter-size: (any)
filter-src-ip-address: (any)
filter-src-ipv6-address: (any)
filter-src-mac-address: (any)
filter-src-port: (any)
filter-stream: (any)
filter-vlan: (any)
memory-limit: (any)
memory-scroll: (any)
only-headers: (any)
streaming-enabled: (any)
streaming-server: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/tool/sniffer/start post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

cpu: (any)
direction: (any)
dst-ip-address: (any)
dst-ipv6-address: (any)
dst-mac-address: (any)
dst-port: (any)
interface: (any)
ip-address: (any)
ip-protocol: (any)
ipv6-address: (any)
mac-address: (any)
mac-protocol: (any)
operator-between-entries: (any)
port: (any)
size: (any)
src-ip-address: (any)
src-ipv6-address: (any)
src-mac-address: (any)
src-port: (any)
vlan-id: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/tool/snmp-get post

post

/tool/snmp-walk post

post

/tool/speed-test post

post

/tool/torch post

post

/tool/traceroute post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

address: (any)
as-value: (any)
count: (any)
do-not-fragment: (any)
dscp: (any)
duration: (any)
freeze-frame-interval: (any)
interface: (any)
max-hops: (any)
port: (any)
protocol: (any)
size: (any)
src-address: (any)
timeout: (any)
use-dns: (any)
vrf: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/tool/traffic-generator/{id} get patch

get

patch

/tool/traffic-generator/inject-pcap post

post

/tool/traffic-generator/packet-template get put

get

put

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

comment: (any)
compute-checksum-from-offset: (any)
copy-from: (any)
data: (any)
data-byte: (any)
header-stack: (any)
interface: (any)
ip-dscp: (any)
ip-dst: (any)
ip-frag-off: (any)
ip-gateway: (any)
ip-id: (any)
ip-protocol: (any)
ip-src: (any)
ip-ttl: (any)
ipv6-dst: (any)
ipv6-flow-label: (any)
ipv6-gateway: (any)
ipv6-hop-limit: (any)
ipv6-next-header: (any)
ipv6-src: (any)
ipv6-traffic-class: (any)
mac-dst: (any)
mac-protocol: (any)
mac-src: (any)
name: (any)
port: (any)
random-byte-offsets-and-masks: (any)
random-ranges: (any)
raw-header: (any)
special-footer: (any)
tcp-ack: (any)
tcp-data-offset: (any)
tcp-dst-port: (any)
tcp-flags: (any)
tcp-src-port: (any)
tcp-syn: (any)
tcp-urgent-pointer: (any)
tcp-window-size: (any)
udp-checksum: (any)
udp-dst-port: (any)
udp-src-port: (any)
vlan-id: (any)
vlan-priority: (any)
vlan-protocol: (any)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/tool/traffic-generator/packet-template/add post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

comment: (any)
compute-checksum-from-offset: (any)
copy-from: (any)
data: (any)
data-byte: (any)
header-stack: (any)
interface: (any)
ip-dscp: (any)
ip-dst: (any)
ip-frag-off: (any)
ip-gateway: (any)
ip-id: (any)
ip-protocol: (any)
ip-src: (any)
ip-ttl: (any)
ipv6-dst: (any)
ipv6-flow-label: (any)
ipv6-gateway: (any)
ipv6-hop-limit: (any)
ipv6-next-header: (any)
ipv6-src: (any)
ipv6-traffic-class: (any)
mac-dst: (any)
mac-protocol: (any)
mac-src: (any)
name: (any)
port: (any)
random-byte-offsets-and-masks: (any)
random-ranges: (any)
raw-header: (any)
special-footer: (any)
tcp-ack: (any)
tcp-data-offset: (any)
tcp-dst-port: (any)
tcp-flags: (any)
tcp-src-port: (any)
tcp-syn: (any)
tcp-urgent-pointer: (any)
tcp-window-size: (any)
udp-checksum: (any)
udp-dst-port: (any)
udp-src-port: (any)
vlan-id: (any)
vlan-priority: (any)
vlan-protocol: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/tool/traffic-generator/packet-template/{id} get delete patch

get

delete

patch

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

URI Parameters

id: required(string)

Body

Media type: application/json

Type: object

Properties

comment: (any)
compute-checksum-from-offset: (any)
data: (any)
data-byte: (any)
header-stack: (any)
interface: (any)
ip-dscp: (any)
ip-dst: (any)
ip-frag-off: (any)
ip-gateway: (any)
ip-id: (any)
ip-protocol: (any)
ip-src: (any)
ip-ttl: (any)
ipv6-dst: (any)
ipv6-flow-label: (any)
ipv6-gateway: (any)
ipv6-hop-limit: (any)
ipv6-next-header: (any)
ipv6-src: (any)
ipv6-traffic-class: (any)
mac-dst: (any)
mac-protocol: (any)
mac-src: (any)
name: (any)
numbers: (any)
port: (any)
random-byte-offsets-and-masks: (any)
random-ranges: (any)
raw-header: (any)
special-footer: (any)
tcp-ack: (any)
tcp-data-offset: (any)
tcp-dst-port: (any)
tcp-flags: (any)
tcp-src-port: (any)
tcp-syn: (any)
tcp-urgent-pointer: (any)
tcp-window-size: (any)
udp-checksum: (any)
udp-dst-port: (any)
udp-src-port: (any)
vlan-id: (any)
vlan-priority: (any)
vlan-protocol: (any)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/tool/traffic-generator/packet-template/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/tool/traffic-generator/packet-template/reset post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

comment: (any)
compute-checksum-from-offset: (any)
data: (any)
data-byte: (any)
header-stack: (any)
interface: (any)
ip-dscp: (any)
ip-dst: (any)
ip-frag-off: (any)
ip-gateway: (any)
ip-id: (any)
ip-protocol: (any)
ip-src: (any)
ip-ttl: (any)
ipv6-dst: (any)
ipv6-flow-label: (any)
ipv6-gateway: (any)
ipv6-hop-limit: (any)
ipv6-next-header: (any)
ipv6-src: (any)
ipv6-traffic-class: (any)
mac-dst: (any)
mac-protocol: (any)
mac-src: (any)
name: (any)
numbers: (any)
port: (any)
random-byte-offsets-and-masks: (any)
random-ranges: (any)
raw-header: (any)
special-footer: (any)
tcp-ack: (any)
tcp-data-offset: (any)
tcp-dst-port: (any)
tcp-flags: (any)
tcp-src-port: (any)
tcp-syn: (any)
tcp-urgent-pointer: (any)
tcp-window-size: (any)
udp-checksum: (any)
udp-dst-port: (any)
udp-src-port: (any)
vlan-id: (any)
vlan-priority: (any)
vlan-protocol: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/tool/traffic-generator/packet-template/set post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

comment: (any)
compute-checksum-from-offset: (any)
data: (any)
data-byte: (any)
header-stack: (any)
interface: (any)
ip-dscp: (any)
ip-dst: (any)
ip-frag-off: (any)
ip-gateway: (any)
ip-id: (any)
ip-protocol: (any)
ip-src: (any)
ip-ttl: (any)
ipv6-dst: (any)
ipv6-flow-label: (any)
ipv6-gateway: (any)
ipv6-hop-limit: (any)
ipv6-next-header: (any)
ipv6-src: (any)
ipv6-traffic-class: (any)
mac-dst: (any)
mac-protocol: (any)
mac-src: (any)
name: (any)
numbers: (any)
port: (any)
random-byte-offsets-and-masks: (any)
random-ranges: (any)
raw-header: (any)
special-footer: (any)
tcp-ack: (any)
tcp-data-offset: (any)
tcp-dst-port: (any)
tcp-flags: (any)
tcp-src-port: (any)
tcp-syn: (any)
tcp-urgent-pointer: (any)
tcp-window-size: (any)
udp-checksum: (any)
udp-dst-port: (any)
udp-src-port: (any)
vlan-id: (any)
vlan-priority: (any)
vlan-protocol: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/tool/traffic-generator/port get put

get

put

/tool/traffic-generator/port/{id} get delete patch

get

delete

patch

/tool/traffic-generator/port/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/tool/traffic-generator/quick post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

as-value: (any)
cpu-core: (any)
duration: (any)
entries-to-show: (any)
freeze-frame-interval: (any)
id: (any)
interface: (any)
mbps: (any)
measure-out-of-order: (any)
packet-count: (any)
packet-size: (any)
port: (any)
pps: (any)
stream: (any)
test-id: (any)
tx-template: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/tool/traffic-generator/raw-packet-template get put

get

put

/tool/traffic-generator/raw-packet-template/add post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

comment: (any)
compute-checksum-from-offset: (any)
copy-from: (any)
data: (any)
data-byte: (any)
header: (any)
ip-header-offset: (any)
ipv6-header-offset: (any)
name: (any)
port: (any)
random-byte-offsets-and-masks: (any)
random-ranges: (any)
special-footer: (any)
tcp-header-offset: (any)
udp-compute-checksum: (any)
udp-header-offset: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/tool/traffic-generator/raw-packet-template/{id} get delete patch

get

delete

patch

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

URI Parameters

id: required(string)

Body

Media type: application/json

Type: object

Properties

comment: (any)
compute-checksum-from-offset: (any)
data: (any)
data-byte: (any)
header: (any)
ip-header-offset: (any)
ipv6-header-offset: (any)
name: (any)
numbers: (any)
port: (any)
random-byte-offsets-and-masks: (any)
random-ranges: (any)
special-footer: (any)
tcp-header-offset: (any)
udp-compute-checksum: (any)
udp-header-offset: (any)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/tool/traffic-generator/raw-packet-template/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/tool/traffic-generator/raw-packet-template/reset post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

comment: (any)
compute-checksum-from-offset: (any)
data: (any)
data-byte: (any)
header: (any)
ip-header-offset: (any)
ipv6-header-offset: (any)
name: (any)
numbers: (any)
port: (any)
random-byte-offsets-and-masks: (any)
random-ranges: (any)
special-footer: (any)
tcp-header-offset: (any)
udp-compute-checksum: (any)
udp-header-offset: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/tool/traffic-generator/raw-packet-template/set post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

comment: (any)
compute-checksum-from-offset: (any)
data: (any)
data-byte: (any)
header: (any)
ip-header-offset: (any)
ipv6-header-offset: (any)
name: (any)
numbers: (any)
port: (any)
random-byte-offsets-and-masks: (any)
random-ranges: (any)
special-footer: (any)
tcp-header-offset: (any)
udp-compute-checksum: (any)
udp-header-offset: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/tool/traffic-generator/start post

post

/tool/traffic-generator/stats/latency-distribution/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
port: (any)
proplist: (any)
seq: (any)
show-ids: (any)
stream-id: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/tool/traffic-generator/stats/port/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/tool/traffic-generator/stats/raw/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/tool/traffic-generator/stats/stream/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/tool/traffic-generator/stream get put

get

put

/tool/traffic-generator/stream/add post

post

/tool/traffic-generator/stream/{id} get delete patch

get

delete

patch

/tool/traffic-generator/stream/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/tool/traffic-generator/stream/reset post

post

/tool/traffic-generator/stream/set post

post

/tool/traffic-monitor get put

get

put

/tool/traffic-monitor/add post

post

/tool/traffic-monitor/{id} get delete patch

get

delete

patch

/tool/traffic-monitor/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/tool/traffic-monitor/reset post

post

/tool/traffic-monitor/set post

post

/tostr

/totime

/tr069-client

/tr069-client/{id} get patch

get

patch

/tr069-client/set post

post

/typeof

/undo

/user

/user get put

get

put

/user/aaa/{id} get patch

get

patch

/user/active/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/user/{id} get delete patch

get

delete

patch

/user/group get put

get

put

/user/group/{id} get delete patch

get

delete

patch

/user/group/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/user/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/user/settings/{id} get patch

get

patch

/user/ssh-keys get put

get

put

/user/ssh-keys/{id} get delete

get

delete

/user/ssh-keys/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/user/ssh-keys/private/{id} get delete

get

delete

/user/ssh-keys/private/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/user-manager

/user-manager/advanced/{id} get patch

get

patch

/user-manager/advanced/set post

post

/user-manager/attribute get put

get

put

/user-manager/attribute/{id} get delete patch

get

delete

patch

/user-manager/attribute/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/user-manager/database/{id} get patch

get

patch

/user-manager/{id} get patch

get

patch

/user-manager/limitation get put

get

put

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

comment: (any)
copy-from: (any)
download-limit: (any)
name: (any)
rate-limit-burst-rx: (any)
rate-limit-burst-threshold-rx: (any)
rate-limit-burst-threshold-tx: (any)
rate-limit-burst-time-rx: (any)
rate-limit-burst-time-tx: (any)
rate-limit-burst-tx: (any)
rate-limit-min-rx: (any)
rate-limit-min-tx: (any)
rate-limit-priority: (any)
rate-limit-rx: (any)
rate-limit-tx: (any)
reset-counters-interval: (any)
reset-counters-start-time: (any)
transfer-limit: (any)
upload-limit: (any)
uptime-limit: (any)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/user-manager/limitation/add post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

comment: (any)
copy-from: (any)
download-limit: (any)
name: (any)
rate-limit-burst-rx: (any)
rate-limit-burst-threshold-rx: (any)
rate-limit-burst-threshold-tx: (any)
rate-limit-burst-time-rx: (any)
rate-limit-burst-time-tx: (any)
rate-limit-burst-tx: (any)
rate-limit-min-rx: (any)
rate-limit-min-tx: (any)
rate-limit-priority: (any)
rate-limit-rx: (any)
rate-limit-tx: (any)
reset-counters-interval: (any)
reset-counters-start-time: (any)
transfer-limit: (any)
upload-limit: (any)
uptime-limit: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/user-manager/limitation/{id} get delete patch

get

delete

patch

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

URI Parameters

id: required(string)

Body

Media type: application/json

Type: object

Properties

comment: (any)
download-limit: (any)
name: (any)
numbers: (any)
rate-limit-burst-rx: (any)
rate-limit-burst-threshold-rx: (any)
rate-limit-burst-threshold-tx: (any)
rate-limit-burst-time-rx: (any)
rate-limit-burst-time-tx: (any)
rate-limit-burst-tx: (any)
rate-limit-min-rx: (any)
rate-limit-min-tx: (any)
rate-limit-priority: (any)
rate-limit-rx: (any)
rate-limit-tx: (any)
reset-counters-interval: (any)
reset-counters-start-time: (any)
transfer-limit: (any)
upload-limit: (any)
uptime-limit: (any)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/user-manager/limitation/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/user-manager/limitation/reset post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

comment: (any)
download-limit: (any)
name: (any)
numbers: (any)
rate-limit-burst-rx: (any)
rate-limit-burst-threshold-rx: (any)
rate-limit-burst-threshold-tx: (any)
rate-limit-burst-time-rx: (any)
rate-limit-burst-time-tx: (any)
rate-limit-burst-tx: (any)
rate-limit-min-rx: (any)
rate-limit-min-tx: (any)
rate-limit-priority: (any)
rate-limit-rx: (any)
rate-limit-tx: (any)
reset-counters-interval: (any)
reset-counters-start-time: (any)
transfer-limit: (any)
upload-limit: (any)
uptime-limit: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/user-manager/limitation/set post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

comment: (any)
download-limit: (any)
name: (any)
numbers: (any)
rate-limit-burst-rx: (any)
rate-limit-burst-threshold-rx: (any)
rate-limit-burst-threshold-tx: (any)
rate-limit-burst-time-rx: (any)
rate-limit-burst-time-tx: (any)
rate-limit-burst-tx: (any)
rate-limit-min-rx: (any)
rate-limit-min-tx: (any)
rate-limit-priority: (any)
rate-limit-rx: (any)
rate-limit-tx: (any)
reset-counters-interval: (any)
reset-counters-start-time: (any)
transfer-limit: (any)
upload-limit: (any)
uptime-limit: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/user-manager/monitor post

post

/user-manager/payment get put

get

put

/user-manager/payment/add post

post

/user-manager/payment/{id} get delete patch

get

delete

patch

/user-manager/payment/print post

post

/user-manager/payment/reset post

post

/user-manager/payment/set post

post

/user-manager/profile get put

get

put

/user-manager/profile/add post

post

/user-manager/profile/{id} get delete patch

get

delete

patch

/user-manager/profile/print post

post

/user-manager/profile/reset post

post

/user-manager/profile/set post

post

/user-manager/profile-limitation get put

get

put

/user-manager/profile-limitation/{id} get delete patch

get

delete

patch

/user-manager/profile-limitation/print post

post

/user-manager/router get put

get

put

/user-manager/router/{id} get delete patch

get

delete

patch

/user-manager/router/monitor post

post

/user-manager/router/print post

post

/user-manager/router/reset post

post

/user-manager/session get put

get

put

/user-manager/session/{id} get delete

get

delete

/user-manager/session/print post

post

/user-manager/user get put

get

put

/user-manager/user/add post

post

/user-manager/user/add-batch-users post

post

/user-manager/user/{id} get delete patch

get

delete

patch

/user-manager/user/group get put

get

put

/user-manager/user/group/{id} get delete patch

get

delete

patch

/user-manager/user/group/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/user-manager/user/monitor post

post

/user-manager/user/print post

post

/user-manager/user/reset post

post

/user-manager/user/set post

post

/user-manager/user-profile get put

get

put

/user-manager/user-profile/{id} get delete

get

delete

/user-manager/user-profile/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/while

/zerotier

/zerotier get put

get

put

/zerotier/controller get put

get

put

/zerotier/controller/add post

post

/zerotier/controller/{id} get delete patch

get

delete

patch

/zerotier/controller/member get put

get

put

/zerotier/controller/member/add post

post

/zerotier/controller/member/{id} get delete patch

get

delete

patch

/zerotier/controller/member/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/zerotier/controller/member/reset post

post

/zerotier/controller/member/set post

post

/zerotier/controller/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/zerotier/controller/reset post

post

/zerotier/controller/set post

post

/zerotier/{id} get delete patch

get

delete

patch

/zerotier/interface get put

get

put

/zerotier/interface/add post

post

/zerotier/interface/{id} get delete patch

get

delete

patch

/zerotier/interface/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/zerotier/interface/reset post

post

/zerotier/interface/set post

post

/zerotier/peer/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

Secured by basic

/zerotier/print post

post

Secured by basic

Mikrotik REST API only supports Basic Authentication, secured by HTTPS

Body

Media type: application/json

Type: object

Properties

append: (any)
as-value: (any)
brief: (any)
count-only: (any)
detail: (any)
file: (any)
follow: (any)
follow-only: (any)
follow-strict: (any)
from: (any)
interval: (any)
proplist: (any)
show-ids: (any)
terse: (any)
value-list: (any)
where: (any)
without-paging: (any)
.proplist: (any)
.query: (array)

HTTP status code 200

Success

Body

Media type: application/json

Type: any

HTTP status code 400

Bad command or error

Body

Media type: application/json

Type: object

HTTP status code 401

Unauthorized

Body

Media type: application/json

Type: object

RouterOS REST Schema (v7.12beta3.28240783-all) version v7.12beta3.28240783-all

/beep

post /beep

Body

HTTP status code 200

Body

HTTP status code 400

Body

HTTP status code 401

Body

Secured by basic

/blink

post /blink

Body

HTTP status code 200

Body

HTTP status code 400

Body

HTTP status code 401

Body

Secured by basic

/certificate

get /certificate

Query Parameters

HTTP status code 200

Body

HTTP status code 400

Body

HTTP status code 401

Body

Secured by basic

put /certificate

Body

HTTP status code 200

Body

HTTP status code 400

Body

HTTP status code 401

Body

Secured by basic

post /certificate/add

Body

HTTP status code 200

Body

HTTP status code 400

Body

HTTP status code 401

Body

Secured by basic

post /certificate/add-scep

Body

HTTP status code 200

Body

HTTP status code 400

Body

HTTP status code 401

Body

Secured by basic

post /certificate/card-reinstall

Body

HTTP status code 200

Body

HTTP status code 400

Body

HTTP status code 401

Body

Secured by basic

post /certificate/card-verify

Body

HTTP status code 200

Body

HTTP status code 400

Body

HTTP status code 401

Body

Secured by basic

post /certificate/create-certificate-request

Body

HTTP status code 200

Body