From 5b0b9eb7fc6b1bccbc56247708e5ed3f389133b1 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Tue, 21 May 2024 17:50:34 +0000 Subject: [PATCH] Publish 7.14.3 interface/vxlan to Web --- .../vxlan/ros-inspect-interface+vxlan.json | 1 + .../interface/vxlan/ros-rest-generated.html | 5096 +++++++++++++++++ .../vxlan/ros-rest-interface+vxlan.raml | 1678 ++++++ 3 files changed, 6775 insertions(+) create mode 100644 docs/7.14.3/interface/vxlan/ros-inspect-interface+vxlan.json create mode 100644 docs/7.14.3/interface/vxlan/ros-rest-generated.html create mode 100644 docs/7.14.3/interface/vxlan/ros-rest-interface+vxlan.raml diff --git a/docs/7.14.3/interface/vxlan/ros-inspect-interface+vxlan.json b/docs/7.14.3/interface/vxlan/ros-inspect-interface+vxlan.json new file mode 100644 index 0000000..0113295 --- /dev/null +++ b/docs/7.14.3/interface/vxlan/ros-inspect-interface+vxlan.json @@ -0,0 +1 @@ +{"add":{"type":"cmd","allow-fast-path":{"type":"arg"},"arp":{"type":"arg"},"arp-timeout":{"type":"arg","desc":"time interval"},"comment":{"type":"arg","desc":"string value"},"copy-from":{"type":"arg"},"disabled":{"type":"arg"},"dont-fragment":{"type":"arg"},"group":{"type":"arg","desc":"A.B.C.D (IP address)"},"interface":{"type":"arg"},"local-address":{"type":"arg","desc":"see documentation"},"loop-protect":{"type":"arg"},"loop-protect-disable-time":{"type":"arg","desc":"time interval"},"loop-protect-send-interval":{"type":"arg","desc":"1s..7101w3d6h28m15s (time interval)"},"mac-address":{"type":"arg","desc":"AB[:|-|.]CD[:|-|.]EF[:|-|.]GH[:|-|.]IJ[:|-|.]KL (MAC address)"},"max-fdb-size":{"type":"arg"},"mtu":{"type":"arg"},"name":{"type":"arg","desc":"string value"},"port":{"type":"arg"},"vni":{"type":"arg"},"vrf":{"type":"arg"},"vteps-ip-version":{"type":"arg"}},"comment":{"type":"cmd","comment":{"type":"arg","desc":"string value"},"numbers":{"type":"arg"}},"disable":{"type":"cmd","numbers":{"type":"arg"}},"edit":{"type":"cmd","number":{"type":"arg"},"value-name":{"type":"arg"}},"enable":{"type":"cmd","numbers":{"type":"arg"}},"export":{"type":"cmd","compact":{"type":"arg"},"file":{"type":"arg","desc":"string value"},"hide-sensitive":{"type":"arg"},"show-sensitive":{"type":"arg"},"terse":{"type":"arg"},"verbose":{"type":"arg"},"where":{"type":"arg"}},"fdb":{"type":"dir","find":{"type":"cmd","where":{"type":"arg"}},"get":{"type":"cmd","as-string":{"type":"arg"},"as-string-value":{"type":"arg"},"number":{"type":"arg"},"value-name":{"type":"arg"}},"print":{"type":"cmd","append":{"type":"arg"},"as-value":{"type":"arg"},"count-only":{"type":"arg"},"detail":{"type":"arg"},"file":{"type":"arg","desc":"string value"},"follow":{"type":"arg"},"follow-only":{"type":"arg"},"follow-strict":{"type":"arg"},"from":{"type":"arg"},"interval":{"type":"arg","desc":"00:00:00.200.. (time interval)"},"proplist":{"type":"arg"},"show-ids":{"type":"arg"},"terse":{"type":"arg"},"value-list":{"type":"arg"},"where":{"type":"arg"},"without-paging":{"type":"arg"}}},"find":{"type":"cmd","where":{"type":"arg"}},"get":{"type":"cmd","as-string":{"type":"arg"},"as-string-value":{"type":"arg"},"number":{"type":"arg"},"value-name":{"type":"arg"}},"print":{"type":"cmd","append":{"type":"arg"},"as-value":{"type":"arg"},"brief":{"type":"arg"},"count-only":{"type":"arg"},"detail":{"type":"arg"},"file":{"type":"arg","desc":"string value"},"follow":{"type":"arg"},"follow-only":{"type":"arg"},"follow-strict":{"type":"arg"},"from":{"type":"arg"},"interval":{"type":"arg","desc":"00:00:00.200.. (time interval)"},"proplist":{"type":"arg"},"show-ids":{"type":"arg"},"terse":{"type":"arg"},"value-list":{"type":"arg"},"where":{"type":"arg"},"without-paging":{"type":"arg"}},"remove":{"type":"cmd","numbers":{"type":"arg"}},"reset":{"type":"cmd","allow-fast-path":{"type":"arg"},"arp":{"type":"arg"},"arp-timeout":{"type":"arg","desc":"time interval"},"comment":{"type":"arg","desc":"string value"},"disabled":{"type":"arg"},"dont-fragment":{"type":"arg"},"group":{"type":"arg","desc":"A.B.C.D (IP address)"},"interface":{"type":"arg"},"local-address":{"type":"arg","desc":"see documentation"},"loop-protect":{"type":"arg"},"loop-protect-disable-time":{"type":"arg","desc":"time interval"},"loop-protect-send-interval":{"type":"arg","desc":"1s..7101w3d6h28m15s (time interval)"},"mac-address":{"type":"arg","desc":"AB[:|-|.]CD[:|-|.]EF[:|-|.]GH[:|-|.]IJ[:|-|.]KL (MAC address)"},"max-fdb-size":{"type":"arg"},"mtu":{"type":"arg"},"name":{"type":"arg","desc":"string value"},"numbers":{"type":"arg"},"port":{"type":"arg"},"vni":{"type":"arg"},"vrf":{"type":"arg"},"vteps-ip-version":{"type":"arg"}},"set":{"type":"cmd","allow-fast-path":{"type":"arg"},"arp":{"type":"arg"},"arp-timeout":{"type":"arg","desc":"time interval"},"comment":{"type":"arg","desc":"string value"},"disabled":{"type":"arg"},"dont-fragment":{"type":"arg"},"group":{"type":"arg","desc":"A.B.C.D (IP address)"},"interface":{"type":"arg"},"local-address":{"type":"arg","desc":"see documentation"},"loop-protect":{"type":"arg"},"loop-protect-disable-time":{"type":"arg","desc":"time interval"},"loop-protect-send-interval":{"type":"arg","desc":"1s..7101w3d6h28m15s (time interval)"},"mac-address":{"type":"arg","desc":"AB[:|-|.]CD[:|-|.]EF[:|-|.]GH[:|-|.]IJ[:|-|.]KL (MAC address)"},"max-fdb-size":{"type":"arg"},"mtu":{"type":"arg"},"name":{"type":"arg","desc":"string value"},"numbers":{"type":"arg"},"port":{"type":"arg"},"vni":{"type":"arg"},"vrf":{"type":"arg"},"vteps-ip-version":{"type":"arg"}},"unset":{"type":"cmd","numbers":{"type":"arg"},"value-name":{"type":"arg"}},"vteps":{"type":"dir","add":{"type":"cmd","copy-from":{"type":"arg"},"interface":{"type":"arg"},"port":{"type":"arg"},"remote-ip":{"type":"arg","desc":"A.B.C.D (IP address)"}},"edit":{"type":"cmd","number":{"type":"arg"},"value-name":{"type":"arg"}},"export":{"type":"cmd","compact":{"type":"arg"},"file":{"type":"arg","desc":"string value"},"hide-sensitive":{"type":"arg"},"show-sensitive":{"type":"arg"},"terse":{"type":"arg"},"verbose":{"type":"arg"},"where":{"type":"arg"}},"find":{"type":"cmd","where":{"type":"arg"}},"get":{"type":"cmd","as-string":{"type":"arg"},"as-string-value":{"type":"arg"},"number":{"type":"arg"},"value-name":{"type":"arg"}},"print":{"type":"cmd","append":{"type":"arg"},"as-value":{"type":"arg"},"brief":{"type":"arg"},"count-only":{"type":"arg"},"detail":{"type":"arg"},"file":{"type":"arg","desc":"string value"},"follow":{"type":"arg"},"follow-only":{"type":"arg"},"follow-strict":{"type":"arg"},"from":{"type":"arg"},"interval":{"type":"arg","desc":"00:00:00.200.. (time interval)"},"proplist":{"type":"arg"},"show-ids":{"type":"arg"},"terse":{"type":"arg"},"value-list":{"type":"arg"},"where":{"type":"arg"},"without-paging":{"type":"arg"}},"remove":{"type":"cmd","numbers":{"type":"arg"}},"reset":{"type":"cmd","interface":{"type":"arg"},"numbers":{"type":"arg"},"port":{"type":"arg"},"remote-ip":{"type":"arg","desc":"A.B.C.D (IP address)"}},"set":{"type":"cmd","interface":{"type":"arg"},"numbers":{"type":"arg"},"port":{"type":"arg"},"remote-ip":{"type":"arg","desc":"A.B.C.D (IP address)"}}}} \ No newline at end of file diff --git a/docs/7.14.3/interface/vxlan/ros-rest-generated.html b/docs/7.14.3/interface/vxlan/ros-rest-generated.html new file mode 100644 index 0000000..f85c123 --- /dev/null +++ b/docs/7.14.3/interface/vxlan/ros-rest-generated.html @@ -0,0 +1,5096 @@ +RouterOS REST Schema (v7.14.3.28605231-interface+vxlan) DocumentationNAV navbar
logo

RouterOS REST Schema (v7.14.3.28605231-interface+vxlan) Documentation

version v7.14.3.28605231-interface+vxlan
baseUri https://{host}:{port}/rest
protocols HTTPS, HTTP
mediaType application/json

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

/interface

/vxlan get

GET: /interface/vxlan (secured)


Query Parameters

as-string

PropertyValue
requiredfalse
typeany

as-string-value

PropertyValue
requiredfalse
typeany

number

PropertyValue
requiredfalse
typeany

value-name

PropertyValue
requiredfalse
typeany

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/vxlan get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/vxlan" \
+	--user username:password

RESPONSE BODY

Type
array

/vxlan put

PUT: /interface/vxlan (secured)


Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/vxlan put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/interface/vxlan" \
+	-d @request_body \
+	--user username:password

REQUEST BODY

Type
object

RESPONSE BODY

Type: any

/add post

POST: /interface/vxlan/add (secured)


Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/vxlan/add" \
+	-d @request_body \
+	--user username:password

REQUEST BODY

Type
object

RESPONSE BODY

Type: any

/comment post

POST: /interface/vxlan/comment (secured)


Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/comment post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/vxlan/comment" \
+	-d @request_body \
+	--user username:password

REQUEST BODY

Type
object

RESPONSE BODY

Type: any

/disable post

POST: /interface/vxlan/disable (secured)


Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/disable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/vxlan/disable" \
+	-d @request_body \
+	--user username:password

REQUEST BODY

Type
object

RESPONSE BODY

Type: any

/edit post

POST: /interface/vxlan/edit (secured)


Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/vxlan/edit" \
+	-d @request_body \
+	--user username:password

REQUEST BODY

Type
object

RESPONSE BODY

Type: any

/enable post

POST: /interface/vxlan/enable (secured)


Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/enable post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/vxlan/enable" \
+	-d @request_body \
+	--user username:password

REQUEST BODY

Type
object

RESPONSE BODY

Type: any

/export post

POST: /interface/vxlan/export (secured)


Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/vxlan/export" \
+	-d @request_body \
+	--user username:password

REQUEST BODY

Type
object

RESPONSE BODY

Type: any

/fdb get

GET: /interface/vxlan/fdb (secured)


Query Parameters

as-string

PropertyValue
requiredfalse
typeany

as-string-value

PropertyValue
requiredfalse
typeany

number

PropertyValue
requiredfalse
typeany

value-name

PropertyValue
requiredfalse
typeany

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/fdb get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/vxlan/fdb" \
+	--user username:password

RESPONSE BODY

Type
array

/find post

POST: /interface/vxlan/fdb/find (secured)


Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/vxlan/fdb/find" \
+	-d @request_body \
+	--user username:password

REQUEST BODY

Type
object

RESPONSE BODY

Type: any

/get post

POST: /interface/vxlan/fdb/get (secured)


Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/vxlan/fdb/get" \
+	-d @request_body \
+	--user username:password

REQUEST BODY

Type
object

RESPONSE BODY

Type: any

/{id} get

GET: /interface/vxlan/fdb/{id} (secured)


URI Parameters

id

PropertyValue
requiredtrue
typestring

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/vxlan/fdb/{id}" \
+	--user username:password

RESPONSE BODY

Type: any

/print post

POST: /interface/vxlan/fdb/print (secured)


Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/vxlan/fdb/print" \
+	-d @request_body \
+	--user username:password

REQUEST BODY

Type
object

RESPONSE BODY

Type: any

/find post

POST: /interface/vxlan/find (secured)


Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/vxlan/find" \
+	-d @request_body \
+	--user username:password

REQUEST BODY

Type
object

RESPONSE BODY

Type: any

/get post

POST: /interface/vxlan/get (secured)


Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/vxlan/get" \
+	-d @request_body \
+	--user username:password

REQUEST BODY

Type
object

RESPONSE BODY

Type: any

/{id} get

GET: /interface/vxlan/{id} (secured)


URI Parameters

id

PropertyValue
requiredtrue
typestring

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/vxlan/{id}" \
+	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /interface/vxlan/{id} (secured)


URI Parameters

id

PropertyValue
requiredtrue
typestring

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/interface/vxlan/{id}" \
+	--user username:password

REQUEST BODY

Type
object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /interface/vxlan/{id} (secured)


URI Parameters

id

PropertyValue
requiredtrue
typestring

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/interface/vxlan/{id}" \
+	-d @request_body \
+	--user username:password

REQUEST BODY

Type
object

RESPONSE BODY

Type: any

/print post

POST: /interface/vxlan/print (secured)


Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/vxlan/print" \
+	-d @request_body \
+	--user username:password

REQUEST BODY

Type
object

RESPONSE BODY

Type: any

/remove post

POST: /interface/vxlan/remove (secured)


Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/vxlan/remove" \
+	-d @request_body \
+	--user username:password

REQUEST BODY

Type
object

RESPONSE BODY

Type: any

/reset post

POST: /interface/vxlan/reset (secured)


Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/vxlan/reset" \
+	-d @request_body \
+	--user username:password

REQUEST BODY

Type
object

RESPONSE BODY

Type: any

/set post

POST: /interface/vxlan/set (secured)


Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/vxlan/set" \
+	-d @request_body \
+	--user username:password

REQUEST BODY

Type
object

RESPONSE BODY

Type: any

/unset post

POST: /interface/vxlan/unset (secured)


Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/unset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/vxlan/unset" \
+	-d @request_body \
+	--user username:password

REQUEST BODY

Type
object

RESPONSE BODY

Type: any

/vteps get

GET: /interface/vxlan/vteps (secured)


Query Parameters

as-string

PropertyValue
requiredfalse
typeany

as-string-value

PropertyValue
requiredfalse
typeany

number

PropertyValue
requiredfalse
typeany

value-name

PropertyValue
requiredfalse
typeany

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/vteps get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/vxlan/vteps" \
+	--user username:password

RESPONSE BODY

Type
array

/vteps put

PUT: /interface/vxlan/vteps (secured)


Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/vteps put

CURL EXAMPLE

curl -X PUT "https://{host}:{port}/rest/interface/vxlan/vteps" \
+	-d @request_body \
+	--user username:password

REQUEST BODY

Type
object

RESPONSE BODY

Type: any

/add post

POST: /interface/vxlan/vteps/add (secured)


Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/add post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/vxlan/vteps/add" \
+	-d @request_body \
+	--user username:password

REQUEST BODY

Type
object

RESPONSE BODY

Type: any

/edit post

POST: /interface/vxlan/vteps/edit (secured)


Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/edit post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/vxlan/vteps/edit" \
+	-d @request_body \
+	--user username:password

REQUEST BODY

Type
object

RESPONSE BODY

Type: any

/export post

POST: /interface/vxlan/vteps/export (secured)


Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/export post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/vxlan/vteps/export" \
+	-d @request_body \
+	--user username:password

REQUEST BODY

Type
object

RESPONSE BODY

Type: any

/find post

POST: /interface/vxlan/vteps/find (secured)


Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/find post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/vxlan/vteps/find" \
+	-d @request_body \
+	--user username:password

REQUEST BODY

Type
object

RESPONSE BODY

Type: any

/get post

POST: /interface/vxlan/vteps/get (secured)


Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/get post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/vxlan/vteps/get" \
+	-d @request_body \
+	--user username:password

REQUEST BODY

Type
object

RESPONSE BODY

Type: any

/{id} get

GET: /interface/vxlan/vteps/{id} (secured)


URI Parameters

id

PropertyValue
requiredtrue
typestring

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}:{port}/rest/interface/vxlan/vteps/{id}" \
+	--user username:password

RESPONSE BODY

Type: any

/{id} delete

DELETE: /interface/vxlan/vteps/{id} (secured)


URI Parameters

id

PropertyValue
requiredtrue
typestring

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} delete

CURL EXAMPLE

curl -X DELETE "https://{host}:{port}/rest/interface/vxlan/vteps/{id}" \
+	--user username:password

REQUEST BODY

Type
object

RESPONSE BODY

Type: any

/{id} patch

PATCH: /interface/vxlan/vteps/{id} (secured)


URI Parameters

id

PropertyValue
requiredtrue
typestring

Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/{id} patch

CURL EXAMPLE

curl -X PATCH "https://{host}:{port}/rest/interface/vxlan/vteps/{id}" \
+	-d @request_body \
+	--user username:password

REQUEST BODY

Type
object

RESPONSE BODY

Type: any

/print post

POST: /interface/vxlan/vteps/print (secured)


Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/print post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/vxlan/vteps/print" \
+	-d @request_body \
+	--user username:password

REQUEST BODY

Type
object

RESPONSE BODY

Type: any

/remove post

POST: /interface/vxlan/vteps/remove (secured)


Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/remove post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/vxlan/vteps/remove" \
+	-d @request_body \
+	--user username:password

REQUEST BODY

Type
object

RESPONSE BODY

Type: any

/reset post

POST: /interface/vxlan/vteps/reset (secured)


Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/reset post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/vxlan/vteps/reset" \
+	-d @request_body \
+	--user username:password

REQUEST BODY

Type
object

RESPONSE BODY

Type: any

/set post

POST: /interface/vxlan/vteps/set (secured)


Possible Responses

200

Success

400

Bad command or error

401

Unauthorized

/set post

CURL EXAMPLE

curl -X POST "https://{host}:{port}/rest/interface/vxlan/vteps/set" \
+	-d @request_body \
+	--user username:password

REQUEST BODY

Type
object

RESPONSE BODY

Type: any

\ No newline at end of file diff --git a/docs/7.14.3/interface/vxlan/ros-rest-interface+vxlan.raml b/docs/7.14.3/interface/vxlan/ros-rest-interface+vxlan.raml new file mode 100644 index 0000000..a6a80d7 --- /dev/null +++ b/docs/7.14.3/interface/vxlan/ros-rest-interface+vxlan.raml @@ -0,0 +1,1678 @@ +#%RAML 1.0 +title: RouterOS REST Schema (v7.14.3.28605231-interface+vxlan) +version: v7.14.3.28605231-interface+vxlan +protocols: + - HTTPS + - HTTP +mediaType: + - application/json +securitySchemes: + basic: + description: | + Mikrotik REST API only supports Basic Authentication, secured by HTTPS + type: Basic Authentication +securedBy: + - basic +baseUri: https://{host}:{port}/rest +baseUriParameters: + host: + description: RouterOS device IP or host name + default: 192.168.88.1 + port: + description: RouterOS https port to use + default: '443' +documentation: + - title: RouterOS RAML Schema for REST API + content: | + Schema is generated using `/console/inspect` from a RouterOS device, and + interpreted into a schema based on the rules in + [Mikrotik REST documentation](https://help.mikrotik.com) +/interface: + /vxlan: + get: + queryParameters: + as-string: + type: any + required: false + as-string-value: + type: any + required: false + number: + type: any + required: false + value-name: + type: any + required: false + responses: + '200': + description: Success + body: + application/json: + type: array + '400': + description: Bad command or error + body: + application/json: + type: object + '401': + description: Unauthorized + body: + application/json: + type: object + /add: + post: + body: + application/json: + type: object + properties: + allow-fast-path: + type: any + required: false + arp: + type: any + required: false + arp-timeout: + type: any + required: false + comment: + type: any + required: false + copy-from: + type: any + required: false + disabled: + type: any + required: false + dont-fragment: + type: any + required: false + group: + type: any + required: false + interface: + type: any + required: false + local-address: + type: any + required: false + loop-protect: + type: any + required: false + loop-protect-disable-time: + type: any + required: false + loop-protect-send-interval: + type: any + required: false + mac-address: + type: any + required: false + max-fdb-size: + type: any + required: false + mtu: + type: any + required: false + name: + type: any + required: false + port: + type: any + required: false + vni: + type: any + required: false + vrf: + type: any + required: false + vteps-ip-version: + type: any + required: false + .proplist: + type: any + required: false + .query: + type: array + required: false + responses: + '200': + description: Success + body: + application/json: + type: any + '400': + description: Bad command or error + body: + application/json: + type: object + '401': + description: Unauthorized + body: + application/json: + type: object + put: + body: + application/json: + type: object + properties: + allow-fast-path: + type: any + required: false + arp: + type: any + required: false + arp-timeout: + type: any + required: false + comment: + type: any + required: false + copy-from: + type: any + required: false + disabled: + type: any + required: false + dont-fragment: + type: any + required: false + group: + type: any + required: false + interface: + type: any + required: false + local-address: + type: any + required: false + loop-protect: + type: any + required: false + loop-protect-disable-time: + type: any + required: false + loop-protect-send-interval: + type: any + required: false + mac-address: + type: any + required: false + max-fdb-size: + type: any + required: false + mtu: + type: any + required: false + name: + type: any + required: false + port: + type: any + required: false + vni: + type: any + required: false + vrf: + type: any + required: false + vteps-ip-version: + type: any + required: false + responses: + '200': + description: Success + body: + application/json: + type: any + '400': + description: Bad command or error + body: + application/json: + type: object + '401': + description: Unauthorized + body: + application/json: + type: object + /comment: + post: + body: + application/json: + type: object + properties: + comment: + type: any + required: false + numbers: + type: any + required: false + .proplist: + type: any + required: false + .query: + type: array + required: false + responses: + '200': + description: Success + body: + application/json: + type: any + '400': + description: Bad command or error + body: + application/json: + type: object + '401': + description: Unauthorized + body: + application/json: + type: object + /disable: + post: + body: + application/json: + type: object + properties: + numbers: + type: any + required: false + .proplist: + type: any + required: false + .query: + type: array + required: false + responses: + '200': + description: Success + body: + application/json: + type: any + '400': + description: Bad command or error + body: + application/json: + type: object + '401': + description: Unauthorized + body: + application/json: + type: object + /edit: + post: + body: + application/json: + type: object + properties: + number: + type: any + required: false + value-name: + type: any + required: false + .proplist: + type: any + required: false + .query: + type: array + required: false + responses: + '200': + description: Success + body: + application/json: + type: any + '400': + description: Bad command or error + body: + application/json: + type: object + '401': + description: Unauthorized + body: + application/json: + type: object + /enable: + post: + body: + application/json: + type: object + properties: + numbers: + type: any + required: false + .proplist: + type: any + required: false + .query: + type: array + required: false + responses: + '200': + description: Success + body: + application/json: + type: any + '400': + description: Bad command or error + body: + application/json: + type: object + '401': + description: Unauthorized + body: + application/json: + type: object + /export: + post: + body: + application/json: + type: object + properties: + compact: + type: any + required: false + file: + type: any + required: false + hide-sensitive: + type: any + required: false + show-sensitive: + type: any + required: false + terse: + type: any + required: false + verbose: + type: any + required: false + where: + type: any + required: false + .proplist: + type: any + required: false + .query: + type: array + required: false + responses: + '200': + description: Success + body: + application/json: + type: any + '400': + description: Bad command or error + body: + application/json: + type: object + '401': + description: Unauthorized + body: + application/json: + type: object + /fdb: + get: + queryParameters: + as-string: + type: any + required: false + as-string-value: + type: any + required: false + number: + type: any + required: false + value-name: + type: any + required: false + responses: + '200': + description: Success + body: + application/json: + type: array + '400': + description: Bad command or error + body: + application/json: + type: object + '401': + description: Unauthorized + body: + application/json: + type: object + /find: + post: + body: + application/json: + type: object + properties: + where: + type: any + required: false + .proplist: + type: any + required: false + .query: + type: array + required: false + responses: + '200': + description: Success + body: + application/json: + type: any + '400': + description: Bad command or error + body: + application/json: + type: object + '401': + description: Unauthorized + body: + application/json: + type: object + /get: + post: + body: + application/json: + type: object + properties: + as-string: + type: any + required: false + as-string-value: + type: any + required: false + number: + type: any + required: false + value-name: + type: any + required: false + .proplist: + type: any + required: false + .query: + type: array + required: false + responses: + '200': + description: Success + body: + application/json: + type: any + '400': + description: Bad command or error + body: + application/json: + type: object + '401': + description: Unauthorized + body: + application/json: + type: object + /{id}: + get: + uriParameters: + id: + type: string + responses: + '200': + description: Success + body: + application/json: + type: any + '400': + description: Bad command or error + body: + application/json: + type: object + '401': + description: Unauthorized + body: + application/json: + type: object + /print: + post: + body: + application/json: + type: object + properties: + append: + type: any + required: false + as-value: + type: any + required: false + count-only: + type: any + required: false + detail: + type: any + required: false + file: + type: any + required: false + follow: + type: any + required: false + follow-only: + type: any + required: false + follow-strict: + type: any + required: false + from: + type: any + required: false + interval: + type: any + required: false + proplist: + type: any + required: false + show-ids: + type: any + required: false + terse: + type: any + required: false + value-list: + type: any + required: false + where: + type: any + required: false + without-paging: + type: any + required: false + .proplist: + type: any + required: false + .query: + type: array + required: false + responses: + '200': + description: Success + body: + application/json: + type: any + '400': + description: Bad command or error + body: + application/json: + type: object + '401': + description: Unauthorized + body: + application/json: + type: object + /find: + post: + body: + application/json: + type: object + properties: + where: + type: any + required: false + .proplist: + type: any + required: false + .query: + type: array + required: false + responses: + '200': + description: Success + body: + application/json: + type: any + '400': + description: Bad command or error + body: + application/json: + type: object + '401': + description: Unauthorized + body: + application/json: + type: object + /get: + post: + body: + application/json: + type: object + properties: + as-string: + type: any + required: false + as-string-value: + type: any + required: false + number: + type: any + required: false + value-name: + type: any + required: false + .proplist: + type: any + required: false + .query: + type: array + required: false + responses: + '200': + description: Success + body: + application/json: + type: any + '400': + description: Bad command or error + body: + application/json: + type: object + '401': + description: Unauthorized + body: + application/json: + type: object + /{id}: + get: + uriParameters: + id: + type: string + responses: + '200': + description: Success + body: + application/json: + type: any + '400': + description: Bad command or error + body: + application/json: + type: object + '401': + description: Unauthorized + body: + application/json: + type: object + delete: + body: + application/json: + type: object + properties: + numbers: + type: any + required: false + responses: + '200': + description: Success + body: + application/json: + type: any + '400': + description: Bad command or error + body: + application/json: + type: object + '401': + description: Unauthorized + body: + application/json: + type: object + uriParameters: + id: + type: string + patch: + body: + application/json: + type: object + properties: + allow-fast-path: + type: any + required: false + arp: + type: any + required: false + arp-timeout: + type: any + required: false + comment: + type: any + required: false + disabled: + type: any + required: false + dont-fragment: + type: any + required: false + group: + type: any + required: false + interface: + type: any + required: false + local-address: + type: any + required: false + loop-protect: + type: any + required: false + loop-protect-disable-time: + type: any + required: false + loop-protect-send-interval: + type: any + required: false + mac-address: + type: any + required: false + max-fdb-size: + type: any + required: false + mtu: + type: any + required: false + name: + type: any + required: false + numbers: + type: any + required: false + port: + type: any + required: false + vni: + type: any + required: false + vrf: + type: any + required: false + vteps-ip-version: + type: any + required: false + responses: + '200': + description: Success + body: + application/json: + type: any + '400': + description: Bad command or error + body: + application/json: + type: object + '401': + description: Unauthorized + body: + application/json: + type: object + uriParameters: + id: + type: string + /print: + post: + body: + application/json: + type: object + properties: + append: + type: any + required: false + as-value: + type: any + required: false + brief: + type: any + required: false + count-only: + type: any + required: false + detail: + type: any + required: false + file: + type: any + required: false + follow: + type: any + required: false + follow-only: + type: any + required: false + follow-strict: + type: any + required: false + from: + type: any + required: false + interval: + type: any + required: false + proplist: + type: any + required: false + show-ids: + type: any + required: false + terse: + type: any + required: false + value-list: + type: any + required: false + where: + type: any + required: false + without-paging: + type: any + required: false + .proplist: + type: any + required: false + .query: + type: array + required: false + responses: + '200': + description: Success + body: + application/json: + type: any + '400': + description: Bad command or error + body: + application/json: + type: object + '401': + description: Unauthorized + body: + application/json: + type: object + /remove: + post: + body: + application/json: + type: object + properties: + numbers: + type: any + required: false + .proplist: + type: any + required: false + .query: + type: array + required: false + responses: + '200': + description: Success + body: + application/json: + type: any + '400': + description: Bad command or error + body: + application/json: + type: object + '401': + description: Unauthorized + body: + application/json: + type: object + /reset: + post: + body: + application/json: + type: object + properties: + allow-fast-path: + type: any + required: false + arp: + type: any + required: false + arp-timeout: + type: any + required: false + comment: + type: any + required: false + disabled: + type: any + required: false + dont-fragment: + type: any + required: false + group: + type: any + required: false + interface: + type: any + required: false + local-address: + type: any + required: false + loop-protect: + type: any + required: false + loop-protect-disable-time: + type: any + required: false + loop-protect-send-interval: + type: any + required: false + mac-address: + type: any + required: false + max-fdb-size: + type: any + required: false + mtu: + type: any + required: false + name: + type: any + required: false + numbers: + type: any + required: false + port: + type: any + required: false + vni: + type: any + required: false + vrf: + type: any + required: false + vteps-ip-version: + type: any + required: false + .proplist: + type: any + required: false + .query: + type: array + required: false + responses: + '200': + description: Success + body: + application/json: + type: any + '400': + description: Bad command or error + body: + application/json: + type: object + '401': + description: Unauthorized + body: + application/json: + type: object + /set: + post: + body: + application/json: + type: object + properties: + allow-fast-path: + type: any + required: false + arp: + type: any + required: false + arp-timeout: + type: any + required: false + comment: + type: any + required: false + disabled: + type: any + required: false + dont-fragment: + type: any + required: false + group: + type: any + required: false + interface: + type: any + required: false + local-address: + type: any + required: false + loop-protect: + type: any + required: false + loop-protect-disable-time: + type: any + required: false + loop-protect-send-interval: + type: any + required: false + mac-address: + type: any + required: false + max-fdb-size: + type: any + required: false + mtu: + type: any + required: false + name: + type: any + required: false + numbers: + type: any + required: false + port: + type: any + required: false + vni: + type: any + required: false + vrf: + type: any + required: false + vteps-ip-version: + type: any + required: false + .proplist: + type: any + required: false + .query: + type: array + required: false + responses: + '200': + description: Success + body: + application/json: + type: any + '400': + description: Bad command or error + body: + application/json: + type: object + '401': + description: Unauthorized + body: + application/json: + type: object + /unset: + post: + body: + application/json: + type: object + properties: + numbers: + type: any + required: false + value-name: + type: any + required: false + .proplist: + type: any + required: false + .query: + type: array + required: false + responses: + '200': + description: Success + body: + application/json: + type: any + '400': + description: Bad command or error + body: + application/json: + type: object + '401': + description: Unauthorized + body: + application/json: + type: object + /vteps: + get: + queryParameters: + as-string: + type: any + required: false + as-string-value: + type: any + required: false + number: + type: any + required: false + value-name: + type: any + required: false + responses: + '200': + description: Success + body: + application/json: + type: array + '400': + description: Bad command or error + body: + application/json: + type: object + '401': + description: Unauthorized + body: + application/json: + type: object + /add: + post: + body: + application/json: + type: object + properties: + copy-from: + type: any + required: false + interface: + type: any + required: false + port: + type: any + required: false + remote-ip: + type: any + required: false + .proplist: + type: any + required: false + .query: + type: array + required: false + responses: + '200': + description: Success + body: + application/json: + type: any + '400': + description: Bad command or error + body: + application/json: + type: object + '401': + description: Unauthorized + body: + application/json: + type: object + put: + body: + application/json: + type: object + properties: + copy-from: + type: any + required: false + interface: + type: any + required: false + port: + type: any + required: false + remote-ip: + type: any + required: false + responses: + '200': + description: Success + body: + application/json: + type: any + '400': + description: Bad command or error + body: + application/json: + type: object + '401': + description: Unauthorized + body: + application/json: + type: object + /edit: + post: + body: + application/json: + type: object + properties: + number: + type: any + required: false + value-name: + type: any + required: false + .proplist: + type: any + required: false + .query: + type: array + required: false + responses: + '200': + description: Success + body: + application/json: + type: any + '400': + description: Bad command or error + body: + application/json: + type: object + '401': + description: Unauthorized + body: + application/json: + type: object + /export: + post: + body: + application/json: + type: object + properties: + compact: + type: any + required: false + file: + type: any + required: false + hide-sensitive: + type: any + required: false + show-sensitive: + type: any + required: false + terse: + type: any + required: false + verbose: + type: any + required: false + where: + type: any + required: false + .proplist: + type: any + required: false + .query: + type: array + required: false + responses: + '200': + description: Success + body: + application/json: + type: any + '400': + description: Bad command or error + body: + application/json: + type: object + '401': + description: Unauthorized + body: + application/json: + type: object + /find: + post: + body: + application/json: + type: object + properties: + where: + type: any + required: false + .proplist: + type: any + required: false + .query: + type: array + required: false + responses: + '200': + description: Success + body: + application/json: + type: any + '400': + description: Bad command or error + body: + application/json: + type: object + '401': + description: Unauthorized + body: + application/json: + type: object + /get: + post: + body: + application/json: + type: object + properties: + as-string: + type: any + required: false + as-string-value: + type: any + required: false + number: + type: any + required: false + value-name: + type: any + required: false + .proplist: + type: any + required: false + .query: + type: array + required: false + responses: + '200': + description: Success + body: + application/json: + type: any + '400': + description: Bad command or error + body: + application/json: + type: object + '401': + description: Unauthorized + body: + application/json: + type: object + /{id}: + get: + uriParameters: + id: + type: string + responses: + '200': + description: Success + body: + application/json: + type: any + '400': + description: Bad command or error + body: + application/json: + type: object + '401': + description: Unauthorized + body: + application/json: + type: object + delete: + body: + application/json: + type: object + properties: + numbers: + type: any + required: false + responses: + '200': + description: Success + body: + application/json: + type: any + '400': + description: Bad command or error + body: + application/json: + type: object + '401': + description: Unauthorized + body: + application/json: + type: object + uriParameters: + id: + type: string + patch: + body: + application/json: + type: object + properties: + interface: + type: any + required: false + numbers: + type: any + required: false + port: + type: any + required: false + remote-ip: + type: any + required: false + responses: + '200': + description: Success + body: + application/json: + type: any + '400': + description: Bad command or error + body: + application/json: + type: object + '401': + description: Unauthorized + body: + application/json: + type: object + uriParameters: + id: + type: string + /print: + post: + body: + application/json: + type: object + properties: + append: + type: any + required: false + as-value: + type: any + required: false + brief: + type: any + required: false + count-only: + type: any + required: false + detail: + type: any + required: false + file: + type: any + required: false + follow: + type: any + required: false + follow-only: + type: any + required: false + follow-strict: + type: any + required: false + from: + type: any + required: false + interval: + type: any + required: false + proplist: + type: any + required: false + show-ids: + type: any + required: false + terse: + type: any + required: false + value-list: + type: any + required: false + where: + type: any + required: false + without-paging: + type: any + required: false + .proplist: + type: any + required: false + .query: + type: array + required: false + responses: + '200': + description: Success + body: + application/json: + type: any + '400': + description: Bad command or error + body: + application/json: + type: object + '401': + description: Unauthorized + body: + application/json: + type: object + /remove: + post: + body: + application/json: + type: object + properties: + numbers: + type: any + required: false + .proplist: + type: any + required: false + .query: + type: array + required: false + responses: + '200': + description: Success + body: + application/json: + type: any + '400': + description: Bad command or error + body: + application/json: + type: object + '401': + description: Unauthorized + body: + application/json: + type: object + /reset: + post: + body: + application/json: + type: object + properties: + interface: + type: any + required: false + numbers: + type: any + required: false + port: + type: any + required: false + remote-ip: + type: any + required: false + .proplist: + type: any + required: false + .query: + type: array + required: false + responses: + '200': + description: Success + body: + application/json: + type: any + '400': + description: Bad command or error + body: + application/json: + type: object + '401': + description: Unauthorized + body: + application/json: + type: object + /set: + post: + body: + application/json: + type: object + properties: + interface: + type: any + required: false + numbers: + type: any + required: false + port: + type: any + required: false + remote-ip: + type: any + required: false + .proplist: + type: any + required: false + .query: + type: array + required: false + responses: + '200': + description: Success + body: + application/json: + type: any + '400': + description: Bad command or error + body: + application/json: + type: object + '401': + description: Unauthorized + body: + application/json: + type: object