Apache NiFi

Apache NiFi Controller API

The Controller API from Apache NiFi — 34 operation(s) for controller.

GitHub OpenAPI

Operations 46

POST /controller/bulletin Creates a new bulletin #
GET /controller/cluster Gets the contents of the cluster #
DELETE /controller/cluster/nodes/{id} Removes a node from the cluster #
GET /controller/cluster/nodes/{id} Gets a node in the cluster #
PUT /controller/cluster/nodes/{id} Updates a node in the cluster #
GET /controller/config Retrieves the configuration for this NiFi Controller #
PUT /controller/config Updates the configuration for this NiFi #
POST /controller/controller-services Creates a new controller service #
GET /controller/flow-analysis-rules Gets all flow analysis rules #
POST /controller/flow-analysis-rules Creates a new flow analysis rule #
DELETE /controller/flow-analysis-rules/{id} Deletes a flow analysis rule #
GET /controller/flow-analysis-rules/{id} Gets a flow analysis rule #
PUT /controller/flow-analysis-rules/{id} Updates a flow analysis rule #
POST /controller/flow-analysis-rules/{id}/bulletins/clear-requests Clears bulletins for a flow analysis rule #
POST /controller/flow-analysis-rules/{id}/config/analysis Performs analysis of the component's configuration, providing information about… #
POST /controller/flow-analysis-rules/{id}/config/verification-requests Performs verification of the Flow Analysis Rule's configuration #
DELETE /controller/flow-analysis-rules/{id}/config/verification-requests/{requestId} Deletes the Verification Request with the given ID #
GET /controller/flow-analysis-rules/{id}/config/verification-requests/{requestId} Returns the Verification Request with the given ID #
GET /controller/flow-analysis-rules/{id}/descriptors Gets a flow analysis rule property descriptor #
PUT /controller/flow-analysis-rules/{id}/run-status Updates run status of a flow analysis rule #
GET /controller/flow-analysis-rules/{id}/state Gets the state for a flow analysis rule #
POST /controller/flow-analysis-rules/{id}/state/clear-requests Clears the state for a flow analysis rule #
DELETE /controller/history Purges history #
GET /controller/nar-manager/nars Retrieves summary information for installed NARs #
POST /controller/nar-manager/nars/content Uploads a NAR and requests for it to be installed #
DELETE /controller/nar-manager/nars/{id} Deletes an installed NAR #
GET /controller/nar-manager/nars/{id} Retrieves the summary information for the NAR with the given identifier #
GET /controller/nar-manager/nars/{id}/content Retrieves the content of the NAR with the given id #
GET /controller/nar-manager/nars/{id}/details Retrieves the component types available from the installed NARs #
POST /controller/parameter-providers Creates a new parameter provider #
POST /controller/parameter-providers/{id}/bulletins/clear-requests Clears bulletins for a parameter provider #
GET /controller/registry-clients Gets the listing of available flow registry clients #
POST /controller/registry-clients Creates a new flow registry client #
DELETE /controller/registry-clients/{id} Deletes a flow registry client #
GET /controller/registry-clients/{id} Gets a flow registry client #
PUT /controller/registry-clients/{id} Updates a flow registry client #
POST /controller/registry-clients/{id}/bulletins/clear-requests Clears bulletins for a registry client #
POST /controller/registry-clients/{id}/config/analysis Performs analysis of the component's configuration, providing information about… #
POST /controller/registry-clients/{id}/config/verification-requests Performs verification of the Registry Client's configuration #
DELETE /controller/registry-clients/{id}/config/verification-requests/{requestId} Deletes the Verification Request with the given ID #
GET /controller/registry-clients/{id}/config/verification-requests/{requestId} Returns the Verification Request with the given ID #
GET /controller/registry-clients/{id}/descriptors Gets a flow registry client property descriptor #
GET /controller/registry-types Retrieves the types of flow registry clients that this NiFi supports #
POST /controller/reporting-tasks Creates a new reporting task #
POST /controller/reporting-tasks/import Imports a reporting task snapshot #
GET /controller/status/history Gets status history for the node #

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/apache-nifi/refs/heads/main/openapi/apache-nifi-controller-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-controller-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

apache-nifi-controller-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 Controller API
  version: 2.12.0
security:
- HTTPBearerJWT: []
- CookieSecureAuthorizationBearer: []
tags:


# --- truncated at 32 KB (139 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/apache-nifi/refs/heads/main/openapi/apache-nifi-controller-api-openapi.yml