Citrix ADC (NetScaler) NITRO API — Load Balancing

naftiko: 1.0.0-alpha2
info:
  label: Citrix ADC (NetScaler) NITRO API — Load Balancing
  description: 'Citrix ADC (NetScaler) NITRO API — Load Balancing. 8 operations. Lead operation: Citrix List load balancing
    virtual servers. Self-contained Naftiko capability covering one Citrix business surface.'
  tags:
  - Citrix
  - Load Balancing
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    CITRIX_API_KEY: CITRIX_API_KEY
capability:
  consumes:
  - type: http
    namespace: adc-nitro-load-balancing
    baseUri: https://{netscaler-ip}/nitro/v1
    description: Citrix ADC (NetScaler) NITRO API — Load Balancing business capability. Self-contained, no shared references.
    resources:
    - name: config-lbvserver
      path: /config/lbvserver
      operations:
      - name: listlbvservers
        method: GET
        description: Citrix List load balancing virtual servers
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createlbvserver
        method: POST
        description: Citrix Create a load balancing virtual server
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: config-lbvserver-name
      path: /config/lbvserver/{name}
      operations:
      - name: getlbvserver
        method: GET
        description: Citrix Get a load balancing virtual server
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: name
          in: path
          type: string
          description: Virtual server name
          required: true
      - name: updatelbvserver
        method: PUT
        description: Citrix Update a load balancing virtual server
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: name
          in: path
          type: string
          description: Virtual server name
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deletelbvserver
        method: DELETE
        description: Citrix Delete a load balancing virtual server
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: name
          in: path
          type: string
          description: Virtual server name
          required: true
    - name: config-service
      path: /config/service
      operations:
      - name: listservices
        method: GET
        description: Citrix List services
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: config-servicegroup
      path: /config/servicegroup
      operations:
      - name: listservicegroups
        method: GET
        description: Citrix List service groups
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: stat-lbvserver
      path: /stat/lbvserver
      operations:
      - name: getlbvserverstats
        method: GET
        description: Citrix Get load balancing statistics
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: apikey
      key: NITRO_AUTH_TOKEN
      value: '{{env.CITRIX_API_KEY}}'
      placement: cookie
  exposes:
  - type: rest
    namespace: adc-nitro-load-balancing-rest
    port: 8080
    description: REST adapter for Citrix ADC (NetScaler) NITRO API — Load Balancing. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/config/lbvserver
      name: config-lbvserver
      description: REST surface for config-lbvserver.
      operations:
      - method: GET
        name: listlbvservers
        description: Citrix List load balancing virtual servers
        call: adc-nitro-load-balancing.listlbvservers
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createlbvserver
        description: Citrix Create a load balancing virtual server
        call: adc-nitro-load-balancing.createlbvserver
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/config/lbvserver/{name}
      name: config-lbvserver-name
      description: REST surface for config-lbvserver-name.
      operations:
      - method: GET
        name: getlbvserver
        description: Citrix Get a load balancing virtual server
        call: adc-nitro-load-balancing.getlbvserver
        with:
          name: rest.name
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updatelbvserver
        description: Citrix Update a load balancing virtual server
        call: adc-nitro-load-balancing.updatelbvserver
        with:
          name: rest.name
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletelbvserver
        description: Citrix Delete a load balancing virtual server
        call: adc-nitro-load-balancing.deletelbvserver
        with:
          name: rest.name
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/config/service
      name: config-service
      description: REST surface for config-service.
      operations:
      - method: GET
        name: listservices
        description: Citrix List services
        call: adc-nitro-load-balancing.listservices
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/config/servicegroup
      name: config-servicegroup
      description: REST surface for config-servicegroup.
      operations:
      - method: GET
        name: listservicegroups
        description: Citrix List service groups
        call: adc-nitro-load-balancing.listservicegroups
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/stat/lbvserver
      name: stat-lbvserver
      description: REST surface for stat-lbvserver.
      operations:
      - method: GET
        name: getlbvserverstats
        description: Citrix Get load balancing statistics
        call: adc-nitro-load-balancing.getlbvserverstats
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: adc-nitro-load-balancing-mcp
    port: 9090
    transport: http
    description: MCP adapter for Citrix ADC (NetScaler) NITRO API — Load Balancing. One tool per consumed operation, routed
      inline through this capability's consumes block.
    tools:
    - name: citrix-list-load-balancing-virtual
      description: Citrix List load balancing virtual servers
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: adc-nitro-load-balancing.listlbvservers
      outputParameters:
      - type: object
        mapping: $.
    - name: citrix-create-load-balancing-virtual
      description: Citrix Create a load balancing virtual server
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: adc-nitro-load-balancing.createlbvserver
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: citrix-get-load-balancing-virtual
      description: Citrix Get a load balancing virtual server
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: adc-nitro-load-balancing.getlbvserver
      with:
        name: tools.name
      outputParameters:
      - type: object
        mapping: $.
    - name: citrix-update-load-balancing-virtual
      description: Citrix Update a load balancing virtual server
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: adc-nitro-load-balancing.updatelbvserver
      with:
        name: tools.name
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: citrix-delete-load-balancing-virtual
      description: Citrix Delete a load balancing virtual server
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: adc-nitro-load-balancing.deletelbvserver
      with:
        name: tools.name
      outputParameters:
      - type: object
        mapping: $.
    - name: citrix-list-services
      description: Citrix List services
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: adc-nitro-load-balancing.listservices
      outputParameters:
      - type: object
        mapping: $.
    - name: citrix-list-service-groups
      description: Citrix List service groups
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: adc-nitro-load-balancing.listservicegroups
      outputParameters:
      - type: object
        mapping: $.
    - name: citrix-get-load-balancing-statistics
      description: Citrix Get load balancing statistics
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: adc-nitro-load-balancing.getlbvserverstats
      outputParameters:
      - type: object
        mapping: $.