Apache NiFi

Apache NiFi Flow API

Read overall flow status and process group hierarchy

GitHub OpenAPI

Operations 67

GET /flow/about Retrieves details about this NiFi to put in the About dialog #
GET /flow/additional-details/{group}/{artifact}/{version}/{type} Retrieves the additional details for the specified component type #
GET /flow/banners Retrieves the banners for this NiFi #
GET /flow/bulletin-board Gets current bulletins #
GET /flow/client-id Generates a client id #
GET /flow/cluster/search-results Searches the cluster for a node with the specified address #
GET /flow/cluster/summary The cluster summary for this NiFi #
GET /flow/config Retrieves the configuration for this NiFi flow #
GET /flow/connections/{id}/statistics Gets statistics for a connection #
GET /flow/connections/{id}/status Gets status for a connection #
GET /flow/connections/{id}/status/history Gets the status history for a connection #
GET /flow/connector-definition/{group}/{artifact}/{version}/{type} Retrieves the Connector Definition for the specified component type #
GET /flow/connector-types Retrieves the types of connectors that this NiFi supports #
GET /flow/connectors Gets all connectors #
GET /flow/content-viewers Retrieves the registered content viewers #
GET /flow/controller-service-definition/{group}/{artifact}/{version}/{type} Retrieves the Controller Service Definition for the specified component type #
GET /flow/controller-service-types Retrieves the types of controller services that this NiFi supports #
GET /flow/controller/bulletins Retrieves Controller level bulletins #
GET /flow/controller/controller-services Gets controller services for reporting tasks #
GET /flow/current-user Retrieves the user identity of the user making the request #
GET /flow/flow-analysis-rule-definition/{group}/{artifact}/{version}/{type} Retrieves the Flow Analysis Rule Definition for the specified component type #
GET /flow/flow-analysis-rule-types Retrieves the types of available Flow Analysis Rules #
GET /flow/flow-analysis/results Returns all flow analysis results currently in effect #
GET /flow/flow-analysis/results/{processGroupId} Returns flow analysis results produced by the analysis of a given process group #
GET /flow/flow-registry-client-definition/{group}/{artifact}/{version}/{type} Retrieves the Flow Registry Client Definition for the specified component type #
GET /flow/history Gets configuration history #
GET /flow/history/components/{componentId} Gets configuration history for a component #
GET /flow/history/{id} Gets an action #
GET /flow/input-ports/{id}/status Gets status for an input port #
GET /flow/listen-ports Gets all listen ports configured on this NiFi that the current user has access… #
GET /flow/metrics/{producer} Gets all metrics for the flow from a particular node #
GET /flow/output-ports/{id}/status Gets status for an output port #
GET /flow/parameter-contexts Gets all Parameter Contexts #
GET /flow/parameter-provider-definition/{group}/{artifact}/{version}/{type} Retrieves the Parameter Provider Definition for the specified component type #
GET /flow/parameter-provider-types Retrieves the types of parameter providers that this NiFi supports #
GET /flow/parameter-providers Gets all parameter providers #
GET /flow/prioritizers Retrieves the types of prioritizers that this NiFi supports #
GET /flow/process-groups/{id} Gets a process group #
PUT /flow/process-groups/{id} Schedule or unschedule components in the specified Process Group #
GET /flow/process-groups/{id}/breadcrumbs Gets the breadcrumbs for a process group #
POST /flow/process-groups/{id}/bulletins/clear-requests Clears bulletins for components in the specified Process Group #
GET /flow/process-groups/{id}/controller-services Gets all controller services #
PUT /flow/process-groups/{id}/controller-services Enable or disable Controller Services in the specified Process Group #
GET /flow/process-groups/{id}/status Gets the status for a process group #
GET /flow/process-groups/{id}/status/history Gets status history for a remote process group #
GET /flow/processor-definition/{group}/{artifact}/{version}/{type} Retrieves the Processor Definition for the specified component type #
GET /flow/processor-types Retrieves the types of processors that this NiFi supports #
GET /flow/processors/{id}/status Gets status for a processor #
GET /flow/processors/{id}/status/history Gets status history for a processor #
GET /flow/registries Gets the listing of available flow registry clients #
GET /flow/registries/{id}/branches Gets the branches from the specified registry for the current user #
GET /flow/registries/{id}/buckets Gets the buckets from the specified registry for the current user #
GET /flow/registries/{registry-id}/branches/{branch-id-a}/buckets/{bucket-id-a}/flows/{flow-id-a}/{version-a}/diff/branches/{branch-id-b}/buckets/{bucket-id-b}/flows/{flow-id-b}/{version-b} Gets the differences between two versions of the same versioned flow, the basis… #
GET /flow/registries/{registry-id}/buckets/{bucket-id}/flows Gets the flows from the specified registry and bucket for the current user #
GET /flow/registries/{registry-id}/buckets/{bucket-id}/flows/{flow-id}/details Gets the details of a flow from the specified registry and bucket for the… #
GET /flow/registries/{registry-id}/buckets/{bucket-id}/flows/{flow-id}/versions Gets the flow versions from the specified registry and bucket for the specified… #
GET /flow/remote-process-groups/{id}/status Gets status for a remote process group #
GET /flow/remote-process-groups/{id}/status/history Gets the status history #
GET /flow/reporting-task-definition/{group}/{artifact}/{version}/{type} Retrieves the Reporting Task Definition for the specified component type #
GET /flow/reporting-task-types Retrieves the types of reporting tasks that this NiFi supports #
GET /flow/reporting-tasks Gets all reporting tasks #
GET /flow/reporting-tasks/download Download a snapshot of the given reporting tasks and any controller services… #
GET /flow/reporting-tasks/snapshot Get a snapshot of the given reporting tasks and any controller services they use #
GET /flow/runtime-manifest Retrieves the runtime manifest for this NiFi instance #
GET /flow/search-results Performs a search against this NiFi using the specified search term #
GET /flow/status Gets the current status of this NiFi #
GET /flow/steps/{group}/{artifact}/{version}/{connectorType}/{stepName} Retrieves the step documentation for the specified Connector configuration step #

Documentation

📖
Documentation
https://nifi.apache.org/components/
📖
GettingStarted
https://nifi.apache.org/documentation/guides/

Specifications

⚙
OpenAPI
https://artifacts.apis.io/apache-nifi/openapi/apache-nifi-flow-api-openapi.yml

SDKs

📦
GitHubRepository
https://github.com/apache/nifi

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-flow-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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

apache-nifi-flow-api-openapi.yml Raw ↑ 
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 Flow API
  version: 2.12.0
security:
- HTTPBearerJWT: []
- CookieSecureAuthorizationBearer: []
tags:


# --- truncated at 32 KB (375 KB total) ---
# Full source: https://artifacts.apis.io/apache-nifi/openapi/apache-nifi-flow-api-openapi.yml