RouterOS REST API — IP Address

naftiko: 1.0.0-alpha2
info:
  label: RouterOS REST API — IP Address
  description: 'RouterOS REST API — IP Address. 5 operations. Lead operation: List IP Addresses. Self-contained Naftiko capability
    covering one Routeros business surface.'
  tags:
  - Routeros
  - IP Address
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    ROUTEROS_API_KEY: ROUTEROS_API_KEY
capability:
  consumes:
  - type: http
    namespace: rest-ip-address
    baseUri: https://{routerIP}/rest
    description: RouterOS REST API — IP Address business capability. Self-contained, no shared references.
    resources:
    - name: ip-address
      path: /ip/address
      operations:
      - name: listipaddresses
        method: GET
        description: List IP Addresses
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: .proplist
          in: query
          type: string
          description: Comma-separated list of properties to return
        - name: interface
          in: query
          type: string
          description: Filter by interface name
        - name: dynamic
          in: query
          type: string
          description: Filter by dynamic flag
      - name: addipaddress
        method: PUT
        description: Add IP Address
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: ip-address-id
      path: /ip/address/{id}
      operations:
      - name: getipaddress
        method: GET
        description: Get IP Address
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updateipaddress
        method: PATCH
        description: Update IP Address
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deleteipaddress
        method: DELETE
        description: Delete IP Address
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: basic
      username: '{{env.ROUTEROS_USER}}'
      password: '{{env.ROUTEROS_PASS}}'
  exposes:
  - type: rest
    namespace: rest-ip-address-rest
    port: 8080
    description: REST adapter for RouterOS REST API — IP Address. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/ip/address
      name: ip-address
      description: REST surface for ip-address.
      operations:
      - method: GET
        name: listipaddresses
        description: List IP Addresses
        call: rest-ip-address.listipaddresses
        with:
          .proplist: rest..proplist
          interface: rest.interface
          dynamic: rest.dynamic
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: addipaddress
        description: Add IP Address
        call: rest-ip-address.addipaddress
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/ip/address/{id}
      name: ip-address-id
      description: REST surface for ip-address-id.
      operations:
      - method: GET
        name: getipaddress
        description: Get IP Address
        call: rest-ip-address.getipaddress
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: updateipaddress
        description: Update IP Address
        call: rest-ip-address.updateipaddress
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deleteipaddress
        description: Delete IP Address
        call: rest-ip-address.deleteipaddress
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: rest-ip-address-mcp
    port: 9090
    transport: http
    description: MCP adapter for RouterOS REST API — IP Address. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: list-ip-addresses
      description: List IP Addresses
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: rest-ip-address.listipaddresses
      with:
        .proplist: tools..proplist
        interface: tools.interface
        dynamic: tools.dynamic
      outputParameters:
      - type: object
        mapping: $.
    - name: add-ip-address
      description: Add IP Address
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: rest-ip-address.addipaddress
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-ip-address
      description: Get IP Address
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: rest-ip-address.getipaddress
      outputParameters:
      - type: object
        mapping: $.
    - name: update-ip-address
      description: Update IP Address
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: rest-ip-address.updateipaddress
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-ip-address
      description: Delete IP Address
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: rest-ip-address.deleteipaddress
      outputParameters:
      - type: object
        mapping: $.