NGINX Plus REST API — Method POST

naftiko: 1.0.0-alpha2
info:
  label: NGINX Plus REST API — Method POST
  description: 'NGINX Plus REST API — Method POST. 4 operations. Lead operation: NGINX Add a Key-Value Pair to the HTTP Keyval
    Zone. Self-contained Naftiko capability covering one Nginx business surface.'
  tags:
  - Nginx
  - Method POST
  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-post
    baseUri: ''
    description: NGINX Plus REST API — Method POST business capability. Self-contained, no shared references.
    resources:
    - name: http-keyvals-httpKeyvalZoneName
      path: /http/keyvals/{httpKeyvalZoneName}
      operations:
      - name: posthttpkeyvalzonedata
        method: POST
        description: NGINX Add a Key-Value Pair to the HTTP Keyval Zone
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: Key-value
          in: body
          type: string
          description: A key-value pair is specified in the JSON format. Several key-value pairs can be entered if the HTTP
            keyval shared memory zone is empty. Expiration time in mill
          required: true
    - name: http-upstreams-httpUpstreamName-servers
      path: /http/upstreams/{httpUpstreamName}/servers/
      operations:
      - name: posthttpupstreamserver
        method: POST
        description: NGINX Add a Server to an HTTP Upstream Server Group
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: postHttpUpstreamServer
          in: body
          type: string
          description: Address of a new server and other optional parameters 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: poststreamkeyvalzonedata
        method: POST
        description: NGINX Add a Key-Value Pair to the Stream Keyval Zone
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: Key-value
          in: body
          type: string
          description: A key-value pair is specified in the JSON format. Several key-value pairs can be entered if the stream
            keyval shared memory zone is empty. Expiration time in mi
          required: true
    - name: stream-upstreams-streamUpstreamName-servers
      path: /stream/upstreams/{streamUpstreamName}/servers/
      operations:
      - name: poststreamupstreamserver
        method: POST
        description: NGINX Add a Server to a Stream Upstream Server Group
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: postStreamUpstreamServer
          in: body
          type: string
          description: Address of a new server and other optional parameters in the JSON format. The “*ID*”, “*backup*”, and
            “*service*” parameters cannot be changed.
          required: true
  exposes:
  - type: rest
    namespace: plus-http-method-post-rest
    port: 8080
    description: REST adapter for NGINX Plus REST API — Method POST. 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: POST
        name: posthttpkeyvalzonedata
        description: NGINX Add a Key-Value Pair to the HTTP Keyval Zone
        call: plus-http-method-post.posthttpkeyvalzonedata
        with:
          Key-value: rest.Key-value
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/http/upstreams/{httpupstreamname}/servers
      name: http-upstreams-httpupstreamname-servers
      description: REST surface for http-upstreams-httpUpstreamName-servers.
      operations:
      - method: POST
        name: posthttpupstreamserver
        description: NGINX Add a Server to an HTTP Upstream Server Group
        call: plus-http-method-post.posthttpupstreamserver
        with:
          postHttpUpstreamServer: rest.postHttpUpstreamServer
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/stream/keyvals/{streamkeyvalzonename}
      name: stream-keyvals-streamkeyvalzonename
      description: REST surface for stream-keyvals-streamKeyvalZoneName.
      operations:
      - method: POST
        name: poststreamkeyvalzonedata
        description: NGINX Add a Key-Value Pair to the Stream Keyval Zone
        call: plus-http-method-post.poststreamkeyvalzonedata
        with:
          Key-value: rest.Key-value
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/stream/upstreams/{streamupstreamname}/servers
      name: stream-upstreams-streamupstreamname-servers
      description: REST surface for stream-upstreams-streamUpstreamName-servers.
      operations:
      - method: POST
        name: poststreamupstreamserver
        description: NGINX Add a Server to a Stream Upstream Server Group
        call: plus-http-method-post.poststreamupstreamserver
        with:
          postStreamUpstreamServer: rest.postStreamUpstreamServer
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: plus-http-method-post-mcp
    port: 9090
    transport: http
    description: MCP adapter for NGINX Plus REST API — Method POST. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: nginx-add-key-value-pair
      description: NGINX Add a Key-Value Pair to the HTTP Keyval Zone
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: plus-http-method-post.posthttpkeyvalzonedata
      with:
        Key-value: tools.Key-value
      outputParameters:
      - type: object
        mapping: $.
    - name: nginx-add-server-http-upstream
      description: NGINX Add a Server to an HTTP Upstream Server Group
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: plus-http-method-post.posthttpupstreamserver
      with:
        postHttpUpstreamServer: tools.postHttpUpstreamServer
      outputParameters:
      - type: object
        mapping: $.
    - name: nginx-add-key-value-pair-2
      description: NGINX Add a Key-Value Pair to the Stream Keyval Zone
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: plus-http-method-post.poststreamkeyvalzonedata
      with:
        Key-value: tools.Key-value
      outputParameters:
      - type: object
        mapping: $.
    - name: nginx-add-server-stream-upstream
      description: NGINX Add a Server to a Stream Upstream Server Group
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: plus-http-method-post.poststreamupstreamserver
      with:
        postStreamUpstreamServer: tools.postStreamUpstreamServer
      outputParameters:
      - type: object
        mapping: $.