RouterOS REST API — System

naftiko: 1.0.0-alpha2
info:
  label: RouterOS REST API — System
  description: 'RouterOS REST API — System. 6 operations. Lead operation: Get System Identity. Self-contained Naftiko capability
    covering one Routeros business surface.'
  tags:
  - Routeros
  - System
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    ROUTEROS_API_KEY: ROUTEROS_API_KEY
capability:
  consumes:
  - type: http
    namespace: rest-system
    baseUri: https://{routerIP}/rest
    description: RouterOS REST API — System business capability. Self-contained, no shared references.
    resources:
    - name: system-identity
      path: /system/identity
      operations:
      - name: getsystemidentity
        method: GET
        description: Get System Identity
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updatesystemidentity
        method: PATCH
        description: Update System Identity
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: system-resource
      path: /system/resource
      operations:
      - name: getsystemresource
        method: GET
        description: Get System Resources
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: system-script
      path: /system/script
      operations:
      - name: listsystemscripts
        method: GET
        description: List System Scripts
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: addsystemscript
        method: PUT
        description: Add System Script
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: system-script-id-run
      path: /system/script/{id}/run
      operations:
      - name: runsystemscript
        method: POST
        description: Run System Script
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: basic
      username: '{{env.ROUTEROS_USER}}'
      password: '{{env.ROUTEROS_PASS}}'
  exposes:
  - type: rest
    namespace: rest-system-rest
    port: 8080
    description: REST adapter for RouterOS REST API — System. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/system/identity
      name: system-identity
      description: REST surface for system-identity.
      operations:
      - method: GET
        name: getsystemidentity
        description: Get System Identity
        call: rest-system.getsystemidentity
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: updatesystemidentity
        description: Update System Identity
        call: rest-system.updatesystemidentity
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/system/resource
      name: system-resource
      description: REST surface for system-resource.
      operations:
      - method: GET
        name: getsystemresource
        description: Get System Resources
        call: rest-system.getsystemresource
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/system/script
      name: system-script
      description: REST surface for system-script.
      operations:
      - method: GET
        name: listsystemscripts
        description: List System Scripts
        call: rest-system.listsystemscripts
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: addsystemscript
        description: Add System Script
        call: rest-system.addsystemscript
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/system/script/{id}/run
      name: system-script-id-run
      description: REST surface for system-script-id-run.
      operations:
      - method: POST
        name: runsystemscript
        description: Run System Script
        call: rest-system.runsystemscript
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: rest-system-mcp
    port: 9090
    transport: http
    description: MCP adapter for RouterOS REST API — System. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: get-system-identity
      description: Get System Identity
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: rest-system.getsystemidentity
      outputParameters:
      - type: object
        mapping: $.
    - name: update-system-identity
      description: Update System Identity
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: rest-system.updatesystemidentity
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-system-resources
      description: Get System Resources
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: rest-system.getsystemresource
      outputParameters:
      - type: object
        mapping: $.
    - name: list-system-scripts
      description: List System Scripts
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: rest-system.listsystemscripts
      outputParameters:
      - type: object
        mapping: $.
    - name: add-system-script
      description: Add System Script
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: rest-system.addsystemscript
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: run-system-script
      description: Run System Script
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: rest-system.runsystemscript
      outputParameters:
      - type: object
        mapping: $.