F5 Workers API

openapi: 3.2.0
info:
  version: '9.0'
  title: NGINX Plus REST Workers API
  description: NGINX Plus REST API provides access to NGINX Plus status information, on-the-fly configuration of upstream servers and key-value pairs management for http and stream.
servers:
- url: /api/9
tags:
- name: Workers
paths:
  /workers/:
    get:
      tags:
      - Workers
      summary: Return statistics for all worker processes
      description: Returns statistics for all worker processes such as accepted, dropped, active, idle connections, total and current requests.
      operationId: getWorkers
      parameters:
      - in: query
        name: fields
        description: Limits which fields of worker process statistics will be output.
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NginxWorkersMap'
        '404':
          description: 'Worker not found (*WorkerNotFound*),

            unknown version (*UnknownVersion*)

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NginxError'
    delete:
      tags:
      - Workers
      summary: 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
      responses:
        '204':
          description: Success
        '404':
          description: 'Worker not found (*WorkerNotFound*),

            unknown version (*UnknownVersion*)

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NginxError'
        '405':
          description: Method disabled (*MethodDisabled*)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NginxError'
  /workers/{workerId}:
    parameters:
    - name: workerId
      in: path
      description: The ID of the worker process.
      required: true
      schema:
        type: string
    get:
      tags:
      - Workers
      summary: Return status of a worker process
      description: Returns status of a particular worker process.
      operationId: getWorker
      parameters:
      - in: query
        name: fields
        description: Limits which fields of worker process statistics will be output.
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NginxWorker'
        '404':
          description: 'Worker not found (*WorkerNotFound*),

            unknown version (*UnknownVersion*)

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NginxError'
    delete:
      tags:
      - Workers
      summary: Reset statistics for a worker process
      description: 'Resets statistics of accepted, dropped, active, idle connections,

        as well as total and current requests.'
      operationId: deleteWorkerStat
      responses:
        '204':
          description: Success
        '404':
          description: 'Worker not found (*WorkerNotFound*),

            unknown version (*UnknownVersion*)

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NginxError'
        '405':
          description: Method disabled (*MethodDisabled*)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NginxError'
components:
  schemas:
    NginxWorkersMap:
      title: Worker processes
      description: nginx worker processes object.
      type: object
      additionalProperties:
        $ref: '#/components/schemas/NginxWorker'
      example:
      - id: 0
        pid: 32212
        connections:
          accepted: 1
          dropped: 0
          active: 1
          idle: 0
        http:
          requests:
            total: 19
            current: 1
      - id: 1
        pid: 32214
        connections:
          accepted: 1
          dropped: 0
          active: 1
          idle: 0
        http:
          requests:
            total: 15
            current: 0
    NginxWorker:
      title: Worker process
      description: 'Statistics per each worker process.

        '
      properties:
        id:
          type: integer
          description: The ID of the worker process.
        pid:
          type: integer
          description: The PID identifier of the worker process used by the operating system.
        connections:
          type: object
          description: 'The number of accepted, dropped, active, and idle connections

            per worker process.

            '
          properties:
            accepted:
              type: integer
              description: 'The total number of client connections

                accepted by the worker process.

                '
            dropped:
              type: integer
              description: 'The total number of client connections

                dropped by the worker process.

                '
            active:
              type: integer
              description: 'The current number of active client connections

                that are currently being handled by the worker process.

                '
            idle:
              type: integer
              description: 'The number of idle client connections

                that are currently being handled by the worker process.

                '
        http:
          type: object
          properties:
            requests:
              type: object
              description: The total number of client requests handled by the worker process.
              properties:
                total:
                  type: integer
                  description: The total number of client requests received by the worker process.
                current:
                  type: integer
                  description: The current number of client requests that are currently being processed by the worker process.
      example:
        id: 0
        pid: 32212
        connections:
          accepted: 1
          dropped: 0
          active: 1
          idle: 0
        http:
          requests:
            total: 15
            current: 1
    NginxError:
      title: Error
      description: 'nginx error object.

        '
      type: object
      properties:
        error:
          type: object
          properties:
            status:
              type: integer
              description: HTTP error code.
            text:
              type: string
              description: Error description.
            code:
              type: string
              description: Internal nginx error code.
        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.
        href:
          type: string
          description: Link to reference documentation.