Apache NiFi Connections API

openapi: 3.1.0
info:
  title: Apache NiFi REST Access Connections 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: Connections
  description: Manage connections between processors
paths:
  /connections/{id}:
    parameters:
    - name: id
      in: path
      required: true
      schema:
        type: string
    get:
      tags:
      - Connections
      summary: Retrieve a connection
      operationId: getConnection
      security:
      - bearerAuth: []
      responses:
        '200':
          description: Connection entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectionEntity'
        '404':
          description: Connection not found
    put:
      tags:
      - Connections
      summary: Update a connection
      operationId: updateConnection
      security:
      - bearerAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConnectionEntity'
      responses:
        '200':
          description: Updated connection entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectionEntity'
    delete:
      tags:
      - Connections
      summary: Delete a connection
      operationId: deleteConnection
      security:
      - bearerAuth: []
      parameters:
      - name: version
        in: query
        required: false
        schema:
          type: string
        description: Revision version for optimistic locking
      - name: clientId
        in: query
        required: false
        schema:
          type: string
      - name: disconnectedNodeAcknowledged
        in: query
        required: false
        schema:
          type: boolean
      responses:
        '200':
          description: Connection deleted
components:
  schemas:
    RevisionDTO:
      type: object
      properties:
        clientId:
          type: string
        version:
          type: integer
          format: int64
        lastModifier:
          type: string
    ConnectionEntity:
      type: object
      properties:
        id:
          type: string
        revision:
          $ref: '#/components/schemas/RevisionDTO'
        component:
          type: object
          description: Connection component (source, destination, selected relationships)
        status:
          type: object
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: JWT issued by POST /access/token