NGINX Plus REST API — HTTP Limit Reqs

naftiko: 1.0.0-alpha2
info:
  label: NGINX Plus REST API — HTTP Limit Reqs
  description: 'NGINX Plus REST API — HTTP Limit Reqs. 3 operations. Lead operation: NGINX Return Status of All HTTP Limit_req
    Zones. Self-contained Naftiko capability covering one Nginx business surface.'
  tags:
  - Nginx
  - HTTP Limit Reqs
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    NGINX_API_KEY: NGINX_API_KEY
capability:
  consumes:
  - type: http
    namespace: plus-http-http-limit-reqs
    baseUri: ''
    description: NGINX Plus REST API — HTTP Limit Reqs business capability. Self-contained, no shared references.
    resources:
    - name: http-limit_reqs
      path: /http/limit_reqs/
      operations:
      - name: gethttplimitreqzones
        method: GET
        description: NGINX Return Status of All HTTP Limit_req Zones
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: fields
          in: query
          type: string
          description: Limits which fields of limit_req zones will be output. If the “<literal>fields</literal>” value is
            empty, then only zone names will be output.
    - name: http-limit_reqs-httpLimitReqZoneName
      path: /http/limit_reqs/{httpLimitReqZoneName}
      operations:
      - name: gethttplimitreqzone
        method: GET
        description: NGINX Return Status of an HTTP Limit_req Zone
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: fields
          in: query
          type: string
          description: Limits which fields of the [limit_req zone](https://nginx.org/en/docs/http/ngx_http_limit_req_module.html#limit_req_zone)
            will be output.
      - name: deletehttplimitreqzonestat
        method: DELETE
        description: NGINX Reset Statistics for an HTTP Limit_req Zone
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
  exposes:
  - type: rest
    namespace: plus-http-http-limit-reqs-rest
    port: 8080
    description: REST adapter for NGINX Plus REST API — HTTP Limit Reqs. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/http/limit-reqs
      name: http-limit-reqs
      description: REST surface for http-limit_reqs.
      operations:
      - method: GET
        name: gethttplimitreqzones
        description: NGINX Return Status of All HTTP Limit_req Zones
        call: plus-http-http-limit-reqs.gethttplimitreqzones
        with:
          fields: rest.fields
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/http/limit-reqs/{httplimitreqzonename}
      name: http-limit-reqs-httplimitreqzonename
      description: REST surface for http-limit_reqs-httpLimitReqZoneName.
      operations:
      - method: GET
        name: gethttplimitreqzone
        description: NGINX Return Status of an HTTP Limit_req Zone
        call: plus-http-http-limit-reqs.gethttplimitreqzone
        with:
          fields: rest.fields
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletehttplimitreqzonestat
        description: NGINX Reset Statistics for an HTTP Limit_req Zone
        call: plus-http-http-limit-reqs.deletehttplimitreqzonestat
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: plus-http-http-limit-reqs-mcp
    port: 9090
    transport: http
    description: MCP adapter for NGINX Plus REST API — HTTP Limit Reqs. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: nginx-return-status-all-http
      description: NGINX Return Status of All HTTP Limit_req Zones
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: plus-http-http-limit-reqs.gethttplimitreqzones
      with:
        fields: tools.fields
      outputParameters:
      - type: object
        mapping: $.
    - name: nginx-return-status-http-limit
      description: NGINX Return Status of an HTTP Limit_req Zone
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: plus-http-http-limit-reqs.gethttplimitreqzone
      with:
        fields: tools.fields
      outputParameters:
      - type: object
        mapping: $.
    - name: nginx-reset-statistics-http-limit
      description: NGINX Reset Statistics for an HTTP Limit_req Zone
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: plus-http-http-limit-reqs.deletehttplimitreqzonestat
      outputParameters:
      - type: object
        mapping: $.