Apache NiFi Flow API

openapi: 3.1.0
info:
  title: Apache NiFi REST Access Flow API
  version: 2.x
  description: 'A best-effort OpenAPI 3.1 description of selected endpoints from the Apache

    NiFi REST API. NiFi exposes a comprehensive JWT-authenticated REST API for

    managing processors, connections, controller services, process groups,

    reporting tasks, provenance, flow versions, system diagnostics, access

    control, parameter contexts, and data transfer. The canonical machine

    readable specification is published by the NiFi project as

    `/nifi-docs/swagger.yaml`.

    '
  contact:
    name: Apache NiFi
    url: https://nifi.apache.org/
  license:
    name: Apache-2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
servers:
- url: http://{host}:{port}/nifi-api
  description: Default NiFi REST API base URL
  variables:
    host:
      default: localhost
    port:
      default: '8080'
tags:
- name: Flow
  description: Read overall flow status and process group hierarchy
paths:
  /flow/process-groups/{id}/controller-services:
    parameters:
    - name: id
      in: path
      required: true
      schema:
        type: string
    post:
      tags:
      - Flow
      summary: Create a controller service within a process group
      operationId: createControllerService
      security:
      - bearerAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
      responses:
        '201':
          description: Controller service created
          content:
            application/json:
              schema:
                type: object
  /flow/status:
    get:
      tags:
      - Flow
      summary: Retrieve overall flow status
      operationId: getFlowStatus
      security:
      - bearerAuth: []
      responses:
        '200':
          description: Flow status snapshot
          content:
            application/json:
              schema:
                type: object
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: JWT issued by POST /access/token