NGINX Plus REST API — Method PATCH

naftiko: 1.0.0-alpha2
info:
  label: NGINX Plus REST API — Method PATCH
  description: 'NGINX Plus REST API — Method PATCH. 4 operations. Lead operation: NGINX Modify a Key-Value or Delete a Key.
    Self-contained Naftiko capability covering one Nginx business surface.'
  tags:
  - Nginx
  - Method PATCH
  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-method-patch
    baseUri: ''
    description: NGINX Plus REST API — Method PATCH business capability. Self-contained, no shared references.
    resources:
    - name: http-keyvals-httpKeyvalZoneName
      path: /http/keyvals/{httpKeyvalZoneName}
      operations:
      - name: patchhttpkeyvalzonekeyvalue
        method: PATCH
        description: NGINX Modify a Key-Value or Delete a Key
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: httpKeyvalZoneKeyValue
          in: body
          type: string
          description: A new value for the key is specified in the JSON format.
          required: true
    - name: http-upstreams-httpUpstreamName-servers-httpUpstreamServerId
      path: /http/upstreams/{httpUpstreamName}/servers/{httpUpstreamServerId}
      operations:
      - name: patchhttpupstreampeer
        method: PATCH
        description: NGINX Modify a Server in an HTTP Upstream Server Group
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: patchHttpUpstreamServer
          in: body
          type: string
          description: Server parameters, specified in the JSON format. The “*ID*”, “*backup*”, and “*service*” parameters
            cannot be changed.
          required: true
    - name: stream-keyvals-streamKeyvalZoneName
      path: /stream/keyvals/{streamKeyvalZoneName}
      operations:
      - name: patchstreamkeyvalzonekeyvalue
        method: PATCH
        description: NGINX Modify a Key-Value or Delete a Key
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: streamKeyvalZoneKeyValue
          in: body
          type: string
          description: A new value for the key is specified in the JSON format.
          required: true
    - name: stream-upstreams-streamUpstreamName-servers-streamUpstreamServerId
      path: /stream/upstreams/{streamUpstreamName}/servers/{streamUpstreamServerId}
      operations:
      - name: patchstreamupstreamserver
        method: PATCH
        description: NGINX Modify a Server in a Stream Upstream Server Group
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: patchStreamUpstreamServer
          in: body
          type: string
          description: Server parameters, specified in the JSON format. The “*ID*”, “*backup*”, and “*service*” parameters
            cannot be changed.
          required: true
  exposes:
  - type: rest
    namespace: plus-http-method-patch-rest
    port: 8080
    description: REST adapter for NGINX Plus REST API — Method PATCH. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/http/keyvals/{httpkeyvalzonename}
      name: http-keyvals-httpkeyvalzonename
      description: REST surface for http-keyvals-httpKeyvalZoneName.
      operations:
      - method: PATCH
        name: patchhttpkeyvalzonekeyvalue
        description: NGINX Modify a Key-Value or Delete a Key
        call: plus-http-method-patch.patchhttpkeyvalzonekeyvalue
        with:
          httpKeyvalZoneKeyValue: rest.httpKeyvalZoneKeyValue
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/http/upstreams/{httpupstreamname}/servers/{httpupstreamserverid}
      name: http-upstreams-httpupstreamname-servers-httpupstreamserverid
      description: REST surface for http-upstreams-httpUpstreamName-servers-httpUpstreamServerId.
      operations:
      - method: PATCH
        name: patchhttpupstreampeer
        description: NGINX Modify a Server in an HTTP Upstream Server Group
        call: plus-http-method-patch.patchhttpupstreampeer
        with:
          patchHttpUpstreamServer: rest.patchHttpUpstreamServer
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/stream/keyvals/{streamkeyvalzonename}
      name: stream-keyvals-streamkeyvalzonename
      description: REST surface for stream-keyvals-streamKeyvalZoneName.
      operations:
      - method: PATCH
        name: patchstreamkeyvalzonekeyvalue
        description: NGINX Modify a Key-Value or Delete a Key
        call: plus-http-method-patch.patchstreamkeyvalzonekeyvalue
        with:
          streamKeyvalZoneKeyValue: rest.streamKeyvalZoneKeyValue
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/stream/upstreams/{streamupstreamname}/servers/{streamupstreamserverid}
      name: stream-upstreams-streamupstreamname-servers-streamupstreamserverid
      description: REST surface for stream-upstreams-streamUpstreamName-servers-streamUpstreamServerId.
      operations:
      - method: PATCH
        name: patchstreamupstreamserver
        description: NGINX Modify a Server in a Stream Upstream Server Group
        call: plus-http-method-patch.patchstreamupstreamserver
        with:
          patchStreamUpstreamServer: rest.patchStreamUpstreamServer
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: plus-http-method-patch-mcp
    port: 9090
    transport: http
    description: MCP adapter for NGINX Plus REST API — Method PATCH. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: nginx-modify-key-value-delete
      description: NGINX Modify a Key-Value or Delete a Key
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: plus-http-method-patch.patchhttpkeyvalzonekeyvalue
      with:
        httpKeyvalZoneKeyValue: tools.httpKeyvalZoneKeyValue
      outputParameters:
      - type: object
        mapping: $.
    - name: nginx-modify-server-http-upstream
      description: NGINX Modify a Server in an HTTP Upstream Server Group
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: plus-http-method-patch.patchhttpupstreampeer
      with:
        patchHttpUpstreamServer: tools.patchHttpUpstreamServer
      outputParameters:
      - type: object
        mapping: $.
    - name: nginx-modify-key-value-delete-2
      description: NGINX Modify a Key-Value or Delete a Key
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: plus-http-method-patch.patchstreamkeyvalzonekeyvalue
      with:
        streamKeyvalZoneKeyValue: tools.streamKeyvalZoneKeyValue
      outputParameters:
      - type: object
        mapping: $.
    - name: nginx-modify-server-stream-upstream
      description: NGINX Modify a Server in a Stream Upstream Server Group
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: plus-http-method-patch.patchstreamupstreamserver
      with:
        patchStreamUpstreamServer: tools.patchStreamUpstreamServer
      outputParameters:
      - type: object
        mapping: $.