Introduction

The NiFi REST API allows clients to obtain and update configuration and status information pertaining to an instance of NiFi. The links below detail each resource. Follow the link to get more information about the resource including the supported HTTP methods and the expected parameters.

Additionally, the documentation for each resource will describe what type of data should be returned from a successful invocation. However, if the request is not successful one of the follow status codes should be returned:

Most unsuccessful requests will include a description of the problem in the entity body of the response.

The context path for the REST API is /nifi-api

REST Resources

This API supports a Representational State Transfer (REST) model for accessing a set of resources through a fixed set of operations. The following resources are accessible through the RESTful model:

There is also a WADL document describing the REST API.

Data Model

All endpoints act on a common set of data. The data can be represented with difference media (i.e. "MIME") types, depending on the endpoint that consumes and/or produces the data. The data can described by XML Schema, which definitively describes the XML representation of the data, but is also useful for describing the other formats of the data, such as JSON.

This document will describe the data using terms based on XML Schema. Data can be grouped by namespace, with a schema document describing the elements and types of the namespace. Generally speaking, types define the structure of the data and elements are instances of a type. For example, elements are usually produced by (or consumed by) a REST endpoint, and the structure of each element is described by its type.

Namespace "ns0"

Namespace URI: (default namespace)
XSD: ns0.xsd

Data Elements

Data Types