Restraml

RouterOS API Schema Tools

**[tikoci.github.io/restraml](https://tikoci.github.io/restraml/)** — schema downloads, side-by-side version diffs, an interactive API explorer, a command lookup tool, and a browser-based `/app` YAML editor for the MikroTik RouterOS REST API. No install needed, runs in your browser.

For RouterOS 7.22+: JSON Schema files for `/app` container YAML are also published there, ready to plug into VSCode — [setup details below](#using-the-app-yaml-schema-in-vscode).

Auto-generated API schemas for the [MikroTik RouterOS](https://mikrotik.com/) REST API, built automatically by [GitHub Actions](https://github.com/tikoci/restraml/actions) — you can watch the sausage being made.

[](https://tikoci.github.io/restraml/)

Download Schemas

Pre-built schema files for the RouterOS REST API are available at

[!TIP] Missing a version? Need a feature? Spot a bug? [Open an issue](https://github.com/tikoci/restraml/issues/new/choose) — builds run automatically for new RouterOS releases via [GitHub Actions](https://github.com/tikoci/restraml/actions), and requests are welcome.

Each RouterOS version includes:

• RAML — RAML 1.0 schema, usable in Postman, MuleSoft, and other API tools
• OpenAPI 3 — OpenAPI 3.0 schema where openapi.json has been generated, viewable in the API Explorer with enriched descriptions from MikroTik documentation
• JSON — raw /console/inspect output from RouterOS, useful for data analysis and diffs
• MIB — link to the official MikroTik MIB for SNMP

There may be a _base_ and _+extra_ download for each version:

• base — just the routeros.npk system package
• +extra — all x86 packages: routeros, dude, container, rose-storage, gps, lora, calea, user-manager, ups, iot, wifiwave2, tr069-client

API Explor