Apache NiFi

Apache NiFi Data Transfer API

The DataTransfer API from Apache NiFi — 5 operation(s) for datatransfer.

Documentation GitHub OpenAPI

Operations 7

DELETE /data-transfer/input-ports/{portId}/transactions/{transactionId} Commit or cancel the specified transaction #

PUT /data-transfer/input-ports/{portId}/transactions/{transactionId} Extend transaction TTL #

POST /data-transfer/input-ports/{portId}/transactions/{transactionId}/flow-files Transfer FlowFiles to the input port #

DELETE /data-transfer/output-ports/{portId}/transactions/{transactionId} Commit or cancel the specified transaction #

PUT /data-transfer/output-ports/{portId}/transactions/{transactionId} Extend transaction TTL #

GET /data-transfer/output-ports/{portId}/transactions/{transactionId}/flow-files Transfer FlowFiles from the output port #

POST /data-transfer/{portType}/{portId}/transactions Create a transaction to the specified output port or input port #

Specifications

⚙

OpenAPI

https://raw.githubusercontent.com/api-evangelist/apache-nifi/refs/heads/main/openapi/apache-nifi-datatransfer-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/apache-nifi:apache-nifi-datatransfer-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  contact:
    email: dev@nifi.apache.org
    url: https://nifi.apache.org
  description: REST API definition for Apache NiFi web services
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
  title: Apache NiFi REST Data Transfer API
  version: 2.12.0
security:
- HTTPBearerJWT: []
- CookieSecureAuthorizationBearer: []
tags:
- name: DataTransfer
paths:
  /data-transfer/input-ports/{portId}/transactions/{transactionId}:
    delete:
      operationId: commitInputPortTransaction
      parameters:
      - description: The response code. Available values are BAD_CHECKSUM(19), CONFIRM_TRANSACTION(12) or CANCEL_TRANSACTION(15).
        in: query
        name: responseCode
        required: true
        schema:
          type: integer
          format: int32
      - description: The input port id.
        in: path
        name: portId
        required: true
        schema:
          type: string
      - description: The transaction id.
        in: path
        name: transactionId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/octet-stream:
            schema:
              type: object
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TransactionResultEntity'
        '400':
          description: NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
        '401':
          description: Client could not be authenticated.
        '403':
          description: Client is not authorized to make this request.
        '404':
          description: The specified resource could not be found.
        '409':
          description: The request was valid but NiFi was not in the appropriate state to process it.
        '503':
          description: NiFi instance is not ready for serving request, or temporarily overloaded. Retrying the same request later may be successful
      security:
      - Write - /data-transfer/input-ports/{uuid}: []
      summary: Commit or cancel the specified transaction
      tags:
      - DataTransfer
    put:
      operationId: extendInputPortTransactionTTL
      parameters:
      - description: The input port id.
        in: path
        name: portId
        required: true
        schema:
          type: string
      - description: The transaction id.
        in: path
        name: transactionId
        required: true
        schema:
          type: string
      requestBody:
        content:
          '*/*':
            schema:
              type: object
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TransactionResultEntity'
        '400':
          description: NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
        '401':
          description: Client could not be authenticated.
        '403':
          description: Client is not authorized to make this request.
        '404':
          description: The specified resource could not be found.
        '409':
          description: The request was valid but NiFi was not in the appropriate state to process it.
      security:
      - Write - /data-transfer/input-ports/{uuid}: []
      summary: Extend transaction TTL
      tags:
      - DataTransfer
  /data-transfer/input-ports/{portId}/transactions/{transactionId}/flow-files:
    post:
      operationId: receiveFlowFiles
      parameters:
      - description: The input port id.
        in: path
        name: portId
        required: true
        schema:
          type: string
      - description: The transaction id.
        in: path
        name: transactionId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/octet-stream:
            schema:
              type: object
      responses:
        '202':
          content:
            text/plain:
              schema:
                type: string
        '400':
          description: NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
        '401':
          description: Client could not be authenticated.
        '403':
          description: Client is not authorized to make this request.
        '404':
          description: The specified resource could not be found.
        '409':
          description: The request was valid but NiFi was not in the appropriate state to process it.
        '503':
          description: NiFi instance is not ready for serving request, or temporarily overloaded. Retrying the same request later may be successful
      security:
      - Write - /data-transfer/input-ports/{uuid}: []
      summary: Transfer FlowFiles to the input port
      tags:
      - DataTransfer
  /data-transfer/output-ports/{portId}/transactions/{transactionId}:
    delete:
      operationId: commitOutputPortTransaction
      parameters:
      - description: The response code. Available values are CONFIRM_TRANSACTION(12) or CANCEL_TRANSACTION(15).
        in: query
        name: responseCode
        required: true
        schema:
          type: integer
          format: int32
      - description: A checksum calculated at client side using CRC32 to check flow file content integrity. It must match with the value calculated at server side.
        in: query
        name: checksum
        required: true
        schema:
          type: string
          default: ''
      - description: The output port id.
        in: path
        name: portId
        required: true
        schema:
          type: string
      - description: The transaction id.
        in: path
        name: transactionId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/octet-stream:
            schema:
              type: object
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TransactionResultEntity'
        '400':
          description: NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
        '401':
          description: Client could not be authenticated.
        '403':
          description: Client is not authorized to make this request.
        '404':
          description: The specified resource could not be found.
        '409':
          description: The request was valid but NiFi was not in the appropriate state to process it.
        '503':
          description: NiFi instance is not ready for serving request, or temporarily overloaded. Retrying the same request later may be successful
      security:
      - Write - /data-transfer/output-ports/{uuid}: []
      summary: Commit or cancel the specified transaction
      tags:
      - DataTransfer
    put:
      operationId: extendOutputPortTransactionTTL
      parameters:
      - description: The output port id.
        in: path
        name: portId
        required: true
        schema:
          type: string
      - description: The transaction id.
        in: path
        name: transactionId
        required: true
        schema:
          type: string
      requestBody:
        content:
          '*/*':
            schema:
              type: object
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TransactionResultEntity'
        '400':
          description: NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
        '401':
          description: Client could not be authenticated.
        '403':
          description: Client is not authorized to make this request.
        '404':
          description: The specified resource could not be found.
        '409':
          description: The request was valid but NiFi was not in the appropriate state to process it.
        '503':
          description: NiFi instance is not ready for serving request, or temporarily overloaded. Retrying the same request later may be successful
      security:
      - Write - /data-transfer/output-ports/{uuid}: []
      summary: Extend transaction TTL
      tags:
      - DataTransfer
  /data-transfer/output-ports/{portId}/transactions/{transactionId}/flow-files:
    get:
      operationId: transferFlowFiles
      parameters:
      - description: The output port id.
        in: path
        name: portId
        required: true
        schema:
          type: string
      - description: The transaction id.
        in: path
        name: transactionId
        required: true
        schema:
          type: string
      requestBody:
        content:
          '*/*':
            schema:
              type: object
      responses:
        '200':
          description: There is no flow file to return.
        '202':
          content:
            application/octet-stream:
              schema:
                $ref: '#/components/schemas/StreamingOutput'
        '400':
          description: NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
        '401':
          description: Client could not be authenticated.
        '403':
          description: Client is not authorized to make this request.
        '404':
          description: The specified resource could not be found.
        '409':
          description: The request was valid but NiFi was not in the appropriate state to process it.
        '503':
          description: NiFi instance is not ready for serving request, or temporarily overloaded. Retrying the same request later may be successful
      security:
      - Write - /data-transfer/output-ports/{uuid}: []
      summary: Transfer FlowFiles from the output port
      tags:
      - DataTransfer
  /data-transfer/{portType}/{portId}/transactions:
    post:
      operationId: createPortTransaction
      parameters:
      - description: The port type.
        in: path
        name: portType
        required: true
        schema:
          type: string
      - description: The input or output port id.
        in: path
        name: portId
        required: true
        schema:
          type: string
      requestBody:
        content:
          '*/*':
            schema:
              type: object
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TransactionResultEntity'
        '400':
          description: NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
        '401':
          description: Client could not be authenticated.
        '403':
          description: Client is not authorized to make this request.
        '404':
          description: The specified resource could not be found.
        '409':
          description: The request was valid but NiFi was not in the appropriate state to process it.
        '503':
          description: NiFi instance is not ready for serving request, or temporarily overloaded. Retrying the same request later may be successful
      security:
      - Write - /data-transfer/{component-type}/{uuid}: []
      summary: Create a transaction to the specified output port or input port
      tags:
      - DataTransfer
components:
  schemas:
    TransactionResultEntity:
      type: object
      properties:
        flowFileSent:
          type: integer
          format: int32
        message:
          type: string
        responseCode:
          type: integer
          format: int32
      xml:
        name: transactionResultEntity
    StreamingOutput:
      type: object
  securitySchemes:
    CookieSecureAuthorizationBearer:
      description: JSON Web Token authentication with session cookie
      in: cookie
      name: __Secure-Authorization-Bearer
      type: apiKey
    HTTPBearerJWT:
      bearerFormat: JWT
      description: HTTP Bearer authentication with JSON Web Token
      scheme: Bearer
      type: http
x-provenance:
  method: harvested
  publisher: Apache NiFi
  source: https://nifi.apache.org/nifi-docs/swagger.yaml
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)