openapi: 3.0.3
info:
  title: NGINX njs Scripting Connections Method DELETE API
  version: '0.8'
  description: The NGINX njs module provides a JavaScript runtime embedded inside NGINX. It does not expose HTTP endpoints itself. Instead, it offers scripting objects (HTTP request, stream session, Fetch API, etc.) that are available within njs handler functions configured in the NGINX configuration file. This specification documents the key njs objects as OpenAPI schemas only; the paths object is intentionally empty because there are no REST endpoints to describe.
  x-generated-from: documentation
  contact:
    name: NGINX
    url: https://nginx.org/en/docs/njs/reference.html
  license:
    name: BSD-2-Clause
    url: https://nginx.org/LICENSE
tags:
- name: Method DELETE
paths:
  /processes:
    delete:
      tags:
      - Method DELETE
      summary: NGINX Reset NGINX Processes Statistics
      description: Resets counters of abnormally terminated and respawned child processes.
      operationId: deleteProcesses
      responses:
        '204':
          description: Success
        '404':
          description: Unknown version (*UnknownVersion*)
          schema:
            $ref: '#/definitions/NginxError'
          examples:
            application/json:
              error: &id001 {}
              request_id: example-request_id
              href: example-href
          x-microcks-refs:
          - name: deleteProcesses404Example
            x-microcks-default: true
        '405':
          description: Method disabled (*MethodDisabled*)
          schema:
            $ref: '#/definitions/NginxError'
          examples:
            application/json:
              error: *id001
              request_id: example-request_id
              href: example-href
          x-microcks-refs:
          - name: deleteProcesses405Example
            x-microcks-default: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /connections:
    delete:
      tags:
      - Method DELETE
      summary: NGINX Reset Client Connections Statistics
      description: Resets statistics of accepted and dropped client connections.
      operationId: deleteConnections
      responses:
        '204':
          description: Success
        '404':
          description: Unknown version (*UnknownVersion*)
          schema:
            $ref: '#/definitions/NginxError'
          examples:
            application/json:
              error: &id002 {}
              request_id: example-request_id
              href: example-href
          x-microcks-refs:
          - name: deleteConnections404Example
            x-microcks-default: true
        '405':
          description: Method disabled (*MethodDisabled*)
          schema:
            $ref: '#/definitions/NginxError'
          examples:
            application/json:
              error: *id002
              request_id: example-request_id
              href: example-href
          x-microcks-refs:
          - name: deleteConnections405Example
            x-microcks-default: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /slabs/{slabZoneName}:
    parameters:
    - name: slabZoneName
      in: path
      description: The name of the shared memory zone with slab allocator.
      required: true
      type: string
      x-example: example_slabZoneName
    delete:
      tags:
      - Method DELETE
      summary: NGINX Reset Slab Statistics
      description: Resets the “<literal>reqs</literal>” and “<literal>fails</literal>” metrics for each memory slot.
      operationId: deleteSlabZoneStats
      responses:
        '204':
          description: Success
        '404':
          description: 'Slab not found (*SlabNotFound*),

            unknown version (*UnknownVersion*)

            '
          schema:
            $ref: '#/definitions/NginxError'
          examples:
            application/json:
              error: &id003 {}
              request_id: example-request_id
              href: example-href
          x-microcks-refs:
          - name: deleteSlabZoneStats404Example
            x-microcks-default: true
        '405':
          description: Method disabled (*MethodDisabled*)
          schema:
            $ref: '#/definitions/NginxError'
          examples:
            application/json:
              error: *id003
              request_id: example-request_id
              href: example-href
          x-microcks-refs:
          - name: deleteSlabZoneStats405Example
            x-microcks-default: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /http/requests:
    delete:
      tags:
      - Method DELETE
      summary: NGINX Reset HTTP Requests Statistics
      description: Resets the number of total client HTTP requests.
      operationId: deleteHttpRequests
      responses:
        '204':
          description: Success
        '404':
          description: Unknown version (*UnknownVersion*)
          schema:
            $ref: '#/definitions/NginxError'
          examples:
            application/json:
              error: &id004 {}
              request_id: example-request_id
              href: example-href
          x-microcks-refs:
          - name: deleteHttpRequests404Example
            x-microcks-default: true
        '405':
          description: Method disabled (*MethodDisabled*)
          schema:
            $ref: '#/definitions/NginxError'
          examples:
            application/json:
              error: *id004
              request_id: example-request_id
              href: example-href
          x-microcks-refs:
          - name: deleteHttpRequests405Example
            x-microcks-default: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /http/server_zones/{httpServerZoneName}:
    parameters:
    - name: httpServerZoneName
      in: path
      description: The name of an HTTP server zone.
      type: string
      required: true
      x-example: example_httpServerZoneName
    delete:
      tags:
      - Method DELETE
      summary: NGINX Reset Statistics for an HTTP Server Zone
      description: Resets statistics of accepted and discarded requests, responses, received and sent bytes, counters of SSL handshakes and session reuses in a particular HTTP server zone.
      operationId: deleteHttpServerZoneStat
      responses:
        '204':
          description: Success
        '404':
          description: 'Server zone not found (*ServerZoneNotFound*),

            unknown version (*UnknownVersion*)

            '
          schema:
            $ref: '#/definitions/NginxError'
          examples:
            application/json:
              error: &id005 {}
              request_id: example-request_id
              href: example-href
          x-microcks-refs:
          - name: deleteHttpServerZoneStat404Example
            x-microcks-default: true
        '405':
          description: Method disabled (*MethodDisabled*)
          schema:
            $ref: '#/definitions/NginxError'
          examples:
            application/json:
              error: *id005
              request_id: example-request_id
              href: example-href
          x-microcks-refs:
          - name: deleteHttpServerZoneStat405Example
            x-microcks-default: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /http/location_zones/{httpLocationZoneName}:
    parameters:
    - name: httpLocationZoneName
      in: path
      description: The name of an HTTP [location zone](https://nginx.org/en/docs/http/ngx_http_api_module.html#status_zone_location).
      type: string
      required: true
      x-example: example_httpLocationZoneName
    delete:
      tags:
      - Method DELETE
      summary: NGINX Reset Statistics for a Location Zone
      description: Resets statistics of accepted and discarded requests, responses, received and sent bytes in a particular location zone.
      operationId: deleteHttpLocationZoneStat
      responses:
        '204':
          description: Success
        '404':
          description: 'Location zone not found (*LocationZoneNotFound*),

            unknown version (*UnknownVersion*)

            '
          schema:
            $ref: '#/definitions/NginxError'
          examples:
            application/json:
              error: &id006 {}
              request_id: example-request_id
              href: example-href
          x-microcks-refs:
          - name: deleteHttpLocationZoneStat404Example
            x-microcks-default: true
        '405':
          description: Method disabled (*MethodDisabled*)
          schema:
            $ref: '#/definitions/NginxError'
          examples:
            application/json:
              error: *id006
              request_id: example-request_id
              href: example-href
          x-microcks-refs:
          - name: deleteHttpLocationZoneStat405Example
            x-microcks-default: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /http/caches/{httpCacheZoneName}:
    parameters:
    - name: httpCacheZoneName
      in: path
      description: The name of the cache zone.
      type: string
      required: true
      x-example: example_httpCacheZoneName
    delete:
      tags:
      - Method DELETE
      summary: NGINX Reset Cache Statistics
      description: Resets statistics of cache hits/misses in a particular cache zone.
      operationId: deleteHttpCacheZoneStat
      responses:
        '204':
          description: Success
        '404':
          description: 'Cache not found (*CacheNotFound*),

            unknown version (*UnknownVersion*)

            '
          schema:
            $ref: '#/definitions/NginxError'
          examples:
            application/json:
              error: &id007 {}
              request_id: example-request_id
              href: example-href
          x-microcks-refs:
          - name: deleteHttpCacheZoneStat404Example
            x-microcks-default: true
        '405':
          description: Method disabled (*MethodDisabled*)
          schema:
            $ref: '#/definitions/NginxError'
          examples:
            application/json:
              error: *id007
              request_id: example-request_id
              href: example-href
          x-microcks-refs:
          - name: deleteHttpCacheZoneStat405Example
            x-microcks-default: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /http/limit_conns/{httpLimitConnZoneName}:
    parameters:
    - name: httpLimitConnZoneName
      in: path
      description: The name of a [limit_conn zone](https://nginx.org/en/docs/http/ngx_http_limit_conn_module.html#limit_conn_zone).
      type: string
      required: true
      x-example: example_httpLimitConnZoneName
    delete:
      tags:
      - Method DELETE
      summary: NGINX Reset Statistics for an HTTP Limit_conn Zone
      description: Resets the connection limiting statistics.
      operationId: deleteHttpLimitConnZoneStat
      responses:
        '204':
          description: Success
        '404':
          description: 'limit_conn not found (*LimitConnNotFound*),

            unknown version (*UnknownVersion*)

            '
          schema:
            $ref: '#/definitions/NginxError'
          examples:
            application/json:
              error: &id008 {}
              request_id: example-request_id
              href: example-href
          x-microcks-refs:
          - name: deleteHttpLimitConnZoneStat404Example
            x-microcks-default: true
        '405':
          description: Method disabled (*MethodDisabled*)
          schema:
            $ref: '#/definitions/NginxError'
          examples:
            application/json:
              error: *id008
              request_id: example-request_id
              href: example-href
          x-microcks-refs:
          - name: deleteHttpLimitConnZoneStat405Example
            x-microcks-default: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /http/limit_reqs/{httpLimitReqZoneName}:
    parameters:
    - name: httpLimitReqZoneName
      in: path
      description: The name of a [limit_req zone](https://nginx.org/en/docs/http/ngx_http_limit_req_module.html#limit_req_zone).
      type: string
      required: true
      x-example: example_httpLimitReqZoneName
    delete:
      tags:
      - Method DELETE
      summary: NGINX Reset Statistics for an HTTP Limit_req Zone
      description: Resets the requests limiting statistics.
      operationId: deleteHttpLimitReqZoneStat
      responses:
        '204':
          description: Success
        '404':
          description: 'limit_req not found (*LimitReqNotFound*),

            unknown version (*UnknownVersion*)

            '
          schema:
            $ref: '#/definitions/NginxError'
          examples:
            application/json:
              error: &id009 {}
              request_id: example-request_id
              href: example-href
          x-microcks-refs:
          - name: deleteHttpLimitReqZoneStat404Example
            x-microcks-default: true
        '405':
          description: Method disabled (*MethodDisabled*)
          schema:
            $ref: '#/definitions/NginxError'
          examples:
            application/json:
              error: *id009
              request_id: example-request_id
              href: example-href
          x-microcks-refs:
          - name: deleteHttpLimitReqZoneStat405Example
            x-microcks-default: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /http/upstreams/{httpUpstreamName}/:
    parameters:
    - name: httpUpstreamName
      in: path
      description: The name of an HTTP upstream server group.
      required: true
      type: string
      x-example: example_httpUpstreamName
    delete:
      tags:
      - Method DELETE
      summary: NGINX Reset Statistics of an HTTP Upstream Server Group
      description: Resets the statistics for each upstream server in an upstream server group and queue statistics.
      operationId: deleteHttpUpstreamStat
      produces:
      - application/json
      responses:
        '204':
          description: Success
        '400':
          description: Upstream is static (*UpstreamStatic*)
          schema:
            $ref: '#/definitions/NginxError'
          examples:
            application/json:
              error: &id010 {}
              request_id: example-request_id
              href: example-href
          x-microcks-refs:
          - name: deleteHttpUpstreamStat400Example
            x-microcks-default: true
        '404':
          description: 'Unknown version (*UnknownVersion*),

            upstream not found (*UpstreamNotFound*)

            '
          schema:
            $ref: '#/definitions/NginxError'
          examples:
            application/json:
              error: *id010
              request_id: example-request_id
              href: example-href
          x-microcks-refs:
          - name: deleteHttpUpstreamStat404Example
            x-microcks-default: true
        '405':
          description: Method disabled (*MethodDisabled*)
          schema:
            $ref: '#/definitions/NginxError'
          examples:
            application/json:
              error: *id010
              request_id: example-request_id
              href: example-href
          x-microcks-refs:
          - name: deleteHttpUpstreamStat405Example
            x-microcks-default: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /http/upstreams/{httpUpstreamName}/servers/{httpUpstreamServerId}:
    parameters:
    - name: httpUpstreamName
      in: path
      description: The name of the upstream server group.
      required: true
      type: string
      x-example: example_httpUpstreamName
    - name: httpUpstreamServerId
      in: path
      description: The ID of the server.
      required: true
      type: string
      x-example: example_httpUpstreamServerId
    delete:
      tags:
      - Method DELETE
      summary: NGINX Remove a Server from an HTTP Upstream Server Group
      description: Removes a server from an HTTP upstream server group.
      operationId: deleteHttpUpstreamServer
      produces:
      - application/json
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/NginxHTTPUpstreamConfServerMap'
          examples:
            application/json:
            - id: 0
              server: 10.0.0.1:8088
              weight: 1
              max_conns: 0
              max_fails: 0
              fail_timeout: 10s
              slow_start: 10s
              route: ''
              backup: false
              down: false
            - id: 1
              server: 10.0.0.1:8089
              weight: 4
              max_conns: 0
              max_fails: 0
              fail_timeout: 10s
              slow_start: 10s
              route: ''
              backup: true
              down: true
          x-microcks-refs:
          - name: deleteHttpUpstreamServer200Example
            x-microcks-default: true
        '400':
          description: 'Upstream is static (*UpstreamStatic*),

            invalid server ID (*UpstreamBadServerId*),

            server “**id**” not removable (*UpstreamServerImmutable*)

            '
          schema:
            $ref: '#/definitions/NginxError'
          examples:
            application/json:
              error: &id011 {}
              request_id: example-request_id
              href: example-href
          x-microcks-refs:
          - name: deleteHttpUpstreamServer400Example
            x-microcks-default: true
        '404':
          description: 'Server with ID “**id**” does not exist (*UpstreamServerNotFound*),

            unknown version (*UnknownVersion*),

            upstream not found (*UpstreamNotFound*)

            '
          schema:
            $ref: '#/definitions/NginxError'
          examples:
            application/json:
              error: *id011
              request_id: example-request_id
              href: example-href
          x-microcks-refs:
          - name: deleteHttpUpstreamServer404Example
            x-microcks-default: true
        '405':
          description: Method disabled (*MethodDisabled*)
          schema:
            $ref: '#/definitions/NginxError'
          examples:
            application/json:
              error: *id011
              request_id: example-request_id
              href: example-href
          x-microcks-refs:
          - name: deleteHttpUpstreamServer405Example
            x-microcks-default: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /http/keyvals/{httpKeyvalZoneName}:
    parameters:
    - name: httpKeyvalZoneName
      in: path
      description: The name of an HTTP keyval shared memory zone.
      required: true
      type: string
      x-example: example_httpKeyvalZoneName
    delete:
      tags:
      - Method DELETE
      summary: NGINX Empty the HTTP Keyval Zone
      description: Deletes all key-value pairs from the HTTP keyval shared memory [zone](https://nginx.org/en/docs/http/ngx_http_keyval_module.html#keyval_zone). If <a href="https://nginx.org/en/docs/stream/ngx_stream_zone_sync_module.html#zone_sync">synchronization</a> of keyval zones in a cluster is enabled, empties the keyval zone only on a target cluster node.
      operationId: deleteHttpKeyvalZoneData
      responses:
        '204':
          description: Success
        '404':
          description: 'Keyval not found (*KeyvalNotFound*),

            unknown version (*UnknownVersion*)

            '
          schema:
            $ref: '#/definitions/NginxError'
          examples:
            application/json:
              error: &id012 {}
              request_id: example-request_id
              href: example-href
          x-microcks-refs:
          - name: deleteHttpKeyvalZoneData404Example
            x-microcks-default: true
        '405':
          description: Method disabled (*MethodDisabled*)
          schema:
            $ref: '#/definitions/NginxError'
          examples:
            application/json:
              error: *id012
              request_id: example-request_id
              href: example-href
          x-microcks-refs:
          - name: deleteHttpKeyvalZoneData405Example
            x-microcks-default: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /stream/server_zones/{streamServerZoneName}:
    parameters:
    - name: streamServerZoneName
      in: path
      description: The name of a stream server zone.
      type: string
      required: true
      x-example: example_streamServerZoneName
    delete:
      tags:
      - Method DELETE
      summary: NGINX Reset Statistics for a Stream Server Zone
      description: Resets statistics of accepted and discarded connections, sessions, received and sent bytes, counters of SSL handshakes and session reuses in a particular stream server zone.
      operationId: deleteStreamServerZoneStat
      responses:
        '204':
          description: Success
        '404':
          description: 'Server zone not found (*ServerZoneNotFound*),

            unknown version (*UnknownVersion*)

            '
          schema:
            $ref: '#/definitions/NginxError'
          examples:
            application/json:
              error: &id013 {}
              request_id: example-request_id
              href: example-href
          x-microcks-refs:
          - name: deleteStreamServerZoneStat404Example
            x-microcks-default: true
        '405':
          description: Method disabled (*MethodDisabled*)
          schema:
            $ref: '#/definitions/NginxError'
          examples:
            application/json:
              error: *id013
              request_id: example-request_id
              href: example-href
          x-microcks-refs:
          - name: deleteStreamServerZoneStat405Example
            x-microcks-default: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /stream/limit_conns/{streamLimitConnZoneName}:
    parameters:
    - name: streamLimitConnZoneName
      in: path
      description: The name of a [limit_conn zone](https://nginx.org/en/docs/stream/ngx_stream_limit_conn_module.html#limit_conn_zone).
      type: string
      required: true
      x-example: example_streamLimitConnZoneName
    delete:
      tags:
      - Method DELETE
      summary: NGINX Reset Statistics for a Stream Limit_conn Zone
      description: Resets the connection limiting statistics.
      operationId: deleteStreamLimitConnZoneStat
      responses:
        '204':
          description: Success
        '404':
          description: 'limit_conn not found (*LimitConnNotFound*),

            unknown version (*UnknownVersion*)

            '
          schema:
            $ref: '#/definitions/NginxError'
          examples:
            application/json:
              error: &id014 {}
              request_id: example-request_id
              href: example-href
          x-microcks-refs:
          - name: deleteStreamLimitConnZoneStat404Example
            x-microcks-default: true
        '405':
          description: Method disabled (*MethodDisabled*)
          schema:
            $ref: '#/definitions/NginxError'
          examples:
            application/json:
              error: *id014
              request_id: example-request_id
              href: example-href
          x-microcks-refs:
          - name: deleteStreamLimitConnZoneStat405Example
            x-microcks-default: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /stream/upstreams/{streamUpstreamName}/:
    parameters:
    - name: streamUpstreamName
      in: path
      description: The name of a stream upstream server group.
      required: true
      type: string
      x-example: example_streamUpstreamName
    delete:
      tags:
      - Method DELETE
      summary: NGINX Reset Statistics of a Stream Upstream Server Group
      description: Resets the statistics for each upstream server in an upstream server group.
      operationId: deleteStreamUpstreamStat
      produces:
      - application/json
      responses:
        '204':
          description: Success
        '400':
          description: Upstream is static (*UpstreamStatic*)
          schema:
            $ref: '#/definitions/NginxError'
          examples:
            application/json:
              error: &id015 {}
              request_id: example-request_id
              href: example-href
          x-microcks-refs:
          - name: deleteStreamUpstreamStat400Example
            x-microcks-default: true
        '404':
          description: 'Unknown version (*UnknownVersion*),

            upstream not found (*UpstreamNotFound*)

            '
          schema:
            $ref: '#/definitions/NginxError'
          examples:
            application/json:
              error: *id015
              request_id: example-request_id
              href: example-href
          x-microcks-refs:
          - name: deleteStreamUpstreamStat404Example
            x-microcks-default: true
        '405':
          description: Method disabled (*MethodDisabled*)
          schema:
            $ref: '#/definitions/NginxError'
          examples:
            application/json:
              error: *id015
              request_id: example-request_id
              href: example-href
          x-microcks-refs:
          - name: deleteStreamUpstreamStat405Example
            x-microcks-default: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /stream/upstreams/{streamUpstreamName}/servers/{streamUpstreamServerId}:
    parameters:
    - name: streamUpstreamName
      in: path
      description: The name of the upstream server group.
      required: true
      type: string
      x-example: example_streamUpstreamName
    - name: streamUpstreamServerId
      in: path
      description: The ID of the server.
      required: true
      type: string
      x-example: example_streamUpstreamServerId
    delete:
      tags:
      - Method DELETE
      summary: NGINX Remove a Server from a Stream Upstream Server Group
      description: Removes a server from a stream server group.
      operationId: deleteStreamUpstreamServer
      produces:
      - application/json
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/NginxStreamUpstreamConfServerMap'
          examples:
            application/json:
            - id: 0
              server: 10.0.0.1:12348
              weight: 1
              max_conns: 0
              max_fails: 1
              fail_timeout: 10s
              slow_start: 0
              backup: false
              down: false
            - id: 1
              server: 10.0.0.1:12349
              weight: 1
              max_conns: 0
              max_fails: 1
              fail_timeout: 10s
              slow_start: 0
              backup: false
              down: false
          x-microcks-refs:
          - name: deleteStreamUpstreamServer200Example
            x-microcks-default: true
        '400':
          description: 'Upstream is static (*UpstreamStatic*),

            invalid server ID (*UpstreamBadServerId*),

            server “**id**” not removable (*UpstreamServerImmutable*)

            '
          schema:
            $ref: '#/definitions/NginxError'
          examples:
            application/json:
              error: &id016 {}
              request_id: example-request_id
              href: example-href
          x-microcks-refs:
          - name: deleteStreamUpstreamServer400Example
            x-microcks-default: true
        '404':
          description: 'Server with ID “**id**” does not exist (*UpstreamServerNotFound*),

            unknown version (*UnknownVersion*),

            upstream not found (*UpstreamNotFound*)

            '
          schema:
            $ref: '#/definitions/NginxError'
          examples:
            application/json:
              error: *id016
              request_id: example-request_id
              href: example-href
          x-microcks-refs:
          - name: deleteStreamUpstreamServer404Example
            x-microcks-default: true
        '405':
          description: Method disabled (*MethodDisabled*)
          schema:
            $ref: '#/definitions/NginxError'
          examples:
            application/json:
              error: *id016
              request_id: example-request_id
              href: example-href
          x-microcks-refs:
          - name: deleteStreamUpstreamServer405Example
            x-microcks-default: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /stream/keyvals/{streamKeyvalZoneName}:
    parameters:
    - name: streamKeyvalZoneName
      in: path
      description: The name of a stream keyval shared memory zone.
      required: true
      type: string
      x-example: example_streamKeyvalZoneName
    delete:
      tags:
      - Method DELETE
      summary: NGINX Empty the Stream Keyval Zone
      description: Deletes all key-value pairs from the stream keyval shared memory [zone](https://nginx.org/en/docs/stream/ngx_stream_keyval_module.html#keyval_zone). If <a href="https://nginx.org/en/docs/stream/ngx_stream_zone_sync_module.html#zone_sync">synchronization</a> of keyval zones in a cluster is enabled, empties the keyval zone only on a target cluster node.
      operationId: deleteStreamKeyvalZoneData
      responses:
        '204':
          description: Success
        '404':
          description: 'Keyval not found (*KeyvalNotFound*),

            unknown version (*UnknownVersion*)

            '
          schema:
            $ref: '#/definitions/NginxError'
          examples:
            application/json:
              error: &id017 {}
              request_id: example-request_id
              href: example-href
          x-microcks-refs:
          - name: deleteStreamKeyvalZoneData404Example
            x-microcks-default: true
        '405':
          description: Method disabled (*MethodDisabled*)
          schema:
            $ref: '#/definitions/NginxError'
          examples:
            application/json:
              error: *id017
              request_id: example-request_id
              href: example-href
          x-microcks-refs:
          - name: deleteStreamKeyvalZoneData405Example
            x-microcks-default: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /resolvers/{resolverZoneName}:
    parameters:
    - name: resolverZoneName
      in: path
      description: The name of a resolver zone.
      required: true
      type: string
      x-example: example_resolverZoneName
    delete:
      tags:
      - Method DELETE
      summary: NGINX Reset Statistics for a Resolver Zone
      description: Resets statistics in a particular resolver zone.
      operationId: deleteResolverZoneStat
      responses:
        '204':
          description: Success
        '404':
          description: 'Resolver zone not found (*ResolverZoneNotFound*),

            unknown version (*UnknownVersion*)

            '
          schema:
            $ref: '#/definitions/NginxError'
          examples:
            application/json:
              error: &id018 {}
              request_id: example-request_id
              href: example-href
          x-microcks-refs:
          - name: deleteResolverZoneStat404Example
            x-microcks-default: true
        '405':
          description: Method disabled (*MethodDisabled*)
          schema:
            $ref: '#/definitions/NginxError'
          examples:
            application/json:
              error: *id018
              request_id: example-request_id
              href: example-href
          x-microcks-refs:
          - name: deleteResolverZoneStat405Example
            x-microcks-default: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /ssl:
    delete:
      tags:
      - Method DELETE
      summary: NGINX Reset SSL Statistics
      description: Resets counters of SSL handshakes and session reuses.
      operationId: deleteSslStat
      responses:
        '204':
          description: Success
        '404':
          description: Unknown version (*UnknownVersion*)
          schema:
            $ref: '#/definitions/NginxError'
          examples:
            application/json:
              error: &id019 {}
              request_id: example-request_id
              href: example-href
          x-microcks-refs:
          - name: deleteSslStat404Example
            x-microcks-default: true
        '405':
          description: Method disabled (*MethodDisabled*)
          schema:
            $ref: '#/definitions/NginxError'
          examples:
            application/json:
              error: *id019
              request_id: example-request_id
              href: example-href
          x-microcks-refs:
          - name: deleteSslStat405Example
            x-microcks-default: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /workers/:
    delete:
      tags:
      - Method DELETE
      summary: NGINX Reset Statistics for All Worker Processes
      description: 'Resets statistics for all worker processes such as

        accepted, dropped, active, idle connections, total and current requests.

        '
      operationId: deleteWorkersStat
      produces:
      - application/json
      responses:
        '204':
          description: Success
        '404':
          description: 'Worker not found (*WorkerNotFound*),

            unknown version (*UnknownVersion*)

            '
          schema:
            $ref: '#/definitions/NginxError'
          examples:
            application/json:
              error: &id020 {}
              request_id: example-request_id
              href: example-href
          x-microcks-refs:
          - name: deleteWorkersStat404Example
            x-microcks-default: true
        '405':
          description: Method disabled (*MethodDisabled*)
          schema:
            $ref: '#/definitions/NginxError'
          examples:
            application/json:
              error: *id020
              request_id: example-request_id
              href: example-href
          x-microcks-refs:
          - name: deleteWorkersStat405Example
            x-microcks-default: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /workers/{workerId}:
    parameters:
    - name: workerId
      in: path
      description: The ID of the worker process.
      required: true
      type: string
      x-example: example_workerId
    delete:
      tags:
      - Method DELETE
      summary: NGINX Reset Statistics for a Worker Process
      description: 'Resets statistics of accepted, dropped, active, idle connections,

        as well as total and current requests.

        '
      operationId: deleteWorkerStat
      produces:
      - application/json
      responses:
        '204':
          description: Success
        '404':
          description: 'Worker not found (*WorkerNotFound*),

            unknown version (*UnknownVersion*)

            '
          schema:
            $ref: '#/definitions/NginxError'
          examples:
            application/json:
              error: &id021 {}
              request_id: example-request_id
              href: example-href
          x-microcks-refs:
          - name: deleteWorkerStat404Example
            x-microcks-default: true
        '405':
          description: Method disabled (*MethodDisabled*)
          schema:
            $ref: '#/definitions/NginxError'
          examples:
            application/json:
              error: *id021
              request_id: example-request_id
              href: example-href
          x-microcks-refs:
          - name: deleteWorkerStat405Example
            x-microcks-default: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
definitions:
  NginxHTTPUpstreamConfServerMap:
    title: HTTP Upstream Servers
    description: An array of HTTP upstream servers for dynamic configuration.
    type: array
    items:
      $ref: '#/definitions/NginxHTTPUpstreamConfServer'
    example:
    - id: 0
      server: 10.0.0.1:8088
      weight: 1
      max_conns: 0
      max_fails: 0
      fail_timeout: 10s
      slow_start: 10s
      route: ''
      backup: false
      down: false
    - id: 1
      server: 10.0.0.1:8089
      weight: 4
      max_conns: 0
      max_fails: 0
      fail_timeout: 10s
      slow_start: 10s
      route: ''
      backup: true
      down: true
  NginxHTTPUpstreamConfServer:
    title: HTTP Upstream Server
    description: 'Dynamically configurable parameters of an HTTP upstream

      <a href="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#server">server</a>:

      '
    type: object
    properties:
      id:
        type: integer
        description: The ID of the HTTP upstream server. The ID is assigned automatically and cannot be changed.
        readOnly: true
        example: 0
      server:
        type: string
        description: Same as the <a href="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#server">address</a> parameter of the HTTP upstream server. When adding a server, it is possible to specify it as a domain name. In this case, changes of the IP addresses that correspond to a domain name will be monitored and automatically applied to the upstream configuration without the need of restarting nginx. This requires the <a href="https://nginx.org/en/docs/http/ngx_http_core_module.html#resolver">resolver</a> directive in the “<code>http</code>” block. See also the <a href="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#resolve">resolve</a> parameter of the HTTP upstream server.
        example: example-server
      service:
        type: string
        description: Same as the <a href="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#service">service</a> parameter of the HTTP upstream server. This parameter cannot be changed.
        readOnly: true
        example: example-service
      weight:
        type: integer
        description: Same as the <a href="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#weight">weight</a> parameter of the HTTP upstream server.
        example: 0
      max_conns:
        type: integer
        description: Same as the <a href="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#max_conns">max_conns</a> parameter of the HTTP upstream server.
        example: 0
      max_fails:
        type: integer
        description: Same as the <a href="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#max_fails">max_fails</a> parameter of the HTTP upstream server.
        example: 0
      fail_timeout:
        type: string
        description: Same as the <a href="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#fail_timeout">fail_timeout</a> parameter of the HTTP upstream server.
        example: example-fail_timeout
      slow_start:
        type: string
        description: Same as the <a href="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#slow_start">slow_start</a> parameter of the HTTP upstream server.
        example: example-slow_start
      route:
        type: string
        description: Same as the <a href="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#route">route</a> parameter of the HTTP upstream server.
        example: example-route
      backup:
        type: boolean
        description: When <code>true</code>, adds a <a href="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#backup">backup</a> server. This parameter cannot be changed.
        readOnly: true
        example: false
      down:
        type: boolean
        description: Same as the <a href="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#down">down</a> parameter of the HTTP upstream server.
        example: false
      drain:
        type: boolean
        description: Same as the <a href="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#drain">drain</a> parameter of the HTTP upstream server.
        example: false
      parent:
        type: string
        description: Parent server ID of the resolved server. The ID is assigned automatically and cannot be changed.
        readOnly: true
        example: example-parent
      host:
        type: string
        description: Hostname of the resolved server. The hostname is assigned automatically and cannot be changed.
        readOnly: true
        example: example-host
    example:
      id: 1
      server: 10.0.0.1:8089
      weight: 4
      max_conns: 0
      max_fails: 0
      fail_timeout: 10s
      slow_start: 10s
      route: ''
      backup: true
      down: true
  NginxStreamUpstreamConfServer:
    title: Stream Upstream Server
    description: 'Dynamically configurable parameters of a stream upstream

      <a href="https://nginx.org/en/docs/stream/ngx_stream_upstream_module.html#server">server</a>:

      '
    type: object
    properties:
      id:
        type: integer
        description: The ID of the stream upstream server. The ID is assigned automatically and cannot be changed.
        readOnly: true
        example: 0
      server:
        type: string
        description: Same as the <a href="https://nginx.org/en/docs/stream/ngx_stream_upstream_module.html#server">address</a> parameter of the stream upstream server. When adding a server, it is possible to specify it as a domain name. In this case, changes of the IP addresses that correspond to a domain name will be monitored and automatically applied to the upstream configuration without the need of restarting nginx. This requires the <a href="https://nginx.org/en/docs/stream/ngx_stream_core_module.html#resolver">resolver</a> directive in the “<code>stream</code>” block. See also the <a href="https://nginx.org/en/docs/stream/ngx_stream_upstream_module.html#resolve">resolve</a> parameter of the stream upstream server.
        example: example-server
      service:
        type: string
        description: Same as the <a href="https://nginx.org/en/docs/stream/ngx_stream_upstream_module.html#service">service</a> parameter of the stream upstream server. This parameter cannot be changed.
        readOnly: true
        example: example-service
      weight:
        type: integer
        description: Same as the <a href="https://nginx.org/en/docs/stream/ngx_stream_upstream_module.html#weight">weight</a> parameter of the stream upstream server.
        example: 0
      max_conns:
        type: integer
        description: Same as the <a href="https://nginx.org/en/docs/stream/ngx_stream_upstream_module.html#max_conns">max_conns</a> parameter of the stream upstream server.
        example: 0
      max_fails:
        type: integer
        description: Same as the <a href="https://nginx.org/en/docs/stream/ngx_stream_upstream_module.html#max_fails">max_fails</a> parameter of the stream upstream server.
        example: 0
      fail_timeout:
        type: string
        description: Same as the <a href="https://nginx.org/en/docs/stream/ngx_stream_upstream_module.html#fail_timeout">fail_timeout</a> parameter of the stream upstream server.
        example: example-fail_timeout
      slow_start:
        type: string
        description: Same as the <a href="https://nginx.org/en/docs/stream/ngx_stream_upstream_module.html#slow_start">slow_start</a> parameter of the stream upstream server.
        example: example-slow_start
      backup:
        type: boolean
        description: When <code>true</code>, adds a <a href="https://nginx.org/en/docs/stream/ngx_stream_upstream_module.html#backup">backup</a> server. This parameter cannot be changed.
        readOnly: true
        example: false
      down:
        type: boolean
        description: Same as the <a href="https://nginx.org/en/docs/stream/ngx_stream_upstream_module.html#down">down</a> parameter of the stream upstream server.
        example: false
      parent:
        type: string
        description: Parent server ID of the resolved server. The ID is assigned automatically and cannot be changed.
        readOnly: true
        example: example-parent
      host:
        type: string
        description: Hostname of the resolved server. The hostname is assigned automatically and cannot be changed.
        readOnly: true
        example: example-host
    example:
      id: 0
      server: 10.0.0.1:12348
      weight: 1
      max_conns: 0
      max_fails: 1
      fail_timeout: 10s
      slow_start: 0
      backup: false
      down: false
  NginxError:
    title: Error
    description: 'nginx error object.

      '
    type: object
    properties:
      error:
        type: object
        properties:
          status:
            type: integer
            description: HTTP error code.
            example: 200
          text:
            type: string
            description: Error description.
            example: example-text
          code:
            type: string
            description: Internal nginx error code.
            example: 200
        example: {}
      request_id:
        type: string
        description: The ID of the request, equals the value of the <a href="https://nginx.org/en/docs/http/ngx_http_core_module.html#var_request_id">$request_id</a> variable.
        example: example-request_id
      href:
        type: string
        description: Link to reference documentation.
        example: example-href
  NginxStreamUpstreamConfServerMap:
    title: Stream Upstream Servers
    description: 'An array of stream upstream servers for dynamic configuration.

      '
    type: array
    items:
      $ref: '#/definitions/NginxStreamUpstreamConfServer'
    example:
    - id: 0
      server: 10.0.0.1:12348
      weight: 1
      max_conns: 0
      max_fails: 1
      fail_timeout: 10s
      slow_start: 0
      backup: false
      down: false
    - id: 1
      server: 10.0.0.1:12349
      weight: 1
      max_conns: 0
      max_fails: 1
      fail_timeout: 10s
      slow_start: 0
      backup: false
      down: false
externalDocs:
  description: NGINX njs Reference
  url: https://nginx.org/en/docs/njs/reference.html