FlowApi

All URIs are relative to http://localhost/nifi-api

Method	HTTP request	Description
generateClientId	GET /flow/client-id	Generates a client id.
getAboutInfo	GET /flow/about	Retrieves details about this NiFi to put in the About dialog
getAction	GET /flow/history/{id}	Gets an action
getBanners	GET /flow/banners	Retrieves the banners for this NiFi
getBulletinBoard	GET /flow/bulletin-board	Gets current bulletins
getBulletins	GET /flow/controller/bulletins	Retrieves Controller level bulletins
getClusterSummary	GET /flow/cluster/summary	Gets the current status of this NiFi
getComponentHistory	GET /flow/history/components/{componentId}	Gets configuration history for a component
getConnectionStatus	GET /flow/connections/{id}/status	Gets status for a connection
getConnectionStatusHistory	GET /flow/connections/{id}/status/history	Gets the status history for a connection
getControllerServiceTypes	GET /flow/controller-service-types	Retrieves the types of controller services that this NiFi supports
getControllerServicesFromController	GET /flow/controller/controller-services	Gets all controller services
getControllerServicesFromGroup	GET /flow/process-groups/{id}/controller-services	Gets all controller services
getControllerStatus	GET /flow/status	Gets the current status of this NiFi
getCurrentUser	GET /flow/current-user	Retrieves the user identity of the user making the request
getFlow	GET /flow/process-groups/{id}	Gets a process group
getFlowConfig	GET /flow/config	Retrieves the configuration for this NiFi flow
getInputPortStatus	GET /flow/input-ports/{id}/status	Gets status for an input port
getOutputPortStatus	GET /flow/output-ports/{id}/status	Gets status for an output port
getPrioritizers	GET /flow/prioritizers	Retrieves the types of prioritizers that this NiFi supports
getProcessGroupStatus	GET /flow/process-groups/{id}/status	Gets the status for a process group
getProcessGroupStatusHistory	GET /flow/process-groups/{id}/status/history	Gets status history for a remote process group
getProcessorStatus	GET /flow/processors/{id}/status	Gets status for a processor
getProcessorStatusHistory	GET /flow/processors/{id}/status/history	Gets status history for a processor
getProcessorTypes	GET /flow/processor-types	Retrieves the types of processors that this NiFi supports
getRemoteProcessGroupStatus	GET /flow/remote-process-groups/{id}/status	Gets status for a remote process group
getRemoteProcessGroupStatusHistory	GET /flow/remote-process-groups/{id}/status/history	Gets the status history
getReportingTaskTypes	GET /flow/reporting-task-types	Retrieves the types of reporting tasks that this NiFi supports
getReportingTasks	GET /flow/reporting-tasks	Gets all reporting tasks
getTemplates	GET /flow/templates	Gets all templates
queryHistory	GET /flow/history	Gets configuration history
scheduleComponents	PUT /flow/process-groups/{id}	Schedule or unschedule comopnents in the specified Process Group.
searchCluster	GET /flow/cluster/search-results	Searches the cluster for a node with the specified address
searchFlow	GET /flow/search-results	Performs a search against this NiFi using the specified search term

generateClientId

String generateClientId()

Generates a client id.

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.FlowApi;


FlowApi apiInstance = new FlowApi();
try {
    String result = apiInstance.generateClientId();
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling FlowApi#generateClientId");
    e.printStackTrace();
}

Parameters

This endpoint does not need any parameter.

Return type

String

Authorization

No authorization required

HTTP request headers

Content-Type: /
Accept: text/plain

getAboutInfo

AboutEntity getAboutInfo()

Retrieves details about this NiFi to put in the About dialog

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.FlowApi;


FlowApi apiInstance = new FlowApi();
try {
    AboutEntity result = apiInstance.getAboutInfo();
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling FlowApi#getAboutInfo");
    e.printStackTrace();
}

Parameters

This endpoint does not need any parameter.

Return type

AboutEntity

Authorization

No authorization required

HTTP request headers

Content-Type: /
Accept: application/json

getAction

ActionEntity getAction(id)

Gets an action

Note: This endpoint is subject to change as NiFi and it's REST API evolve.

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.FlowApi;


FlowApi apiInstance = new FlowApi();
String id = "id_example"; // String | The action id.
try {
    ActionEntity result = apiInstance.getAction(id);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling FlowApi#getAction");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	String	The action id.

Return type

ActionEntity

Authorization

No authorization required

HTTP request headers

Content-Type: /
Accept: application/json

getBanners

BannerEntity getBanners()

Retrieves the banners for this NiFi

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.FlowApi;


FlowApi apiInstance = new FlowApi();
try {
    BannerEntity result = apiInstance.getBanners();
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling FlowApi#getBanners");
    e.printStackTrace();
}

Parameters

This endpoint does not need any parameter.

Return type

BannerEntity

Authorization

No authorization required

HTTP request headers

Content-Type: /
Accept: application/json

getBulletinBoard

BulletinBoardEntity getBulletinBoard(after, sourceName, message, sourceId, groupId, limit)

Gets current bulletins

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.FlowApi;


FlowApi apiInstance = new FlowApi();
String after = "after_example"; // String | Includes bulletins with an id after this value.
String sourceName = "sourceName_example"; // String | Includes bulletins originating from this sources whose name match this regular expression.
String message = "message_example"; // String | Includes bulletins whose message that match this regular expression.
String sourceId = "sourceId_example"; // String | Includes bulletins originating from this sources whose id match this regular expression.
String groupId = "groupId_example"; // String | Includes bulletins originating from this sources whose group id match this regular expression.
String limit = "limit_example"; // String | The number of bulletins to limit the response to.
try {
    BulletinBoardEntity result = apiInstance.getBulletinBoard(after, sourceName, message, sourceId, groupId, limit);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling FlowApi#getBulletinBoard");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
after	String	Includes bulletins with an id after this value.	[optional]
sourceName	String	Includes bulletins originating from this sources whose name match this regular expression.	[optional]
message	String	Includes bulletins whose message that match this regular expression.	[optional]
sourceId	String	Includes bulletins originating from this sources whose id match this regular expression.	[optional]
groupId	String	Includes bulletins originating from this sources whose group id match this regular expression.	[optional]
limit	String	The number of bulletins to limit the response to.	[optional]

Return type

BulletinBoardEntity

Authorization

No authorization required

HTTP request headers

Content-Type: /
Accept: application/json

getBulletins

ControllerBulletinsEntity getBulletins()

Retrieves Controller level bulletins

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.FlowApi;


FlowApi apiInstance = new FlowApi();
try {
    ControllerBulletinsEntity result = apiInstance.getBulletins();
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling FlowApi#getBulletins");
    e.printStackTrace();
}

Parameters

This endpoint does not need any parameter.

Return type

ControllerBulletinsEntity

Authorization

No authorization required

HTTP request headers

Content-Type: /
Accept: application/json

getClusterSummary

ControllerStatusEntity getClusterSummary()

Gets the current status of this NiFi

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.FlowApi;


FlowApi apiInstance = new FlowApi();
try {
    ControllerStatusEntity result = apiInstance.getClusterSummary();
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling FlowApi#getClusterSummary");
    e.printStackTrace();
}

Parameters

This endpoint does not need any parameter.

Return type

ControllerStatusEntity

Authorization

No authorization required

HTTP request headers

Content-Type: /
Accept: application/json

getComponentHistory

ComponentHistoryEntity getComponentHistory(componentId)

Gets configuration history for a component

Note: This endpoint is subject to change as NiFi and it's REST API evolve.

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.FlowApi;


FlowApi apiInstance = new FlowApi();
String componentId = "componentId_example"; // String | The component id.
try {
    ComponentHistoryEntity result = apiInstance.getComponentHistory(componentId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling FlowApi#getComponentHistory");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
componentId	String	The component id.

Return type

ComponentHistoryEntity

Authorization

No authorization required

HTTP request headers

Content-Type: /
Accept: application/json

getConnectionStatus

ConnectionStatusEntity getConnectionStatus(id, nodewise, clusterNodeId)

Gets status for a connection

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.FlowApi;


FlowApi apiInstance = new FlowApi();
String id = "id_example"; // String | The connection id.
Boolean nodewise = true; // Boolean | Whether or not to include the breakdown per node. Optional, defaults to false
String clusterNodeId = "clusterNodeId_example"; // String | The id of the node where to get the status.
try {
    ConnectionStatusEntity result = apiInstance.getConnectionStatus(id, nodewise, clusterNodeId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling FlowApi#getConnectionStatus");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	String	The connection id.
nodewise	Boolean	Whether or not to include the breakdown per node. Optional, defaults to false	[optional]
clusterNodeId	String	The id of the node where to get the status.	[optional]

Return type

ConnectionStatusEntity

Authorization

No authorization required

HTTP request headers

Content-Type: /
Accept: application/json

getConnectionStatusHistory

StatusHistoryEntity getConnectionStatusHistory(id)

Gets the status history for a connection

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.FlowApi;


FlowApi apiInstance = new FlowApi();
String id = "id_example"; // String | The connection id.
try {
    StatusHistoryEntity result = apiInstance.getConnectionStatusHistory(id);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling FlowApi#getConnectionStatusHistory");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	String	The connection id.

Return type

StatusHistoryEntity

Authorization

No authorization required

HTTP request headers

Content-Type: /
Accept: application/json

getControllerServiceTypes

ControllerServiceTypesEntity getControllerServiceTypes(serviceType)

Retrieves the types of controller services that this NiFi supports

Note: This endpoint is subject to change as NiFi and it's REST API evolve.

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.FlowApi;


FlowApi apiInstance = new FlowApi();
String serviceType = "serviceType_example"; // String | If specified, will only return controller services of this type.
try {
    ControllerServiceTypesEntity result = apiInstance.getControllerServiceTypes(serviceType);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling FlowApi#getControllerServiceTypes");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
serviceType	String	If specified, will only return controller services of this type.	[optional]

Return type

ControllerServiceTypesEntity

Authorization

No authorization required

HTTP request headers

Content-Type: /
Accept: application/json

getControllerServicesFromController

ControllerServicesEntity getControllerServicesFromController()

Gets all controller services

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.FlowApi;


FlowApi apiInstance = new FlowApi();
try {
    ControllerServicesEntity result = apiInstance.getControllerServicesFromController();
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling FlowApi#getControllerServicesFromController");
    e.printStackTrace();
}

Parameters

This endpoint does not need any parameter.

Return type

ControllerServicesEntity

Authorization

No authorization required

HTTP request headers

Content-Type: /
Accept: application/json

getControllerServicesFromGroup

ControllerServicesEntity getControllerServicesFromGroup(id)

Gets all controller services

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.FlowApi;


FlowApi apiInstance = new FlowApi();
String id = "id_example"; // String | The process group id.
try {
    ControllerServicesEntity result = apiInstance.getControllerServicesFromGroup(id);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling FlowApi#getControllerServicesFromGroup");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	String	The process group id.

Return type

ControllerServicesEntity

Authorization

No authorization required

HTTP request headers

Content-Type: /
Accept: application/json

getControllerStatus

ControllerStatusEntity getControllerStatus()

Gets the current status of this NiFi

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.FlowApi;


FlowApi apiInstance = new FlowApi();
try {
    ControllerStatusEntity result = apiInstance.getControllerStatus();
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling FlowApi#getControllerStatus");
    e.printStackTrace();
}

Parameters

This endpoint does not need any parameter.

Return type

ControllerStatusEntity

Authorization

No authorization required

HTTP request headers

Content-Type: /
Accept: application/json

getCurrentUser

CurrentUserEntity getCurrentUser()

Retrieves the user identity of the user making the request

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.FlowApi;


FlowApi apiInstance = new FlowApi();
try {
    CurrentUserEntity result = apiInstance.getCurrentUser();
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling FlowApi#getCurrentUser");
    e.printStackTrace();
}

Parameters

This endpoint does not need any parameter.

Return type

CurrentUserEntity

Authorization

No authorization required

HTTP request headers

Content-Type: /
Accept: application/json

getFlow

ProcessGroupFlowEntity getFlow(id)

Gets a process group

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.FlowApi;


FlowApi apiInstance = new FlowApi();
String id = "id_example"; // String | The process group id.
try {
    ProcessGroupFlowEntity result = apiInstance.getFlow(id);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling FlowApi#getFlow");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	String	The process group id.

Return type

ProcessGroupFlowEntity

Authorization

No authorization required

HTTP request headers

Content-Type: /
Accept: application/json

getFlowConfig

FlowConfigurationEntity getFlowConfig()

Retrieves the configuration for this NiFi flow

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.FlowApi;


FlowApi apiInstance = new FlowApi();
try {
    FlowConfigurationEntity result = apiInstance.getFlowConfig();
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling FlowApi#getFlowConfig");
    e.printStackTrace();
}

Parameters

This endpoint does not need any parameter.

Return type

FlowConfigurationEntity

Authorization

No authorization required

HTTP request headers

Content-Type: /
Accept: application/json

getInputPortStatus

PortStatusEntity getInputPortStatus(id, nodewise, clusterNodeId)

Gets status for an input port

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.FlowApi;


FlowApi apiInstance = new FlowApi();
String id = "id_example"; // String | The input port id.
Boolean nodewise = true; // Boolean | Whether or not to include the breakdown per node. Optional, defaults to false
String clusterNodeId = "clusterNodeId_example"; // String | The id of the node where to get the status.
try {
    PortStatusEntity result = apiInstance.getInputPortStatus(id, nodewise, clusterNodeId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling FlowApi#getInputPortStatus");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	String	The input port id.
nodewise	Boolean	Whether or not to include the breakdown per node. Optional, defaults to false	[optional]
clusterNodeId	String	The id of the node where to get the status.	[optional]

Return type

PortStatusEntity

Authorization

No authorization required

HTTP request headers

Content-Type: /
Accept: application/json

getOutputPortStatus

PortStatusEntity getOutputPortStatus(id, nodewise, clusterNodeId)

Gets status for an output port

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.FlowApi;


FlowApi apiInstance = new FlowApi();
String id = "id_example"; // String | The output port id.
Boolean nodewise = true; // Boolean | Whether or not to include the breakdown per node. Optional, defaults to false
String clusterNodeId = "clusterNodeId_example"; // String | The id of the node where to get the status.
try {
    PortStatusEntity result = apiInstance.getOutputPortStatus(id, nodewise, clusterNodeId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling FlowApi#getOutputPortStatus");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	String	The output port id.
nodewise	Boolean	Whether or not to include the breakdown per node. Optional, defaults to false	[optional]
clusterNodeId	String	The id of the node where to get the status.	[optional]

Return type

PortStatusEntity

Authorization

No authorization required

HTTP request headers

Content-Type: /
Accept: application/json

getPrioritizers

PrioritizerTypesEntity getPrioritizers()

Retrieves the types of prioritizers that this NiFi supports

Note: This endpoint is subject to change as NiFi and it's REST API evolve.

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.FlowApi;


FlowApi apiInstance = new FlowApi();
try {
    PrioritizerTypesEntity result = apiInstance.getPrioritizers();
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling FlowApi#getPrioritizers");
    e.printStackTrace();
}

Parameters

This endpoint does not need any parameter.

Return type

PrioritizerTypesEntity

Authorization

No authorization required

HTTP request headers

Content-Type: /
Accept: application/json

getProcessGroupStatus

ProcessGroupStatusEntity getProcessGroupStatus(id, recursive, nodewise, clusterNodeId)

Gets the status for a process group

The status for a process group includes status for all descendent components. When invoked on the root group with recursive set to true, it will return the current status of every component in the flow.

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.FlowApi;


FlowApi apiInstance = new FlowApi();
String id = "id_example"; // String | The process group id.
Boolean recursive = true; // Boolean | Whether all descendant groups and the status of their content will be included. Optional, defaults to false
Boolean nodewise = true; // Boolean | Whether or not to include the breakdown per node. Optional, defaults to false
String clusterNodeId = "clusterNodeId_example"; // String | The id of the node where to get the status.
try {
    ProcessGroupStatusEntity result = apiInstance.getProcessGroupStatus(id, recursive, nodewise, clusterNodeId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling FlowApi#getProcessGroupStatus");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	String	The process group id.
recursive	Boolean	Whether all descendant groups and the status of their content will be included. Optional, defaults to false	[optional]
nodewise	Boolean	Whether or not to include the breakdown per node. Optional, defaults to false	[optional]
clusterNodeId	String	The id of the node where to get the status.	[optional]

Return type

ProcessGroupStatusEntity

Authorization

No authorization required

HTTP request headers

Content-Type: /
Accept: application/json

getProcessGroupStatusHistory

StatusHistoryEntity getProcessGroupStatusHistory(id)

Gets status history for a remote process group

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.FlowApi;


FlowApi apiInstance = new FlowApi();
String id = "id_example"; // String | The process group id.
try {
    StatusHistoryEntity result = apiInstance.getProcessGroupStatusHistory(id);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling FlowApi#getProcessGroupStatusHistory");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	String	The process group id.

Return type

StatusHistoryEntity

Authorization

No authorization required

HTTP request headers

Content-Type: /
Accept: application/json

getProcessorStatus

ProcessorStatusEntity getProcessorStatus(id, nodewise, clusterNodeId)

Gets status for a processor

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.FlowApi;


FlowApi apiInstance = new FlowApi();
String id = "id_example"; // String | The processor id.
Boolean nodewise = true; // Boolean | Whether or not to include the breakdown per node. Optional, defaults to false
String clusterNodeId = "clusterNodeId_example"; // String | The id of the node where to get the status.
try {
    ProcessorStatusEntity result = apiInstance.getProcessorStatus(id, nodewise, clusterNodeId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling FlowApi#getProcessorStatus");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	String	The processor id.
nodewise	Boolean	Whether or not to include the breakdown per node. Optional, defaults to false	[optional]
clusterNodeId	String	The id of the node where to get the status.	[optional]

Return type

ProcessorStatusEntity

Authorization

No authorization required

HTTP request headers

Content-Type: /
Accept: application/json

getProcessorStatusHistory

StatusHistoryEntity getProcessorStatusHistory(id)

Gets status history for a processor

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.FlowApi;


FlowApi apiInstance = new FlowApi();
String id = "id_example"; // String | The processor id.
try {
    StatusHistoryEntity result = apiInstance.getProcessorStatusHistory(id);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling FlowApi#getProcessorStatusHistory");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	String	The processor id.

Return type

StatusHistoryEntity

Authorization

No authorization required

HTTP request headers

Content-Type: /
Accept: application/json

getProcessorTypes

ProcessorTypesEntity getProcessorTypes()

Retrieves the types of processors that this NiFi supports

Note: This endpoint is subject to change as NiFi and it's REST API evolve.

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.FlowApi;


FlowApi apiInstance = new FlowApi();
try {
    ProcessorTypesEntity result = apiInstance.getProcessorTypes();
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling FlowApi#getProcessorTypes");
    e.printStackTrace();
}

Parameters

This endpoint does not need any parameter.

Return type

ProcessorTypesEntity

Authorization

No authorization required

HTTP request headers

Content-Type: /
Accept: application/json

getRemoteProcessGroupStatus

ProcessorStatusEntity getRemoteProcessGroupStatus(id, nodewise, clusterNodeId)

Gets status for a remote process group

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.FlowApi;


FlowApi apiInstance = new FlowApi();
String id = "id_example"; // String | The remote process group id.
Boolean nodewise = true; // Boolean | Whether or not to include the breakdown per node. Optional, defaults to false
String clusterNodeId = "clusterNodeId_example"; // String | The id of the node where to get the status.
try {
    ProcessorStatusEntity result = apiInstance.getRemoteProcessGroupStatus(id, nodewise, clusterNodeId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling FlowApi#getRemoteProcessGroupStatus");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	String	The remote process group id.
nodewise	Boolean	Whether or not to include the breakdown per node. Optional, defaults to false	[optional]
clusterNodeId	String	The id of the node where to get the status.	[optional]

Return type

ProcessorStatusEntity

Authorization

No authorization required

HTTP request headers

Content-Type: /
Accept: application/json

getRemoteProcessGroupStatusHistory

StatusHistoryEntity getRemoteProcessGroupStatusHistory(id)

Gets the status history

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.FlowApi;


FlowApi apiInstance = new FlowApi();
String id = "id_example"; // String | The remote process group id.
try {
    StatusHistoryEntity result = apiInstance.getRemoteProcessGroupStatusHistory(id);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling FlowApi#getRemoteProcessGroupStatusHistory");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	String	The remote process group id.

Return type

StatusHistoryEntity

Authorization

No authorization required

HTTP request headers

Content-Type: /
Accept: application/json

getReportingTaskTypes

ReportingTaskTypesEntity getReportingTaskTypes()

Retrieves the types of reporting tasks that this NiFi supports

Note: This endpoint is subject to change as NiFi and it's REST API evolve.

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.FlowApi;


FlowApi apiInstance = new FlowApi();
try {
    ReportingTaskTypesEntity result = apiInstance.getReportingTaskTypes();
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling FlowApi#getReportingTaskTypes");
    e.printStackTrace();
}

Parameters

This endpoint does not need any parameter.

Return type

ReportingTaskTypesEntity

Authorization

No authorization required

HTTP request headers

Content-Type: /
Accept: application/json

getReportingTasks

ReportingTasksEntity getReportingTasks()

Gets all reporting tasks

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.FlowApi;


FlowApi apiInstance = new FlowApi();
try {
    ReportingTasksEntity result = apiInstance.getReportingTasks();
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling FlowApi#getReportingTasks");
    e.printStackTrace();
}

Parameters

This endpoint does not need any parameter.

Return type

ReportingTasksEntity

Authorization

No authorization required

HTTP request headers

Content-Type: /
Accept: application/json

getTemplates

TemplatesEntity getTemplates()

Gets all templates

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.FlowApi;


FlowApi apiInstance = new FlowApi();
try {
    TemplatesEntity result = apiInstance.getTemplates();
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling FlowApi#getTemplates");
    e.printStackTrace();
}

Parameters

This endpoint does not need any parameter.

Return type

TemplatesEntity

Authorization

No authorization required

HTTP request headers

Content-Type: /
Accept: application/json

queryHistory

HistoryEntity queryHistory(offset, count, sortColumn, sortOrder, startDate, endDate, userIdentity, sourceId)

Gets configuration history

Note: This endpoint is subject to change as NiFi and it's REST API evolve.

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.FlowApi;


FlowApi apiInstance = new FlowApi();
String offset = "offset_example"; // String | The offset into the result set.
String count = "count_example"; // String | The number of actions to return.
String sortColumn = "sortColumn_example"; // String | The field to sort on.
String sortOrder = "sortOrder_example"; // String | The direction to sort.
String startDate = "startDate_example"; // String | Include actions after this date.
String endDate = "endDate_example"; // String | Include actions before this date.
String userIdentity = "userIdentity_example"; // String | Include actions performed by this user.
String sourceId = "sourceId_example"; // String | Include actions on this component.
try {
    HistoryEntity result = apiInstance.queryHistory(offset, count, sortColumn, sortOrder, startDate, endDate, userIdentity, sourceId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling FlowApi#queryHistory");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
offset	String	The offset into the result set.
count	String	The number of actions to return.
sortColumn	String	The field to sort on.	[optional]
sortOrder	String	The direction to sort.	[optional]
startDate	String	Include actions after this date.	[optional]
endDate	String	Include actions before this date.	[optional]
userIdentity	String	Include actions performed by this user.	[optional]
sourceId	String	Include actions on this component.	[optional]

Return type

HistoryEntity

Authorization

No authorization required

HTTP request headers

Content-Type: /
Accept: application/json

scheduleComponents

ScheduleComponentsEntity scheduleComponents(id, body)

Schedule or unschedule comopnents in the specified Process Group.

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.FlowApi;


FlowApi apiInstance = new FlowApi();
String id = "id_example"; // String | The process group id.
ScheduleComponentsEntity body = new ScheduleComponentsEntity(); // ScheduleComponentsEntity | The request to schedule or unschedule. If the comopnents in the request are not specified, all authorized components will be considered.
try {
    ScheduleComponentsEntity result = apiInstance.scheduleComponents(id, body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling FlowApi#scheduleComponents");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	String	The process group id.
body	ScheduleComponentsEntity	The request to schedule or unschedule. If the comopnents in the request are not specified, all authorized components will be considered.

Return type

ScheduleComponentsEntity

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

searchCluster

ClusterSearchResultsEntity searchCluster(q)

Searches the cluster for a node with the specified address

Note: This endpoint is subject to change as NiFi and it's REST API evolve.

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.FlowApi;


FlowApi apiInstance = new FlowApi();
String q = "q_example"; // String | Node address to search for.
try {
    ClusterSearchResultsEntity result = apiInstance.searchCluster(q);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling FlowApi#searchCluster");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
q	String	Node address to search for.

Return type

ClusterSearchResultsEntity

Authorization

No authorization required

HTTP request headers

Content-Type: /
Accept: application/json

searchFlow

SearchResultsEntity searchFlow(q)

Performs a search against this NiFi using the specified search term

Only search results from authorized components will be returned.

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.FlowApi;


FlowApi apiInstance = new FlowApi();
String q = "q_example"; // String | 
try {
    SearchResultsEntity result = apiInstance.searchFlow(q);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling FlowApi#searchFlow");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
q	String		[optional]

Return type

SearchResultsEntity

Authorization

No authorization required

HTTP request headers

Content-Type: /
Accept: application/json

Files

FlowApi.md

Latest commit

History

FlowApi.md

File metadata and controls

FlowApi

generateClientId

Example

Parameters

Return type

Authorization

HTTP request headers

getAboutInfo

Example

Parameters

Return type

Authorization

HTTP request headers

getAction

Example

Parameters

Return type

Authorization

HTTP request headers

getBanners

Example

Parameters

Return type

Authorization

HTTP request headers

getBulletinBoard

Example

Parameters

Return type

Authorization

HTTP request headers

getBulletins

Example

Parameters

Return type

Authorization

HTTP request headers

getClusterSummary

Example

Parameters

Return type

Authorization

HTTP request headers

getComponentHistory

Example

Parameters

Return type

Authorization

HTTP request headers

getConnectionStatus

Example

Parameters

Return type

Authorization

HTTP request headers

getConnectionStatusHistory

Example

Parameters

Return type

Authorization

HTTP request headers

getControllerServiceTypes

Example

Parameters

Return type

Authorization

HTTP request headers

getControllerServicesFromController

Example

Parameters

Return type

Authorization

HTTP request headers

getControllerServicesFromGroup