NiFi REST API
REST API allows using REST requests without using NiFi user interface to perform various operations, for example:
-
work with attributes and parameters of the data flow;
-
monitoring of the stream and data flow elements;
-
configuration of the flow elements.
A description of the API groups provided in NiFi is given below.
API Group | Purpose |
---|---|
Access User |
Authentication and token endpoints |
Connections |
Manage and retrieve a connection configuration, for example:
|
Controller |
Manage controller configuration, for example:
|
Controller Services |
Manage controller services, update links to controller services |
Counters |
Manage event counters:
|
Data Transfer |
Manage transactions, for example:
|
Flow |
Manage flow configuration, for example:
|
FlowFile Queues |
Manage and retrieve dataflow queue configurations, for example:
|
Funnels |
Manage funnels |
Input Ports |
Manage and retrieve input port configurations, for example:
|
Labels |
Label management, for example:
|
Output Ports |
Manage and retrieve output port configurations, for example:
|
Parameter Contexts |
Create, delete, manage, and retrieve settings context configurations |
Parameter Providers |
Manage and retrieve parameter provider configurations |
Process Groups |
Manage and retrieve process group configurations, for example:
|
Processors |
Manage and retrieve processor configurations, for example:
|
Policies |
Manage and retrieve access policy data |
Provenance |
Manage data provenance:
|
Provenance Events |
Manage event provenance:
|
Remote Process Groups |
Manage and retrieve remote group configurations, for example:
|
Reporting Tasks |
Manage reporting tasks |
Resources |
Get available resources that support access/authorization policies |
Site to Site |
Get data for a "site to site" link:
|
Snippets |
Manage schema fragment:
|
System Diagnostics |
Obtain system diagnostics |
Templates |
Manage templates, for example:
|
Tenants |
Manage user groups (tenants):
|
Versions |
Manage version process groups |
NOTE
For a complete list of REST API available on NiFi, including requests and endpoints, see the /nifi-api article. |