F5 BIG-IP iControl REST API — Nodes

naftiko: 1.0.0-alpha2
info:
  label: F5 BIG-IP iControl REST API — Nodes
  description: 'F5 BIG-IP iControl REST API — Nodes. 6 operations. Lead operation: List All Nodes. Self-contained Naftiko
    capability covering one F5 Networks business surface.'
  tags:
  - F5 Networks
  - Nodes
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    F5_NETWORKS_API_KEY: F5_NETWORKS_API_KEY
capability:
  consumes:
  - type: http
    namespace: bigip-icontrol-rest-nodes
    baseUri: https://{bigip_host}/mgmt/tm
    description: F5 BIG-IP iControl REST API — Nodes business capability. Self-contained, no shared references.
    resources:
    - name: ltm-node
      path: /ltm/node
      operations:
      - name: listnodes
        method: GET
        description: List All Nodes
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createnode
        method: POST
        description: Create a Node
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: ltm-node-nodeName
      path: /ltm/node/{nodeName}
      operations:
      - name: getnode
        method: GET
        description: Get a Node
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updatenode
        method: PUT
        description: Update a Node
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: patchnode
        method: PATCH
        description: Patch a Node
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deletenode
        method: DELETE
        description: Delete a Node
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: apikey
      key: X-F5-Auth-Token
      value: '{{env.F5_NETWORKS_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: bigip-icontrol-rest-nodes-rest
    port: 8080
    description: REST adapter for F5 BIG-IP iControl REST API — Nodes. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/ltm/node
      name: ltm-node
      description: REST surface for ltm-node.
      operations:
      - method: GET
        name: listnodes
        description: List All Nodes
        call: bigip-icontrol-rest-nodes.listnodes
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createnode
        description: Create a Node
        call: bigip-icontrol-rest-nodes.createnode
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/ltm/node/{nodename}
      name: ltm-node-nodename
      description: REST surface for ltm-node-nodeName.
      operations:
      - method: GET
        name: getnode
        description: Get a Node
        call: bigip-icontrol-rest-nodes.getnode
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updatenode
        description: Update a Node
        call: bigip-icontrol-rest-nodes.updatenode
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: patchnode
        description: Patch a Node
        call: bigip-icontrol-rest-nodes.patchnode
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletenode
        description: Delete a Node
        call: bigip-icontrol-rest-nodes.deletenode
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: bigip-icontrol-rest-nodes-mcp
    port: 9090
    transport: http
    description: MCP adapter for F5 BIG-IP iControl REST API — Nodes. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: list-all-nodes
      description: List All Nodes
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: bigip-icontrol-rest-nodes.listnodes
      outputParameters:
      - type: object
        mapping: $.
    - name: create-node
      description: Create a Node
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: bigip-icontrol-rest-nodes.createnode
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-node
      description: Get a Node
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: bigip-icontrol-rest-nodes.getnode
      outputParameters:
      - type: object
        mapping: $.
    - name: update-node
      description: Update a Node
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: bigip-icontrol-rest-nodes.updatenode
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: patch-node
      description: Patch a Node
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: bigip-icontrol-rest-nodes.patchnode
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-node
      description: Delete a Node
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: bigip-icontrol-rest-nodes.deletenode
      outputParameters:
      - type: object
        mapping: $.