RouterOS

RouterOS VPN API

VPN tunnels and configurations

GitHub OpenAPI

Operations 2

GET /ip/ipsec/policy List IPsec Policies #
GET /ip/ipsec/peer List IPsec Peers #

Documentation

📖
Documentation
https://help.mikrotik.com/docs/spaces/ROS/pages/47579162/REST+API
📖
Documentation
https://help.mikrotik.com/docs/spaces/ROS/pages/47579160/API

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/routeros/refs/heads/main/openapi/routeros-vpn-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/routeros/refs/heads/main/json-schema/routeros-ip-address-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/routeros/refs/heads/main/json-schema/routeros-interface-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/routeros/refs/heads/main/json-schema/routeros-firewall-filter-schema.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/routeros/refs/heads/main/json-structure/routeros-ip-address-structure.json

Other Resources

🔗
SpectralRules
https://raw.githubusercontent.com/api-evangelist/routeros/refs/heads/main/rules/routeros-rules.yml
🔗
JSONLDContext
https://raw.githubusercontent.com/api-evangelist/routeros/refs/heads/main/json-ld/routeros-context.jsonld
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/routeros/refs/heads/main/examples/routeros-list-ip-addresses-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/routeros/refs/heads/main/examples/routeros-list-firewall-filters-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/routeros/refs/heads/main/examples/routeros-get-system-resource-example.json
🔗
Vocabulary
https://raw.githubusercontent.com/api-evangelist/routeros/refs/heads/main/vocabulary/routeros-vocabulary.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/routeros-vpn-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

routeros-vpn-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: RouterOS REST Bridge VPN API
  description: The RouterOS REST API is a JSON wrapper over the RouterOS console API, available from RouterOS v7.1beta4+. It provides CRUD operations on all RouterOS configuration menus via standard HTTP methods. Authentication uses HTTP Basic Auth with console credentials. All values in responses are encoded as strings.
  version: 7.1+
  contact:
    name: MikroTik Support
    url: https://mikrotik.com/support
  license:
    name: Proprietary
    url: https://mikrotik.com
servers:
- url: https://{routerIP}/rest
  description: RouterOS REST API (HTTPS recommended)
  variables:
    routerIP:
      default: 192.168.88.1
      description: IP address of the RouterOS device
security:
- basicAuth: []
tags:
- name: VPN
  description: VPN tunnels and configurations
paths:
  /ip/ipsec/policy:
    get:
      operationId: listIpsecPolicies
      summary: List IPsec Policies
      description: Retrieve all IPsec policy configurations.
      tags:
      - VPN
      responses:
        '200':
          description: List of IPsec policies
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/IpsecPolicy'
  /ip/ipsec/peer:
    get:
      operationId: listIpsecPeers
      summary: List IPsec Peers
      description: Retrieve all IPsec peer configurations.
      tags:
      - VPN
      responses:
        '200':
          description: List of IPsec peers
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/IpsecPeer'
components:
  schemas:
    IpsecPeer:
      type: object
      description: RouterOS IPsec peer configuration
      properties:
        .id:
          type: string
        address:
          type: string
          description: Peer IP address
        auth-method:
          type: string
        exchange-mode:
          type: string
        disabled:
          type: string
          enum:
          - 'true'
          - 'false'
        comment:
          type: string
    IpsecPolicy:
      type: object
      description: RouterOS IPsec policy
      properties:
        .id:
          type: string
        src-address:
          type: string
        dst-address:
          type: string
        action:
          type: string
        tunnel:
          type: string
          enum:
          - 'true'
          - 'false'
        disabled:
          type: string
          enum:
          - 'true'
          - 'false'
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: HTTP Basic Auth using RouterOS console credentials