# Apache NiFi Controller API

**Canonical:** https://apis.io/apis/apache-nifi/apache-nifi-controller-api/  
**Provider:** Apache NiFi — https://apis.io/providers/apache-nifi/  
**Documentation:** https://nifi.apache.org/documentation/

Apache NiFi Controller API is one of 31 APIs that [Apache NiFi](https://apis.io/providers/apache-nifi/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Controller. The published artifact set on APIs.io includes an OpenAPI specification.

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

## Operations (46)

| Method | Path | Summary |
|---|---|---|
| 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 |

## Machine-readable artifacts (1)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/apache-nifi/refs/heads/main/openapi/apache-nifi-controller-api-openapi.yml

## Other Apache NiFi APIs (12)

- [Apache NiFi Registry](https://apis.io/apis/apache-nifi/apache-nifi-registry/)
- [Apache MiNiFi](https://apis.io/apis/apache-nifi/apache-minifi/)
- [Apache NiFi Access API](https://apis.io/apis/apache-nifi/apache-nifi-access-api/)
- [Apache NiFi Connections API](https://apis.io/apis/apache-nifi/apache-nifi-connections-api/)
- [Apache NiFi Controller Services API](https://apis.io/apis/apache-nifi/apache-nifi-controller-services-api/)
- [Apache NiFi Flow API](https://apis.io/apis/apache-nifi/apache-nifi-flow-api/)
- [Apache NiFi Authentication API](https://apis.io/apis/apache-nifi/apache-nifi-authentication-api/)
- [Apache NiFi Connectors API](https://apis.io/apis/apache-nifi/apache-nifi-connectors-api/)
- [Apache NiFi Counters API](https://apis.io/apis/apache-nifi/apache-nifi-counters-api/)
- [Apache NiFi Data Transfer API](https://apis.io/apis/apache-nifi/apache-nifi-datatransfer-api/)
- [Apache NiFi Flow File Queues API](https://apis.io/apis/apache-nifi/apache-nifi-flowfilequeues-api/)
- [Apache NiFi Funnels API](https://apis.io/apis/apache-nifi/apache-nifi-funnels-api/)

## Tags

Controller

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/apache-nifi/apache-nifi-controller-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/apache-nifi/.