NiFi REST API

Olga Semme

REST API allows using REST requests without using NiFi user interface to perform various operations, for example:

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:

  • setting the priority of the queue;

  • update destination connection.

Controller

Manage controller configuration, for example:

  • get the current configuration;

  • manage cluster;

  • сreate reporting tasks.

Controller Services

Manage controller services, update links to controller services

Counters

Manage event counters:

  • receive event counters;

  • reset event counters.

Data Transfer

Manage transactions, for example:

  • manage the lifetime of the transaction;

  • cancel the specified transaction;

  • send data;

  • receive data.

Flow

Manage flow configuration, for example:

  • receive data about the flow (for example, a list of created bulletins);

  • obtain data on the status of the flow components;

  • get the history of requests.

FlowFile Queues

Manage and retrieve dataflow queue configurations, for example:

  • view the contents of the queue;

  • download the contents of a flow file;

  • clean the queue.

Funnels

Manage funnels

Input Ports

Manage and retrieve input port configurations, for example:

  • create an input port;

  • control remote access to port.

Labels

Label management, for example:

  • create a label;

  • set a label style.

Output Ports

Manage and retrieve output port configurations, for example:

  • create an output port;

  • control remote access to port.

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:

  • create components;

  • create an instance of the template;

  • download template.

Processors

Manage and retrieve processor configurations, for example:

  • create and remove processors;

  • set the properties of the processor, including the schedule of the processor.

Policies

Manage and retrieve access policy data

Provenance

Manage data provenance:

  • request for provenance;

  • search for the provenance of data.

Provenance Events

Manage event provenance:

  • download the contents of the event;

  • replay content from an event of a given provenance.

Remote Process Groups

Manage and retrieve remote group configurations, for example:

  • create a remote group;

  • enable data transfer.

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:

  • obtain information about the NiFi instance required for communication (available ports);

  • obtain information about available peer network members and the status of their NiFi instance.

Snippets

Manage schema fragment:

  • move a fragment;

  • delete a fragment.

System Diagnostics

Obtain system diagnostics

Templates

Manage templates, for example:

  • download a template;

  • delete a template.

Tenants

Manage user groups (tenants):

  • add users;

  • create user groups.

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.
Found a mistake? Seleсt text and press Ctrl+Enter to report it