Nipyapi Documentation

Release 0.19.1

Daniel Chaffelson

Aug 08, 2022

 Contents

1 NiPyApi 3
1.1 Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
1.2 Quick Start . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
1.3 Background and Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
1.4 NiFi Version Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
1.5 Python Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4

2 Installation 7
2.1 Stable release . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
2.2 From sources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

3 NiPyApi Package Reference 9

3.1 Demos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
3.1.1 FDLC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
3.1.2 Console . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
3.1.3 Secured Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
3.1.4 bbende How Do I Deploy My Flow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
3.2 Client SDK modules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
3.2.1 Canvas . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
3.2.2 Config . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
3.2.3 Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
3.2.4 Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
3.2.5 System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
3.2.6 Templates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
3.2.7 Utils . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
3.2.8 Versioning . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
3.3 Swagger Client SDKs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
3.3.1 NiFi Swagger Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
3.3.1.1 Subpackages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
3.3.1.2 Submodules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 533
3.3.1.3 nipyapi.nifi.api_client module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 533
3.3.1.4 nipyapi.nifi.configuration module . . . . . . . . . . . . . . . . . . . . . . . . . . . 535
3.3.1.5 nipyapi.nifi.rest module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 536
3.3.2 NiFi-Registry Swagger Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 537
3.3.2.1 Subpackages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 537
3.3.2.2 Submodules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 619
3.3.2.3 nipyapi.registry.api_client module . . . . . . . . . . . . . . . . . . . . . . . . . . 619

i
 3.3.2.4 nipyapi.registry.configuration module . . . . . . . . . . . . . . . . . . . . . . . . . 621
3.3.2.5 nipyapi.registry.rest module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 621

4 ToDo 623

5 Contributing 625
5.1 Types of Contributions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 625
5.1.1 Report Bugs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 625
5.1.2 Fix Bugs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 625
5.1.3 Implement Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 625
5.1.4 Write Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 626
5.1.5 Submit Feedback . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 626
5.2 Get Started! . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 626
5.3 Pull Request Guidelines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 627

6 Development Notes 629

6.1 Decision Points . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 629
6.2 Testing Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 629
6.3 Docker Test Environment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 629
6.4 Remote Testing on Centos7 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 629
6.5 Testing on OSX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 630
6.6 Generate Swagger Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 630
6.6.1 NiFi Swagger Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 630
6.6.2 NiFi Registry Swagger Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 631
6.7 Release Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 631

7 Credits 633
7.1 Development Lead . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 633
7.2 Contributors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 633
7.3 Shout Outs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 633

8 History 635
8.1 0.19.1 (2022-08-08) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 635
8.2 0.19.0 (2022-05-13) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 635
8.3 0.18.0 (2021-11-29) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 636
8.4 0.17.1 (2021-10-21) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 636
8.5 0.17.0 (2021-10-13) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 636
8.6 0.16.3 (2021-10-11) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 636
8.7 0.16.2 (2021-02-10) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 636
8.8 0.16.3 (2021-10-11) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 637
8.9 0.16.2 (2021-02-10) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 638
8.10 0.15.0 (2020-11-06) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 638
8.11 0.14.0 (2019-11-06) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 639
8.12 0.13.3 (2019-10-09) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 639
8.13 0.13.0 (2019-04-22) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 639
8.14 0.12.0 (2018-12-20) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 639
8.15 0.11.0 (2018-10-12) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 640
8.16 0.10.3 (2018-08-28) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 640
8.17 0.10.2 (2018-08-27) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 641
8.18 0.10.1 (2018-08-21) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 641
8.19 0.10.0 (2018-08-03) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 641
8.20 0.9.1 (2018-05-18) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 641
8.21 0.9.0 (2018-05-16) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 641
8.22 0.8.0 (2018-03-06) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 642
8.23 0.7.0 (2018-01-30) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 643

ii
 8.24 0.6.1 (2018-01-04) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 644
8.25 0.6.0 (2017-12-31) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 644
8.26 0.5.1 (2017-12-07) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 644
8.27 0.5.0 (2017-12-06) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 644
8.28 0.4.0 (2017-10-29) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 644
8.29 0.3.2 (2017-09-04) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 645
8.30 0.3.1 (2017-09-04) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 645
8.31 0.3.0 (2017-09-04) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 645
8.32 0.2.1 (2017-08-26) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 645
8.33 0.2.0 (2017-08-25) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 645
8.34 0.1.2 (2017-08-24) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 645
8.35 0.1.1 (2017-08-24) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 646
8.36 0.1.0 (2017-08-24) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 646

9 Indices and tables 647

Python Module Index 649

Index 655

iii
iv
 Nipyapi Documentation, Release 0.19.1

Contents:

Contents 1
Nipyapi Documentation, Release 0.19.1

2 Contents
 CHAPTER 1

NiPyApi

Nifi-Python-Api: A rich Apache NiFi Python Client SDK

1.1 Features

Three layers of Python support for working with Apache NiFi:

• High-level Demos and example scripts
• Mid-level Client SDK for typical complex tasks
• Low-level Client SDKs for the full API implementation of NiFi and selected sub-projects
Functionality Highlights:
• Detailed documentation of the full SDK at all levels
• CRUD wrappers for common task areas like Processor Groups, Processors, Templates, Registry Clients,
Registry Buckets, Registry Flows, etc.
• Convenience functions for inventory tasks, such as recursively retrieving the entire canvas, or a flat list of
all Process Groups
• Support for scheduling and purging flows, controller services, and connections
• Support for fetching and updating Variable Registries
• Support for import/export of Versioned Flows from NiFi-Registry
• Docker Compose configurations for testing and deployment
• A scripted deployment of an interactive environment, and a secured configuration, for testing and demon-
stration purposes

3
Nipyapi Documentation, Release 0.19.1

Please see the issue register for more information on current development.

1.2 Quick Start

There are several scripts to produce demo environments in nipyapi.demo.*

The mid-level functionality is in nipyapi.canvas / nipyapi.security / nipyapi.templates / nipyapi.versioning
You can access the entire API using the low-level SDKs in nipyapi.nifi / nipyapi.registry

The easiest way to install NiPyApi is with pip:

# in bash
pip install nipyapi

You can set the config for your endpoints in the central config file:
# in python
import nipyapi
nipyapi.config.nifi_config.host = 'http://localhost:8080/nifi-api'
nipyapi.config.registry_config.host = 'http://localhost:18080/nifi-registry-api'

Then import a module and execute tasks:

nipyapi.canvas.get_root_pg_id()
>'4d5dcf9a-015e-1000-097e-e505ed0f7fd2'

You can use the Docker demos to create a secured interactive console showing many features:
from nipyapi.demo.secured_console import *
from nipyapi.demo.console import *

You can also explore the scripts to get ideas for how NiPyAPi can be used to automate your environment.
Please check out the Contribution Guide if you are interested in contributing to the feature set.

1.3 Background and Documentation

For more information on Apache NiFi, please visit https://nifi.apache.org

For Documentation on this package please visit https://nipyapi.readthedocs.io.

1.4 NiFi Version Support

Currently we are testing against NiFi versions 1.1.2 - 1.15.0, and NiFi-Registry versions 0.1.0 - 1.15.0.
If you find a version compatibility problem please raise an issue

1.5 Python Requirements

Python 2.7 or 3.6-9 supported, though other versions may work. We will shortly stop supporting Python2 There are
known issues on Python 3.10

4 Chapter 1. NiPyApi
 Nipyapi Documentation, Release 0.19.1

Tested on AL2 and OSX 10.14.x - Windows automated testing not attempted
Outside of the standard Python modules, we make use of lxml, DeepDiff, ruamel.yaml and xmltodict in processing,
and Docker for demo/tests.

1.5. Python Requirements 5

Nipyapi Documentation, Release 0.19.1

6 Chapter 1. NiPyApi
 CHAPTER 2

Installation

2.1 Stable release

To install Nipyapi, run this command in your terminal:

$ pip install nipyapi

This is the preferred method to install Nipyapi, as it will always install the most recent stable release.
If you don’t have pip installed, this Python installation guide can guide you through the process.

2.2 From sources

The sources for Nipyapi can be downloaded from the Github repo.
You can either clone the public repository:

$ git clone git://github.com/Chaffelson/nipyapi

Or download the tarball:

$ curl -OL https://github.com/Chaffelson/nipyapi/tarball/master

Once you have a copy of the source, you can install it with:

$ python setup.py install

7
Nipyapi Documentation, Release 0.19.1

8 Chapter 2. Installation
 CHAPTER 3

NiPyApi Package Reference

3.1 Demos

These modules leverage functionality within the rest of the Package to demonstrate various capabilities

3.1.1 FDLC

Importing this module provides further instructions for it’s use. It will guide you through the steps involved in flow
promotion.
Note that it makes extensive use of Docker Containers.
Usage:

from nipyapi.demo.fdlc import *

3.1.2 Console

Importing this module will run a script which populates the NiFi canvas with a Process Group containing a processor,
and creates a sequence of Versioned Flow Objects from it, along with a Template and various export versions.
This is intended to give the user a base set of objects to explore the API.
Usage:

from nipyapi.demo.console import *

3.1.3 Secured Connection

Importing this module will pull recent Docker containers from Dockerhub, deploy them in a secured configuration,
and prepare the environment for access via TLS in NiFi-Registry’s case, and public LDAP username/password for

9
Nipyapi Documentation, Release 0.19.1

NiFi.
This is intended to give the user an example of a secured environment. May be combined with the Console to produce
a secured environment with demo objects.
Note that this demo makes extensive use of Docker Containers.
Usage:

from nipyapi.demo.secured_connection import *

3.1.4 bbende How Do I Deploy My Flow

An incomplete version of BBende’s excellent demo. It currently deploys some Docker NiFi and Registry instances.

3.2 Client SDK modules

These wrapper modules contain collections of convenience functions for daily operations of your NiFi and NiFi-
Registry environment. They wrap and surface underlying data structures and calls to the full SDK swagger clients
which are also included in the package.

3.2.1 Canvas

For interactions with the NiFi Canvas.

nipyapi.canvas.get_root_pg_id()
Convenience function to return the UUID of the Root Process Group
Returns (str): The UUID of the root PG
nipyapi.canvas.recurse_flow(pg_id=’root’)
Returns information about a Process Group and all its Child Flows. Recurses the child flows by appending each
process group with a ‘nipyapi_extended’ parameter which contains the child process groups, etc. Note: This
previously used actual recursion which broke on large NiFi
environments, we now use a task/list update approach

Parameters pg_id (str) – The Process Group UUID

Returns enriched NiFi Flow object
Return type (ProcessGroupFlowEntity)

nipyapi.canvas.get_flow(pg_id=’root’)
Returns information about a Process Group and flow.
This surfaces the native implementation, for the recursed implementation see ‘recurse_flow’
Parameters pg_id (str) – id of the Process Group to retrieve, defaults to the root process group
if not set
Returns The Process Group object
Return type (ProcessGroupFlowEntity)

10 Chapter 3. NiPyApi Package Reference

 Nipyapi Documentation, Release 0.19.1

nipyapi.canvas.get_process_group_status(pg_id=’root’, detail=’names’)
Returns an entity containing the status of the Process Group. Optionally may be configured to return a simple
dict of name:id pairings
Note that there is also a ‘process group status’ command available, but it returns a subset of this data anyway,
and this call is more useful
Parameters
• pg_id (str) – The UUID of the Process Group
• detail (str) – ‘names’ or ‘all’; whether to return a simple dict of name:id pairings, or
the full details. Defaults to ‘names’
Returns The Process Group Entity including the status
Return type (ProcessGroupEntity)
nipyapi.canvas.get_process_group(identifier, identifier_type=’name’, greedy=True)
Filters the list of all process groups against a given identifier string occurring in a given identifier_type field.
Parameters
• identifier (str) – the string to filter the list for
• identifier_type (str) – the field to filter on, set in config.py
• greedy (bool) – True for partial match, False for exact match
Returns None for no matches, Single Object for unique match, list(Objects) for multiple matches
nipyapi.canvas.list_all_process_groups(pg_id=’root’)
Returns a flattened list of all Process Groups on the canvas. Potentially slow if you have a large canvas.
Note that the ProcessGroupsApi().get_process_groups(pg_id) command only provides the first layer of pgs,
whereas this trawls the entire canvas
Parameters pg_id (str) – The UUID of the Process Group to start from, defaults to the Canvas
root
Returns list[ProcessGroupEntity]
nipyapi.canvas.delete_process_group(process_group, force=False, refresh=True)
Deletes a given Process Group, with optional prejudice.
Parameters
• process_group (ProcessGroupEntity) – The target Process Group
• force (bool) – Stop, purge and clean the target Process Group before deletion. Experi-
mental.
• refresh (bool) – Whether to refresh the state first
Returns The updated object state
Return type (ProcessGroupEntity
nipyapi.canvas.schedule_process_group(process_group_id, scheduled)
Start or Stop a Process Group and all components.
Note that this doesn’t guarantee that all components have started, as some may be in Invalid states.
Parameters
• process_group_id (str) – The UUID of the target Process Group
• scheduled (bool) – True to start, False to stop

3.2. Client SDK modules 11

Nipyapi Documentation, Release 0.19.1

Returns True of successfully scheduled, False if not

Return type (bool)
nipyapi.canvas.create_process_group(parent_pg, new_pg_name, location, comment=”)
Creates a new Process Group with the given name under the provided parent Process Group at the given Location
Parameters
• parent_pg (ProcessGroupEntity) – The parent Process Group to create the new
process group in
• new_pg_name (str) – The name of the new Process Group
• location (tuple[x, y]) – the x,y coordinates to place the new Process Group under
the parent
• comment (str) – Entry for the Comments field
Returns The new Process Group
Return type (ProcessGroupEntity)
nipyapi.canvas.list_all_processors(pg_id=’root’)
Returns a flat list of all Processors under the provided Process Group
Parameters pg_id (str) – The UUID of the Process Group to start from, defaults to the Canvas
root
Returns list[ProcessorEntity]
nipyapi.canvas.list_all_processor_types()
Produces the list of all available processor types in the NiFi instance
Returns A native datatype containing the processors list
Return type list(ProcessorTypesEntity)
nipyapi.canvas.get_processor_type(identifier, identifier_type=’name’, greedy=True)
Gets the abstract object describing a Processor, or list thereof
Parameters
• identifier (str) – the string to filter the list for
• identifier_type (str) – the field to filter on, set in config.py
• greedy (bool) – False for exact match, True for greedy match
Returns None for no matches, Single Object for unique match, list(Objects) for multiple matches
nipyapi.canvas.create_processor(parent_pg, processor, location, name=None, config=None)
Instantiates a given processor on the canvas
Parameters
• parent_pg (ProcessGroupEntity) – The parent Process Group
• processor (DocumentedTypeDTO) – The abstract processor type object to be instan-
tiated
• location (tuple[x, y]) – The location coordinates
• name (Optional [str]) – The name for the new Processor
• config (Optional [ProcessorConfigDTO]) – A configuration object for the new
processor

12 Chapter 3. NiPyApi Package Reference

 Nipyapi Documentation, Release 0.19.1

Returns The new Processor

Return type (ProcessorEntity)
nipyapi.canvas.delete_processor(processor, refresh=True, force=False)
Deletes a Processor from the canvas, with optional prejudice.
Parameters
• processor (ProcessorEntity) – The processor to delete
• refresh (bool) – Whether to refresh the Processor state before action
• force (bool) – Whether to stop, purge and remove connections to the Processor before
deletion. Behavior may change in future releases.
Returns The updated ProcessorEntity
Return type (ProcessorEntity)
nipyapi.canvas.get_processor(identifier, identifier_type=’name’, greedy=True)
Filters the list of all Processors against the given identifier string in the given identifier_type field
Parameters
• identifier (str) – The String to filter against
• identifier_type (str) – The field to apply the filter to. Set in config.py
• greedy (bool) – Whether to exact match (False) or partial match (True)
Returns None for no matches, Single Object for unique match, list(Objects) for multiple matches
nipyapi.canvas.schedule_processor(processor, scheduled, refresh=True)
Set a Processor to Start or Stop.
Note that this doesn’t guarantee that it will change state, merely that it will be instructed to try. Some effort is
made to wait and see if the processor starts
Parameters
• processor (ProcessorEntity) – The Processor to target
• scheduled (bool) – True to start, False to stop
• refresh (bool) – Whether to refresh the object before action
Returns True for success, False for failure
Return type (bool)
nipyapi.canvas.get_funnel(funnel_id)
Gets a given Funnel by ID
nipyapi.canvas.update_processor(processor, update, refresh=True)
Updates configuration parameters for a given Processor.
An example update would be: nifi.ProcessorConfigDTO(scheduling_period=’3s’)
Parameters
• processor (ProcessorEntity) – The Processor to target for update
• update (ProcessorConfigDTO) – The new configuration parameters
• refresh (bool) – Whether to refresh the Processor object state before applying the up-
date
Returns The updated ProcessorEntity

3.2. Client SDK modules 13

Nipyapi Documentation, Release 0.19.1

Return type (ProcessorEntity)

nipyapi.canvas.get_variable_registry(process_group, ancestors=True)
Gets the contents of the variable registry attached to a Process Group
Parameters
• process_group (ProcessGroupEntity) – The Process Group to retrieve the Vari-
able Registry from
• ancestors (bool) – Whether to include the Variable Registries from child Process
Groups
Returns The Variable Registry
Return type (VariableRegistryEntity)
nipyapi.canvas.update_variable_registry(process_group, update, refresh=True)
Updates one or more key:value pairs in the variable registry
Parameters
• process_group (ProcessGroupEntity) – The Process Group which has the
• Registry to be updated (Variable) –
• update (list[tuple]) – The variables to write to the registry
• refresh (bool) – Whether to refresh the object revision before updating
Returns The created or updated Variable Registry Entries
Return type (VariableRegistryEntity)
nipyapi.canvas.purge_connection(con_id)
EXPERIMENTAL Drops all FlowFiles in a given connection. Waits until the action is complete before return-
ing.
Note that if upstream component isn’t stopped, more data may flow into the connection after this action.
Parameters con_id (str) – The UUID of the Connection to be purged
Returns The status reporting object for the drop request.
Return type (DropRequestEntity)
nipyapi.canvas.purge_process_group(process_group, stop=False)
EXPERIMENTAL Purges the connections in a given Process Group of FlowFiles, and optionally stops it first
Parameters
• process_group (ProcessGroupEntity) – Target Process Group
• stop (Optional [bool]) – Whether to stop the Process Group before action
Returns True|False}]): Result set. A list of Dicts of
Return type (list[dict{ID
Connection IDs mapped to True or False for success of each connection
nipyapi.canvas.schedule_components(pg_id, scheduled, components=None)
Changes the scheduled target state of a list of components within a given Process Group.
Note that this does not guarantee that components will be Started or Stopped afterwards, merely that they will
have their scheduling updated.
Parameters

14 Chapter 3. NiPyApi Package Reference

 Nipyapi Documentation, Release 0.19.1

• pg_id (str) – The UUID of the parent Process Group

• scheduled (bool) – True to start, False to stop
• components (list[ComponentType]) – The list of Component Entities to schdule,
e.g. ProcessorEntity’s
Returns True for success, False for not
Return type (bool)
nipyapi.canvas.get_bulletins()
Retrieves current bulletins (alerts) from the Flow Canvas
Returns The native datatype containing a list
Return type (ControllerBulletinsEntity)
of bulletins
nipyapi.canvas.get_bulletin_board()
Retrieves the bulletin board object
Returns The native datatype BulletinBoard object
Return type (BulletinBoardEntity)
nipyapi.canvas.list_invalid_processors(pg_id=’root’, summary=False)
Returns a flattened list of all Processors with Invalid Statuses
Parameters
• pg_id (str) – The UUID of the Process Group to start from, defaults to the Canvas root
• summary (bool) – True to return just the list of relevant properties per Processor, False
for the full listing
Returns list[ProcessorEntity]
nipyapi.canvas.list_sensitive_processors(pg_id=’root’, summary=False)
Returns a flattened list of all Processors on the canvas which have sensitive properties that would need to be
managed during deployment
Parameters
• pg_id (str) – The UUID of the Process Group to start from, defaults to the Canvas root
• summary (bool) – True to return just the list of relevant properties per Processor, False
for the full listing
Returns list[ProcessorEntity] or list(dict)
nipyapi.canvas.list_all_connections(pg_id=’root’, descendants=True)
Lists all connections for a given Process Group ID
Parameters
• pg_id (str) – ID of the Process Group to retrieve Connections from
• descendants (bool) – True to recurse child PGs, False to not
Returns List of ConnectionEntity objects
Return type (list)
nipyapi.canvas.create_connection(source, target, relationships=None, name=None)
Creates a connection between two objects for the given relationships

3.2. Client SDK modules 15

Nipyapi Documentation, Release 0.19.1

Parameters
• source – Object to initiate the connection, e.g. ProcessorEntity
• target – Object to terminate the connection, e.g. FunnelEntity
• relationships (list) – list of strings of relationships to connect, may be collected
from the object ‘relationships’ property (optional)
• name (str) – Defaults to None, String of Name for Connection (optional)
Returns for the created connection
Return type (ConnectionEntity)
nipyapi.canvas.delete_connection(connection, purge=False)
Deletes a connection, optionally purges it first
Parameters
• connection (ConnectionEntity) – Connection to delete
• purge (bool) – True to Purge, Defaults to False
Returns the modified Connection
Return type (ConnectionEntity)
nipyapi.canvas.get_component_connections(component)
Returns list of Connections related to a given Component, e.g. Processor
Parameters component – Component Object to filter by, e.g. a ProcessorEntity
Returns List of ConnectionEntity Objects
Return type (list)
nipyapi.canvas.create_controller(parent_pg, controller, name=None)
Creates a new Controller Service in a given Process Group of the given Controller type, with the given
Name

Parameters
• parent_pg (ProcessGroupEntity) – Target Parent PG
• controller (DocumentedTypeDTO) – Type of Controller to create, found via the
list_all_controller_types method
• name (str[Optional]) – Name for the new Controller as a String
Returns (ControllerServiceEntity)

nipyapi.canvas.list_all_controllers(pg_id=’root’, descendants=True)
Lists all controllers under a given Process Group, defaults to Root Optionally recurses all child Process
Groups as well

Parameters
• pg_id (str) – String of the ID of the Process Group to list from
• descendants (bool) – True to recurse child PGs, False to not
Returns None, ControllerServiceEntity, or list(ControllerServiceEntity)

16 Chapter 3. NiPyApi Package Reference

 Nipyapi Documentation, Release 0.19.1

nipyapi.canvas.delete_controller(controller, force=False)
Delete a Controller service, with optional prejudice
Parameters
• controller (ControllerServiceEntity) – Target Controller to delete
• force (bool) – True to attempt Disable the Controller before deletion
Returns (ControllerServiceEntity)
nipyapi.canvas.update_controller(controller, update)
Updates the Configuration of a Controller Service
Parameters
• controller (ControllerServiceEntity) – Target Controller to update
• update (ControllerServiceDTO) – Controller Service configuration object contain-
ing the new config params and properties
Returns (ControllerServiceEntity)
nipyapi.canvas.schedule_controller(controller, scheduled, refresh=False)
Start/Enable or Stop/Disable a Controller Service
Parameters
• controller (ControllerServiceEntity) – Target Controller to schedule
• scheduled (bool) – True to start, False to stop
• refresh (bool) – Whether to refresh the component revision before execution
Returns (ControllerServiceEntity)
nipyapi.canvas.get_controller(identifier, identifier_type=’name’, bool_response=False)
Retrieve a given Controller
Parameters
• identifier (str) – ID or Name of a Controller to find
• identifier_type (str) – ‘id’ or ‘name’, defaults to name
• bool_response (bool) – If True, will return False if the Controller is not found - useful
when testing for deletion completion
Returns:
nipyapi.canvas.list_all_controller_types()
Lists all Controller Service types available on the environment
Returns list(DocumentedTypeDTO)
nipyapi.canvas.list_all_by_kind(kind, pg_id=’root’, descendants=True)
Retrieves a list of all instances of a supported object type
Parameters
• kind (str) – one of input_ports, output_ports, funnels, controllers, connections, re-
mote_process_groups
• pg_id (str) – optional, ID of the Process Group to use as search base
• descendants (bool) – optional, whether to collect child group info
Returns list of the Entity type of the kind, or single instance, or None

3.2. Client SDK modules 17

Nipyapi Documentation, Release 0.19.1

nipyapi.canvas.list_all_input_ports(pg_id=’root’, descendants=True)
Convenience wrapper for list_all_by_kind for input ports
nipyapi.canvas.list_all_output_ports(pg_id=’root’, descendants=True)
Convenience wrapper for list_all_by_kind for output ports
nipyapi.canvas.list_all_funnels(pg_id=’root’, descendants=True)
Convenience wrapper for list_all_by_kind for funnels
nipyapi.canvas.list_all_remote_process_groups(pg_id=’root’, descendants=True)
Convenience wrapper for list_all_by_kind for remote process groups
nipyapi.canvas.delete_funnel(funnel, refresh=True)
Deletes a Funnel Object
Parameters
• funnel (FunnelEntity) – The Funnel to delete
• refresh (bool) – Whether to refresh the object state before execution
Returns (FunnelEntity) Deleted FunnelEntity reference
nipyapi.canvas.get_remote_process_group(rpg_id, summary=False)
Fetch a remote process group object, with optional summary of just ports
nipyapi.canvas.update_process_group(pg, update, refresh=True)
Updates a given Process Group.
Parameters
• pg (ProcessGroupEntity) – The Process Group to target for update
• update (dict) – key:value pairs to update
• refresh (bool) – Whether to refresh the Process Group before applying the update
Returns The updated ProcessorEntity
Return type (ProcessGroupEntity)
nipyapi.canvas.create_funnel(pg_id, position=None)
Creates a Funnel Object
Parameters
• pg_id (str) – ID of the parent Process Group
• position (tuple[int, int]) – Position on canvas
Returns (FunnelEntity) Created Funnel
nipyapi.canvas.create_remote_process_group(target_uris, transport=’RAW’, pg_id=’root’,
position=None)
Creates a new Remote Process Group with given parameters
Parameters
• target_uris (str) – Comma separated list of target URIs
• transport (str) – optional, RAW or HTTP
• pg_id (str) – optional, UUID of parent Process Group for remote process group
• position (tuple) – optional, tuple of location ints
Returns (RemoteProcessGroupEntity)

18 Chapter 3. NiPyApi Package Reference

 Nipyapi Documentation, Release 0.19.1

nipyapi.canvas.delete_remote_process_group(rpg, refresh=True)
Deletes a given remote process group
Parameters
• rpg (RemoteProcessGroupEntity) – Remote Process Group to remove
• refresh (bool) – Whether to refresh the object before action
Returns (RemoteProcessGroupEntity)
nipyapi.canvas.set_remote_process_group_transmission(rpg, enable=True, re-
fresh=True)
Enable or Disable Transmission for an RPG
Parameters
• rpg (RemoteProcessGroupEntity) – The ID of the remote process group to modify
• enable (bool) – True to enable, False to disable
• refresh (bool) – Whether to refresh the object before action
Returns:
nipyapi.canvas.get_pg_parents_ids(pg_id)
Retrieve the ids of the parent Process Groups.
Parameters pg_id (str) – Process group id
Returns (list) List of ids of the input PG parents
nipyapi.canvas.delete_port(port)
Deletes a given port from the canvas if possible
nipyapi.canvas.create_port(pg_id, port_type, name, state, position=None)
Creates a new input or output port of given characteristics
Parameters
• pg_id (str) – ID of the parent Process Group
• port_type (str) – Either of INPUT_PORT or OUTPUT_PORT
• name (str) – optional, Name to assign to the port
• state (str) – One of RUNNING, STOPPED, DISABLED
• position (tuple) – optional, tuple of ints like (400, 400)
Returns (PortEntity) of the created port

3.2.2 Config

A set of defaults and parameters used elsewhere in the project. Also provides a handy link to the low-level client SDK
configuration singleton objects.

3.2.3 Parameters

For Managing NiFi Parameter Contexts

nipyapi.parameters.list_all_parameter_contexts()
Lists all Parameter Contexts available on the Canvas

3.2. Client SDK modules 19

Nipyapi Documentation, Release 0.19.1

Returns list(ParameterContextEntity)
nipyapi.parameters.create_parameter_context(name, description=None, parameters=None,
inherited_contexts=None)
Create a new Parameter Context with optional description and initial Parameters

Parameters
• name (str) – The Name for the new Context
• description (str) – An optional description
• parameters (list[ParameterEntity]) – A list of prepared Parameters
• inherited_contexts (list[ParameterContextEntity]) – A list of inherited
Parameter Contexts
Returns (ParameterContextEntity) The New Parameter Context

nipyapi.parameters.delete_parameter_context(context, refresh=True)
Removes a Parameter Context
Parameters
• context (ParameterContextEntity) – Parameter Context to be deleted
• refresh (bool) – Whether to refresh the Context before Deletion
Returns (ParameterContextEntity) The removed Parameter Context
nipyapi.parameters.get_parameter_context(identifier, identifier_type=’name’, greedy=True)
Gets one or more Parameter Contexts matching a given identifier
Parameters
• identifier (str) – The Name or ID matching Parameter Context(s)
• identifier_type (str) – ‘name’ or ‘id’
• greedy (bool) – False for exact match, True for string match
Returns None for no matches, Single Object for unique match, list(Objects) for multiple matches
nipyapi.parameters.update_parameter_context(context)
Update an already existing Parameter Context
Parameters
• context (ParameterContextEntity) – Parameter Context updated to be applied
• refresh (bool) – Whether to refresh the object before Updating
Returns (ParameterContextEntity) The updated Parameter Context
nipyapi.parameters.prepare_parameter(name, value, description=None, sensitive=False)
Parses basic inputs into a Parameter object ready for submission
Parameters
• name (str) – The Name for the Parameter
• value (str, int, float) – The Value for the Parameter
• description (str) – Optional Description for the Parameter
• sensitive (bool) – Whether to mark the Parameter Value as sensitive
Returns (ParameterEntity) The ParameterEntity ready for use

20 Chapter 3. NiPyApi Package Reference

 Nipyapi Documentation, Release 0.19.1

nipyapi.parameters.delete_parameter_from_context(context, parameter_name)
Delete a specific Parameter from a Parameter Context :param context: The Parameter Context to Update :type
context: ParameterContextEntity :param parameter_name: The Parameter to delete :type parameter_name: str
Returns (ParameterContextEntity) The updated Parameter Context
nipyapi.parameters.upsert_parameter_to_context(context, parameter)
Insert or Update Parameter within a Parameter Context
Parameters
• context (ParameterContextEntity) – The Parameter Context to Modify
• parameter (ParameterEntity) – The ParameterEntity to insert or update
Returns (ParameterContextEntity) The updated Parameter Context
nipyapi.parameters.assign_context_to_process_group(pg, context_id, cascade=False)
Assigns a given Parameter Context to a specific Process Group Optionally cascades down to direct children
Process Groups
Parameters
• pg (ProcessGroupEntity) – The Process Group to target
• context_id (str) – The ID of the Parameter Context
• cascade (bool) – Cascade Parameter Context down to child Process Groups?
Returns (ProcessGroupEntity) The updated Process Group
nipyapi.parameters.remove_context_from_process_group(pg)
Clears any Parameter Context from the given Process Group
Parameters pg (ProcessGroupEntity) – The Process Group to target
Returns (ProcessGroupEntity) The updated Process Group

3.2.4 Security

Secure connectivity management for NiPyApi

nipyapi.security.create_service_user(identity, service=’nifi’, strict=True)
Attempts to create a user with the provided identity in the given service
Parameters
• identity (str) – Identity string for the user
• service (str) – ‘nifi’ or ‘registry’
• strict (bool) – If Strict, will error if user already exists
Returns The new (User) or (UserEntity) object
nipyapi.security.create_service_user_group(identity, service=’nifi’, users=None,
strict=True)
Attempts to create a user with the provided identity and member users in the given service
Parameters
• identity (str) – Identity string for the user group
• service (str) – ‘nifi’ or ‘registry’
• users (list) – A list of nifi.UserEntity or registry.User belonging to the group

3.2. Client SDK modules 21

Nipyapi Documentation, Release 0.19.1

• strict (bool) – Whether to throw an error on already exists

Returns The new (UserGroup) or (UserGroupEntity) object
nipyapi.security.set_service_auth_token(token=None, token_name=’tokenAuth’, ser-
vice=’nifi’)
Helper method to set the auth token correctly for the specified service
Parameters
• token (Optional[str]) – The token to set. Defaults to None.
• token_name (str) – the api_key field name to set the token to. Defaults to ‘tokenAuth’
• service (str) – ‘nifi’ or ‘registry’, the service to set
Returns True on success, False if token not set
Return type (bool)
nipyapi.security.service_logout(service=’nifi’)
Logs out from the service by resetting the token :param service: ‘nifi’ or ‘registry’; the target service :type
service: str
Returns True of access removed, False if still set
Return type (bool)
nipyapi.security.get_service_access_status(service=’nifi’, bool_response=False)
Gets the access status for the current session
Parameters
• service (str) – A String of ‘nifi’ or ‘registry’ to indicate which service to check status
for
• bool_response (bool) – If True, the function will return False on hitting an Error
instead of raising it. Useful for connection testing.
Returns (bool) if bool_response, else the Service Access Status of the User
nipyapi.security.add_user_to_access_policy(user, policy, service=’nifi’, refresh=True,
strict=True)
Attempts to add the given user object to the given access policy
Parameters
• user (User) or (UserEntity) – User object to add
• policy (AccessPolicyEntity) or (AccessPolicy) – Access Policy object
• service (str) – ‘nifi’ or ‘registry’ to identify the target service
• refresh (bool) – Whether to refresh the policy object before submit
• strict (bool) – If True, will return error if user already present, if False will ignore the
already exists
Returns Updated Policy object
nipyapi.security.update_access_policy(policy, service=’nifi’)
Applies an updated access policy to the service indicated
Parameters
• policy (PolicyEntity) – The policy object to submit
• service (str) – ‘nifi’ or ‘registry’ to indicate the target service

22 Chapter 3. NiPyApi Package Reference

 Nipyapi Documentation, Release 0.19.1

Returns The updated policy if successful

Return type (PolicyEntity)
nipyapi.security.get_access_policy_for_resource(resource, action, r_id=None, ser-
vice=’nifi’, auto_create=False)
Attempts to retrieve the access policy for a given resource and action, and optionally resource_id if targeting
NiFi. Optionally creates the policy if it doesn’t already exist
Parameters
• resource (str) – A valid resource in the target service
• action (str) – A valid action, typically ‘read’, ‘write’ or ‘delete’
• r_id (Optional[str]) – The UUID of the resource, valid only if targeting NiFi re-
sources
• service (str) – Which service to target, typically ‘nifi’ or ‘registry’
• auto_create (bool) – Whether to create the targeted policy if it doesn’t already exist
Returns The relevant AccessPolicy object
nipyapi.security.create_access_policy(resource, action, r_id=None, service=’nifi’)
Creates an access policy for the given resource, action and optionally resource_id for NiFi.
Parameters
• resource (str) – a valid resource type for this service, e.g. ‘bucket’
• action (str) – a valid action type for this service, typically ‘read’, ‘write’ or ‘delete’
• r_id (optional[str]) – if NiFi, the resource ID of the resource
• service (str) – the service to target
Returns An access policy object for that service
nipyapi.security.list_service_users(service=’nifi’)
Lists all users of a given service, takes a service name as a string
nipyapi.security.get_service_user(identifier, identifier_type=’identity’, service=’nifi’)
Gets the unique user matching to the given identifier and type.
Parameters
• identifier (str) – the string to search for
• identifier_type (str) – the field to search in
• service (str) – the name of the service
Returns None if no match, else single object
nipyapi.security.set_service_ssl_context(service=’nifi’, ca_file=None,
client_cert_file=None, client_key_file=None,
client_key_password=None,
check_hostname=None)
Create an SSLContext for connecting over https to a secured NiFi or NiFi-Registry instance.
This method can be used to create an SSLContext for two-way TLS in which a client cert is used by the service
to authenticate the client.
This method can also be used for one-way TLS in which the client verifies the server’s certificate, but authenti-
cates using a different form of credentials, such as LDAP username/password.

3.2. Client SDK modules 23

Nipyapi Documentation, Release 0.19.1

If you are using one-way TLS with a certificate signed by a root CA trusted by your system/platform, this step
is not necessary as the default TLS-handshake should “just work.”
Parameters
• service (str) – ‘nifi’ or ‘registry’ to indicate which service config to set the ssl context
to
• ca_file (str) – A PEM file containing certs for the root CA(s) for the NiFi Registry
server
• client_cert_file (str) – A PEM file containing the public certificates for the
user/client identity
• client_key_file (str) – An encrypted (password-protected) PEM file containing the
client’s secret key
• client_key_password (str) – The password to decrypt the client_key_file
• check_hostname (bool) – Enable or Disable hostname checking
Returns (None)
nipyapi.security.add_user_group_to_access_policy(user_group, policy, service=’nifi’, re-
fresh=True)
Attempts to add the given user group object to the given access policy
Parameters
• user_group (UserGroup) or (UserGroupEntity) – User group object to add
• policy (AccessPolicyEntity) or (AccessPolicy) – Access Policy object
• service (str) – ‘nifi’ or ‘registry’ to identify the target service
• refresh (bool) – Whether to refresh the policy object before submission
Returns Updated Policy object
nipyapi.security.bootstrap_security_policies(service, user_identity=None,
group_identity=None)
Creates a default security context within NiFi or Nifi-Registry
Parameters
• service (str) – ‘nifi’ or ‘registry’ to indicate which service
• user_identity – a service user to establish in the security context
• group_identity – a service group to establish in the security context
Returns None
nipyapi.security.service_login(service=’nifi’, username=None, password=None,
bool_response=False)
Login to the currently configured NiFi or NiFi-Registry server.
Login requires a secure connection over https. Prior to calling this method, the host must be specified and the
SSLContext should be configured (if necessary).
Successful login will result in a generated token (JWT) being cached in the api_client config that will be passed
in all future REST API calls. To clear that token, call service_logout.
The token is temporary and will expire after a duration set by the server. After a token expires, you must call
this method again to generate a new token.
Parameters

24 Chapter 3. NiPyApi Package Reference

 Nipyapi Documentation, Release 0.19.1

• service (str) – ‘nifi’ or ‘registry’; the service to login to

• username (str) – The username to submit
• password (str) – The password to use
• bool_response (bool) – If True, the function will return False instead of an error.
Useful for connection testing.
Returns True if successful, False or an Error if not. See bool_response
Return type (bool)
nipyapi.security.remove_service_user(user, service=’nifi’, strict=True)
Removes a given User from the given Service
Parameters
• user – [(nifi.UserEntity), (registry.User)] Target User object
• service (str) – ‘nifi’ or ‘registry’
• strict (bool) – Whether to throw an error if User not found
Returns Updated User Entity or None
nipyapi.security.list_service_user_groups(service=’nifi’)
Returns list of service user groups for a given service :param service: ‘nifi’ or ‘registry’ :type service: str
Returns [(nifi.UserGroupEntity, registry.UserGroup)]
nipyapi.security.get_service_user_group(identifier, identifier_type=’identity’, ser-
vice=’nifi’)
Gets the unique group matching to the given identifier and type.
Parameters
• identifier (str) – the string to search for
• identifier_type (str) – the field to search in, identity or id
• service (str) – the name of the service
Returns None if no match, else single object
nipyapi.security.remove_service_user_group(group, service=’nifi’, strict=True)
Removes a given User Group from the given Service
Parameters
• group – [(nifi.UserEntity), (registry.User)] Target User object
• service (str) – ‘nifi’ or ‘registry’
• strict (bool) – Whether to throw an error if User not found
Returns Updated User Group or None

3.2.5 System

For system and cluster level functions interacting with the underlying NiFi Services
nipyapi.system.get_system_diagnostics()
Returns NiFi Sytems diagnostics page
Returns (json):

3.2. Client SDK modules 25

Nipyapi Documentation, Release 0.19.1

nipyapi.system.get_cluster()
EXPERIMENTAL Returns the contents of the NiFi cluster
Returns (json):
nipyapi.system.get_node(nid)
Returns the cluster node information
Parameters nid (str) – The UUID of the Node to target
Returns:
nipyapi.system.get_nifi_version_info()
Returns the version information of the connected NiFi instance
Returns (VersionInfoDTO):

3.2.6 Templates

For Managing NiFi Templates

nipyapi.templates.list_all_templates(native=True)
Gets a list of all templates on the canvas
Returns A list of TemplateEntity’s
Return type (list[TemplateEntity])
nipyapi.templates.get_template_by_name(name)
DEPRECATED Returns a specific template by name, if it exists.
Note: This function is replaced by get_template
Parameters name (str) – The Name of the template, exact match required
Returns (TemplateEntity)
nipyapi.templates.deploy_template(pg_id, template_id, loc_x=0.0, loc_y=0.0)
Instantiates a given template request in a given process group
Parameters
• pg_id (str) – The UUID of the Process Group to deploy into
• template_id (str) – The UUID of the Template to deploy. Note that the Template must
already be uploaded and available to the target Process Group
• loc_x (float) – The X coordinate to deploy the Template at. Default(0.0)
• loc_y (float) – The X coordinate to deploy the Template at. Default(0.0)
Returns
The FlowEntity of the Process Group with the deployed template
Return type (FlowEntity)
nipyapi.templates.upload_template(pg_id, template_file)
Uploads a given template xml from from the file system to the given Process Group
Parameters
• pg_id (str) – The UUID of the Process Group to upload to
• template_file (str) – The path including filename to the template file
Returns The new Template object

26 Chapter 3. NiPyApi Package Reference

 Nipyapi Documentation, Release 0.19.1

Return type (TemplateEntity)

nipyapi.templates.create_pg_snippet(pg_id)
Creates a snippet of the targeted process group, and returns the object ready to be turned into a Template
Parameters pg_id – UUID of the process Group to snippet
Returns The Snippet Object
Return type (SnippetEntity)
nipyapi.templates.create_template(pg_id, name, desc=”)
Creates a Template from a Process Group
Parameters
• pg_id (str) – The UUID of the target Process Group
• name (str) – The name for the new Template. Must be unique
• desc (optional[str]) – The description for the new Template
Returns The newly created Template
Return type (TemplateEntity)
nipyapi.templates.delete_template(t_id)
Deletes a Template
Parameters t_id (str) – UUID of the Template to be deleted
Returns The updated Template object
nipyapi.templates.export_template(t_id, output=’string’, file_path=None)
Exports a given Template as either a string or a file.
Note that to reimport the Template it must be a file
Parameters
• t_id (str) – The UUID of the Template to export
• output (str) – ‘string’ or ‘file’ to set the export action
• file_path (Optional [str]) – The full path including filename to write the Tem-
plate export to
Returns
A String representation of the exported Template XML. Note that this may not be utf-8 en-
coded.
Return type (str)
nipyapi.templates.get_template(identifier, identifier_type=’name’, greedy=False)
Filters the list of all Templates for a given string in a given field. Note that filters are configured in config.py
Parameters
• identifier (str) – The string to filter on
• identifier_type (str) – The identifier of the field to filter on
• greedy (bool) – True for greedy match, False for exact match
Returns None for no matches, Single Object for unique match, list(Objects) for multiple matches
nipyapi.templates.load_template_from_xml_file_path(file_path)
Loads a TemplateEntity from an xml file for a given path

3.2. Client SDK modules 27

Nipyapi Documentation, Release 0.19.1

Parameters file_path (str) – path to the xml file

Returns TemplateEntity
nipyapi.templates.load_template_from_xml_file_stream(file_stream)
Loads a TemplateEntity from a template xml file
Parameters file_stream (io stream) – the xml file stream as returned by open
Returns TemplateEntity
nipyapi.templates.load_template_from_xml_string(xml_string)
Loads a TemplateEntity from xml string, as if you had read in the xml file to string
Parameters xml_string (str) – string of xml
Returns TemplateEntity

3.2.7 Utils

Convenience utility functions for NiPyApi, not really intended for external use
nipyapi.utils.dump(obj, mode=’json’)
Dumps a native datatype object or swagger entity to json or yaml defaults to json

Parameters
• obj (varies) – The native datatype object or swagger type to serialise
• mode (str) – ‘json’ or ‘yaml’, the supported export modes

Returns (str): The serialised object

nipyapi.utils.load(obj, dto=None)
Loads a serialised object back into native datatypes, and optionally imports it back into the native NiFi DTO
Warning: Using this on objects not produced by this Package may have unintended results! While efforts have
been made to ensure that unsafe loading is not possible, no stringent security testing has been completed.
Parameters
• obj (dict, list) – The serialised object to import
• dto (Optional [tuple{str, str}]) – A Tuple describing the service and
• that should be constructed. (object) –
• dto = (e.g.) –

Returns: Either the loaded object in native Python datatypes, or the constructed native datatype object

nipyapi.utils.fs_read(file_path)
Convenience function to read an Object from a FilePath
Parameters file_path (str) – The Full path including filename to read from
Returns: The object that was read
nipyapi.utils.fs_write(obj, file_path)
Convenience function to write an Object to a FilePath
Parameters
• obj (varies) – The Object to write out

28 Chapter 3. NiPyApi Package Reference

 Nipyapi Documentation, Release 0.19.1

• file_path (str) – The Full path including filename to write to

Returns: The object that was written
nipyapi.utils.filter_obj(obj, value, key, greedy=True)
Implements a custom filter method because native datatypes don’t have consistently named or located fields.
Note that each object used by this function must be registered with identifier_types and identifiers in config
Parameters
• obj (varies) – the NiFi or NiFi-Registry object to filter on
• value (str) – the String value to look for
• key (str) – the object key to filter against
• greedy (bool) – If True, the value will be matched anywhere in the string, if False it will
require exact match
Returns: None if 0 matches, list if > 1, single Object entity if ==1
nipyapi.utils.wait_to_complete(test_function, *args, **kwargs)
Implements a basic return loop for a given function which is capable of a True|False output
Parameters
• test_function – Function which returns a bool once the target state is reached
• delay (int) – The number of seconds between each attempt, defaults to con-
fig.short_retry_delay
• max_wait (int) – the maximum number of seconds before issuing a Timeout, defaults to
config.short_max_wait
• *args – Any args to pass through to the test function
• **kwargs – Any Keword Args to pass through to the test function
Returns (bool): True for success, False for not
nipyapi.utils.is_endpoint_up(endpoint_url)
Tests if a URL is available for requests
Parameters endpoint_url (str) – The URL to test
Returns (bool): True for a 200 response, False for not
nipyapi.utils.set_endpoint(endpoint_url, ssl=False, login=False, username=None, pass-
word=None)
EXPERIMENTAL
Sets the endpoint when switching between instances of NiFi or other projects. Not tested extensively with
secured instances.
Parameters
• endpoint_url (str) – The URL to set as the endpoint. Auto-detects the relevant service
e.g. ‘http://localhost:18080/nifi-registry-api’
• ssl (bool) – Whether to use the default security context in nipyapi.config to authenticate
if a secure URL is detected
• login (bool) – Whether to attempt login using default cred in config requires ssl to be set
• username (str) – The username to use for login, if specified
• password (str) – The password to use for login, if specified

3.2. Client SDK modules 29

Nipyapi Documentation, Release 0.19.1

Returns (bool): True for success, False for not

nipyapi.utils.start_docker_containers(docker_containers, network_name=’demo’)
Deploys a list of DockerContainer’s on a given network
Parameters
• docker_containers (list[DockerContainer]) – list of Dockers to start
• network_name (str) – The name of the Docker Bridge Network to get or create for the
Docker Containers
Returns: Nothing
class nipyapi.utils.DockerContainer(name=None, image_name=None, image_tag=None,
ports=None, env=None, volumes=None, test_url=None,
endpoint=None)
Bases: object
Helper class for Docker container automation without using Ansible
get_container()
Fetch the container object
get_test_url_status()
Checks if a URL is available :return: status code if available, String ‘ConnectionError’ if not
set_container(container)
Set the container object
nipyapi.utils.infer_object_label_from_class(obj)
Returns the expected STRING label for an object class required by certain functions.

Parameters obj – The object to infer the name of

Returns str of the relevant name, or raises an AssertionError

nipyapi.utils.bypass_slash_encoding(service, bypass)
Instructs the API Client to bypass encoding the ‘/’ character
Parameters
• service (str) – ‘nifi’ or ‘registry’
• bypass (bool) – True will not encode ‘/’ in fields via API calls
Returns None
nipyapi.utils.exception_handler(status_code=None, response=None)
Simple Function wrapper to handle HTTP Status Exceptions
nipyapi.utils.enforce_min_ver(min_version, bool_response=False, service=’nifi’)
Raises an error if target NiFi environment is not minimum version :param min_version: Version to check against
:type min_version: str :param bool_response: If True, will return True instead of
raising error

Returns (bool) or (NotImplementedError)

nipyapi.utils.check_version(base, comparator=None, service=’nifi’, default_version=’0.2.0’)

Compares version base against either version comparator, or the version of the currently connected service
instance.

30 Chapter 3. NiPyApi Package Reference

 Nipyapi Documentation, Release 0.19.1

Since NiFi is java, it may return a version with -SNAPSHOT as part of it. As such, that will be stripped from
either the comparator version or the version returned from NiFi
Parameters
• base (str) – The base version for the comparison test
• comparator (optional[str]) – The version to compare against
• default_version (optional[str]) – The version to assume the service is if the
check cannot be completed
• service (str) – The service to test the version against, currently only supports NiFi
Returns (int): -1/0/1 if base is lower/equal/newer than comparator
nipyapi.utils.validate_parameters_versioning_support(verify_nifi=True, ver-
ify_registry=True)
Convenience method to check if Parameters are supported :param verify_nifi: If True, check NiFi meets the
min version :type verify_nifi: bool :param verify_registry: If True, check Registry meets the min version :type
verify_registry: bool

3.2.8 Versioning

For interactions with the NiFi Registry Service and related functions
nipyapi.versioning.create_registry_client(name, uri, description)
Creates a Registry Client in the NiFi Controller Services
Parameters
• name (str) – The name of the new Client
• uri (str) – The URI for the connection, such as ‘http://registry:18080’
• description (str) – A description for the Client
Returns The new registry client object
Return type (RegistryClientEntity)
nipyapi.versioning.list_registry_clients()
Lists the available Registry Clients in the NiFi Controller Services
Returns (list[RegistryClientEntity]) objects
nipyapi.versioning.delete_registry_client(client, refresh=True)
Deletes a Registry Client from the list of NiFI Controller Services
Parameters
• client (RegistryClientEntity) – The client to delete
• refresh (bool) – Whether to refresh the object before action
Returns The updated client object
Return type (RegistryClientEntity)
nipyapi.versioning.get_registry_client(identifier, identifier_type=’name’)
Filters the Registry clients to a particular identifier
Parameters
• identifier (str) – the filter string

3.2. Client SDK modules 31

Nipyapi Documentation, Release 0.19.1

• identifier_type (str) – the parameter to filter on

Returns None for no matches, Single Object for unique match, list(Objects) for multiple matches
nipyapi.versioning.list_registry_buckets()
Lists all available Buckets in the NiFi Registry
Returns (list[Bucket]) objects
nipyapi.versioning.create_registry_bucket(name)
Creates a new Registry Bucket
Parameters name (str) – name for the bucket, must be unique in the Registry
Returns The new Bucket object
Return type (Bucket)
nipyapi.versioning.delete_registry_bucket(bucket)
Removes a bucket from the NiFi Registry
Parameters bucket (Bucket) – the Bucket object to remove
Returns The updated Bucket object
Return type (Bucket)
nipyapi.versioning.get_registry_bucket(identifier, identifier_type=’name’, greedy=True)
Filters the Bucket list to a particular identifier
Parameters
• identifier (str) – the filter string
• identifier_type (str) – the param to filter on
• greedy (bool) – False for exa