F5 BIG-IP iControl REST API — Pools

naftiko: 1.0.0-alpha2
info:
  label: F5 BIG-IP iControl REST API — Pools
  description: 'F5 BIG-IP iControl REST API — Pools. 6 operations. Lead operation: List All Pools. Self-contained Naftiko
    capability covering one F5 Networks business surface.'
  tags:
  - F5 Networks
  - Pools
  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-pools
    baseUri: https://{bigip_host}/mgmt/tm
    description: F5 BIG-IP iControl REST API — Pools business capability. Self-contained, no shared references.
    resources:
    - name: ltm-pool
      path: /ltm/pool
      operations:
      - name: listpools
        method: GET
        description: List All Pools
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createpool
        method: POST
        description: Create a Pool
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: ltm-pool-poolName
      path: /ltm/pool/{poolName}
      operations:
      - name: getpool
        method: GET
        description: Get a Pool
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updatepool
        method: PUT
        description: Update a Pool
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: patchpool
        method: PATCH
        description: Patch a Pool
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deletepool
        method: DELETE
        description: Delete a Pool
        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-pools-rest
    port: 8080
    description: REST adapter for F5 BIG-IP iControl REST API — Pools. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/ltm/pool
      name: ltm-pool
      description: REST surface for ltm-pool.
      operations:
      - method: GET
        name: listpools
        description: List All Pools
        call: bigip-icontrol-rest-pools.listpools
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createpool
        description: Create a Pool
        call: bigip-icontrol-rest-pools.createpool
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/ltm/pool/{poolname}
      name: ltm-pool-poolname
      description: REST surface for ltm-pool-poolName.
      operations:
      - method: GET
        name: getpool
        description: Get a Pool
        call: bigip-icontrol-rest-pools.getpool
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updatepool
        description: Update a Pool
        call: bigip-icontrol-rest-pools.updatepool
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: patchpool
        description: Patch a Pool
        call: bigip-icontrol-rest-pools.patchpool
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletepool
        description: Delete a Pool
        call: bigip-icontrol-rest-pools.deletepool
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: bigip-icontrol-rest-pools-mcp
    port: 9090
    transport: http
    description: MCP adapter for F5 BIG-IP iControl REST API — Pools. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: list-all-pools
      description: List All Pools
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: bigip-icontrol-rest-pools.listpools
      outputParameters:
      - type: object
        mapping: $.
    - name: create-pool
      description: Create a Pool
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: bigip-icontrol-rest-pools.createpool
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-pool
      description: Get a Pool
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: bigip-icontrol-rest-pools.getpool
      outputParameters:
      - type: object
        mapping: $.
    - name: update-pool
      description: Update a Pool
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: bigip-icontrol-rest-pools.updatepool
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: patch-pool
      description: Patch a Pool
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: bigip-icontrol-rest-pools.patchpool
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-pool
      description: Delete a Pool
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: bigip-icontrol-rest-pools.deletepool
      outputParameters:
      - type: object
        mapping: $.