Citrix NetScaler NITRO REST API — Statistics

naftiko: 1.0.0-alpha2
info:
  label: Citrix NetScaler NITRO REST API — Statistics
  description: 'Citrix NetScaler NITRO REST API — Statistics. 4 operations. Lead operation: Citrix Netscaler Get Statistics
    for All Content Switching Virtual Servers. Self-contained Naftiko capability covering one Citrix Netscaler business surface.'
  tags:
  - Citrix Netscaler
  - Statistics
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    CITRIX_NETSCALER_API_KEY: CITRIX_NETSCALER_API_KEY
capability:
  consumes:
  - type: http
    namespace: nitro-statistics
    baseUri: https://{nsip}/nitro/v1
    description: Citrix NetScaler NITRO REST API — Statistics business capability. Self-contained, no shared references.
    resources:
    - name: stat-csvserver
      path: /stat/csvserver
      operations:
      - name: listcsvserverstats
        method: GET
        description: Citrix Netscaler Get Statistics for All Content Switching Virtual Servers
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: stat-csvserver-name
      path: /stat/csvserver/{name}
      operations:
      - name: getcsvserverstats
        method: GET
        description: Citrix Netscaler Get Statistics for a Specific Content Switching Virtual Server
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: name
          in: path
          type: string
          description: Name of the content switching virtual server.
          required: true
    - name: stat-lbvserver
      path: /stat/lbvserver
      operations:
      - name: listlbvserverstats
        method: GET
        description: Citrix Netscaler Get Statistics for All Load Balancing Virtual Servers
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: sortby
          in: query
          type: string
          description: Sort statistics by a specific metric.
        - name: sortorder
          in: query
          type: string
          description: Sort order for the statistics results.
        - name: clearstats
          in: query
          type: string
          description: Clear statistics after retrieval. Use basic for counters or full for all stats.
    - name: stat-lbvserver-name
      path: /stat/lbvserver/{name}
      operations:
      - name: getlbvserverstats
        method: GET
        description: Citrix Netscaler Get Statistics for a Specific Load Balancing Virtual Server
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: name
          in: path
          type: string
          description: Name of the load balancing virtual server.
          required: true
        - name: statbindings
          in: query
          type: string
          description: Include statistics for bound services when set to yes.
    authentication:
      type: apikey
      key: NITRO_AUTH_TOKEN
      value: '{{env.CITRIX_NETSCALER_API_KEY}}'
      placement: cookie
  exposes:
  - type: rest
    namespace: nitro-statistics-rest
    port: 8080
    description: REST adapter for Citrix NetScaler NITRO REST API — Statistics. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/stat/csvserver
      name: stat-csvserver
      description: REST surface for stat-csvserver.
      operations:
      - method: GET
        name: listcsvserverstats
        description: Citrix Netscaler Get Statistics for All Content Switching Virtual Servers
        call: nitro-statistics.listcsvserverstats
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/stat/csvserver/{name}
      name: stat-csvserver-name
      description: REST surface for stat-csvserver-name.
      operations:
      - method: GET
        name: getcsvserverstats
        description: Citrix Netscaler Get Statistics for a Specific Content Switching Virtual Server
        call: nitro-statistics.getcsvserverstats
        with:
          name: rest.name
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/stat/lbvserver
      name: stat-lbvserver
      description: REST surface for stat-lbvserver.
      operations:
      - method: GET
        name: listlbvserverstats
        description: Citrix Netscaler Get Statistics for All Load Balancing Virtual Servers
        call: nitro-statistics.listlbvserverstats
        with:
          sortby: rest.sortby
          sortorder: rest.sortorder
          clearstats: rest.clearstats
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/stat/lbvserver/{name}
      name: stat-lbvserver-name
      description: REST surface for stat-lbvserver-name.
      operations:
      - method: GET
        name: getlbvserverstats
        description: Citrix Netscaler Get Statistics for a Specific Load Balancing Virtual Server
        call: nitro-statistics.getlbvserverstats
        with:
          name: rest.name
          statbindings: rest.statbindings
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: nitro-statistics-mcp
    port: 9090
    transport: http
    description: MCP adapter for Citrix NetScaler NITRO REST API — Statistics. One tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: citrix-netscaler-get-statistics-all
      description: Citrix Netscaler Get Statistics for All Content Switching Virtual Servers
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: nitro-statistics.listcsvserverstats
      outputParameters:
      - type: object
        mapping: $.
    - name: citrix-netscaler-get-statistics-specific
      description: Citrix Netscaler Get Statistics for a Specific Content Switching Virtual Server
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: nitro-statistics.getcsvserverstats
      with:
        name: tools.name
      outputParameters:
      - type: object
        mapping: $.
    - name: citrix-netscaler-get-statistics-all-2
      description: Citrix Netscaler Get Statistics for All Load Balancing Virtual Servers
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: nitro-statistics.listlbvserverstats
      with:
        sortby: tools.sortby
        sortorder: tools.sortorder
        clearstats: tools.clearstats
      outputParameters:
      - type: object
        mapping: $.
    - name: citrix-netscaler-get-statistics-specific-2
      description: Citrix Netscaler Get Statistics for a Specific Load Balancing Virtual Server
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: nitro-statistics.getlbvserverstats
      with:
        name: tools.name
        statbindings: tools.statbindings
      outputParameters:
      - type: object
        mapping: $.