Modified: nifi/site/trunk/docs/nifi-docs/rest-api/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/rest-api/index.html?rev=1758319&r1=1758318&r2=1758319&view=diff ============================================================================== --- nifi/site/trunk/docs/nifi-docs/rest-api/index.html (original) +++ nifi/site/trunk/docs/nifi-docs/rest-api/index.html Tue Aug 30 03:25:27 2016 @@ -15,7 +15,7 @@ --> <html> <head> - <title>NiFi Rest Api-0.7.0</title> + <title>NiFi Rest Api-1.0.0</title> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/> <link rel="shortcut icon" href="images/nifi16.ico"/> <script type="text/javascript" src="../../nifi/js/jquery/jquery-2.1.1.min.js"></script> @@ -425,31 +425,40 @@ var endpoints = $(this); var path = endpoints.find('div.path').text(); - if (term === null || path.indexOf(term) > 0) { + if (term === null || path.indexOf(term) === 0) { endpoints.detach().appendTo(container); } }); }; // organize the endpoints - organizeEndpoints('cluster', $('#cluster-endpoints')); - organizeEndpoints('provenance', $('#provenance-endpoints')); - organizeEndpoints('user', $('#user-endpoints')); - organizeEndpoints('controller-services', $('#controller-service-endpoints')); - organizeEndpoints('reporting-tasks', $('#reporting-task-endpoints')); - organizeEndpoints('connections', $('#connection-endpoints')); - organizeEndpoints('processors', $('#processor-endpoints')); - organizeEndpoints('funnels', $('#funnel-endpoints')); - organizeEndpoints('remote-process-groups', $('#remote-process-group-endpoints')); - organizeEndpoints('input-ports', $('#input-port-endpoints')); - organizeEndpoints('output-ports', $('#output-port-endpoints')); - organizeEndpoints('labels', $('#label-endpoints')); - organizeEndpoints('process-groups', $('#process-group-endpoints')); - organizeEndpoints('history', $('#history-endpoints')); - organizeEndpoints('access', $('#access-endpoints')); + organizeEndpoints('/process-groups', $('#process-group-endpoints')); + organizeEndpoints('/controller-services', $('#controller-service-endpoints')); + organizeEndpoints('/reporting-tasks', $('#reporting-task-endpoints')); + organizeEndpoints('/counters', $('#counter-endpoints')); + organizeEndpoints('/controller', $('#controller-endpoints')); + organizeEndpoints('/connections', $('#connection-endpoints')); + organizeEndpoints('/flowfile-queue', $('#flowfile-queue-endpoints')); + organizeEndpoints('/processors', $('#processor-endpoints')); + organizeEndpoints('/funnels', $('#funnel-endpoints')); + organizeEndpoints('/remote-process-groups', $('#remote-process-group-endpoints')); + organizeEndpoints('/input-ports', $('#input-port-endpoints')); + organizeEndpoints('/output-ports', $('#output-port-endpoints')); + organizeEndpoints('/labels', $('#label-endpoints')); + organizeEndpoints('/access', $('#access-endpoints')); + organizeEndpoints('/flow', $('#flow-endpoints')); + organizeEndpoints('/provenance-events', $('#provenance-event-endpoints')); + organizeEndpoints('/provenance', $('#provenance-endpoints')); + organizeEndpoints('/tenants', $('#tenant-endpoints')); + organizeEndpoints('/data-transfer', $('#data-transfer-endpoints')); + organizeEndpoints('/policies', $('#policy-endpoints')); + organizeEndpoints('/resources', $('#resource-endpoints')); + organizeEndpoints('/site-to-site', $('#site-to-site-endpoints')); + organizeEndpoints('/snippets', $('#snippet-endpoints')); + organizeEndpoints('/system', $('#system-diagnostic-endpoints')); + organizeEndpoints('/templates', $('#template-endpoints')); organizeEndpoints(null, $('#controller-endpoints')); - - + // handle expanding/collapsing the sections $('div.section-header > div.title').on('click', function() { $(this).parent('div.section-header').next('div.section-endpoints').slideToggle(); @@ -461,13 +470,13 @@ <div class="header"> <img class="logo" src="images/bgNifiLogo.png" alt="NiFi Logo"/> <div class="title">/nifi-api</div> - <div class="sub-title">NiFi Rest Api 0.7.0</div> + <div class="sub-title">NiFi Rest Api 1.0.0</div> <div class="clear"></div> </div> <div class="clear"></div> <div class="overview">The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, - definitions of the expected input and output, potential response codes, and the authorities required + definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.</div> <div class="section"> <div class="section-header"> @@ -480,15 +489,47 @@ <div class="section"> <div class="section-header"> <div class="title link">Controller</div> - <div class="sub-title section-description">Get controller configuration, Search the flow, Manage templates, System diagnostics</div> + <div class="sub-title section-description">Get controller configuration, Manage the cluster, Create reporting tasks</div> <div class="clear"></div> </div> <div id="controller-endpoints" class="section-endpoints hidden"></div> </div> <div class="section"> <div class="section-header"> + <div class="title link">Controller Services</div> + <div class="sub-title section-description">Manage controller services, Update controller service references</div> + <div class="clear"></div> + </div> + <div id="controller-service-endpoints" class="section-endpoints hidden"></div> + </div> + <div class="section"> + <div class="section-header"> + <div class="title link">Reporting Tasks</div> + <div class="sub-title section-description">Manage reporting tasks</div> + <div class="clear"></div> + </div> + <div id="reporting-task-endpoints" class="section-endpoints hidden"></div> + </div> + <div class="section"> + <div class="section-header"> + <div class="title link">Counters</div> + <div class="sub-title section-description">Get counters, Reset counters</div> + <div class="clear"></div> + </div> + <div id="counter-endpoints" class="section-endpoints hidden"></div> + </div> + <div class="section"> + <div class="section-header"> + <div class="title link">Flow</div> + <div class="sub-title section-description">Get the data flow, Obtain component status, Query history</div> + <div class="clear"></div> + </div> + <div id="flow-endpoints" class="section-endpoints hidden"></div> + </div> + <div class="section"> + <div class="section-header"> <div class="title link">Process Groups</div> - <div class="sub-title section-description">Get the flow, Instantiate a template, Manage sub groups, Monitor component status</div> + <div class="sub-title section-description">Create components, Instantiate a template, Upload a template</div> <div class="clear"></div> </div> <div id="process-group-endpoints" class="section-endpoints hidden"></div> @@ -511,6 +552,14 @@ </div> <div class="section"> <div class="section-header"> + <div class="title link">FlowFile Queues</div> + <div class="sub-title section-description">View queue contents, Download flowfile content, Empty queue</div> + <div class="clear"></div> + </div> + <div id="flowfile-queue-endpoints" class="section-endpoints hidden"></div> + </div> + <div class="section"> + <div class="section-header"> <div class="title link">Input Ports</div> <div class="sub-title section-description">Create an input port, Set remote port access control</div> <div class="clear"></div> @@ -551,51 +600,83 @@ </div> <div class="section"> <div class="section-header"> - <div class="title link">Controller Services</div> - <div class="sub-title section-description">Manage controller services, Update controller service references</div> + <div class="title link">Provenance</div> + <div class="sub-title section-description">Query provenance, Search event lineage</div> <div class="clear"></div> </div> - <div id="controller-service-endpoints" class="section-endpoints hidden"></div> + <div id="provenance-endpoints" class="section-endpoints hidden"></div> </div> <div class="section"> <div class="section-header"> - <div class="title link">Reporting Tasks</div> - <div class="sub-title section-description">Manage reporting tasks</div> + <div class="title link">Provenance Events</div> + <div class="sub-title section-description">Download content, Replay</div> <div class="clear"></div> </div> - <div id="reporting-task-endpoints" class="section-endpoints hidden"></div> + <div id="provenance-event-endpoints" class="section-endpoints hidden"></div> </div> <div class="section"> <div class="section-header"> - <div class="title link">Cluster</div> - <div class="sub-title section-description">View node status, Disconnect nodes, Aggregate component status</div> + <div class="title link">Tenants</div> + <div class="sub-title section-description">Add users and group, Group users</div> <div class="clear"></div> </div> - <div id="cluster-endpoints" class="section-endpoints hidden"></div> + <div id="tenant-endpoints" class="section-endpoints hidden"></div> </div> <div class="section"> <div class="section-header"> - <div class="title link">Provenance</div> - <div class="sub-title section-description">Query provenance, Search event lineage, Download content, Replay</div> + <div class="title link">Policies</div> + <div class="sub-title section-description">Get policies, Create policies</div> <div class="clear"></div> </div> - <div id="provenance-endpoints" class="section-endpoints hidden"></div> + <div id="policy-endpoints" class="section-endpoints hidden"></div> + </div> + <div class="section"> + <div class="section-header"> + <div class="title link">Resources</div> + <div class="sub-title section-description">Get resources</div> + <div class="clear"></div> + </div> + <div id="resource-endpoints" class="section-endpoints hidden"></div> + </div> + <div class="section"> + <div class="section-header"> + <div class="title link">Site to Site</div> + <div class="sub-title section-description">Get available ports, Get peers</div> + <div class="clear"></div> + </div> + <div id="site-to-site-endpoints" class="section-endpoints hidden"></div> + </div> + <div class="section"> + <div class="section-header"> + <div class="title link">Data Transfer</div> + <div class="sub-title section-description">Send data, Receive data</div> + <div class="clear"></div> + </div> + <div id="data-transfer-endpoints" class="section-endpoints hidden"></div> + </div> + <div class="section"> + <div class="section-header"> + <div class="title link">Snippets</div> + <div class="sub-title section-description">Create a snippet, Move a snippet, Delete a snippet</div> + <div class="clear"></div> + </div> + <div id="snippet-endpoints" class="section-endpoints hidden"></div> </div> <div class="section"> <div class="section-header"> - <div class="title link">History</div> - <div class="sub-title section-description">View flow history, Purge flow history</div> + <div class="title link">Templates</div> + <div class="sub-title section-description">Download a template, Delete a template</div> <div class="clear"></div> </div> - <div id="history-endpoints" class="section-endpoints hidden"></div> + <div id="template-endpoints" class="section-endpoints hidden"></div> </div> <div class="section"> <div class="section-header"> - <div class="title link">Users</div> - <div class="sub-title section-description">Update user access, revoke accounts, get account details, Group users</div> + <div class="title link">System Diagnostics</div> + <div class="sub-title section-description">Get system diagnostics</div> <div class="clear"></div> </div> - <div id="user-endpoints" class="section-endpoints hidden"></div> + <div id="system-diagnostic-endpoints" class="section-endpoints hidden"></div> </div> <div class="unorganized hidden"> @@ -614,6 +695,10 @@ <div class="operation hidden"> + <div class="description"> + Note: This endpoint is subject to change as NiFi and it's REST API evolve. + </div> + <div class="title">Request</div> <div class="mediatypes details"> @@ -621,39 +706,12 @@ </div> - <table> - <thead> - <tr> - <th>Name</th> - <th>Location</th> - <th>Type</th> - <th>Description</th> - </tr> - </thead> - <tbody> - - - <tr> - <td>clientId</td> - <td>query</td> - - - - <td>string</td> - - - - <td>If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.</td> - </tr> - - </tbody> - </table> <div class="title">Response</div> <div class="mediatypes details"> - <div class="mediatype"><div class="title">produces:</div><div class="mono">application/xml, application/json</div><div class="clear"></div></div> + <div class="mediatype"><div class="title">produces:</div><div class="mono">application/json</div><div class="clear"></div></div> </div> <table> @@ -761,39 +819,12 @@ </div> - <table> - <thead> - <tr> - <th>Name</th> - <th>Location</th> - <th>Type</th> - <th>Description</th> - </tr> - </thead> - <tbody> - - - <tr> - <td>clientId</td> - <td>query</td> - - - - <td>string</td> - - - - <td>If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.</td> - </tr> - - </tbody> - </table> <div class="title">Response</div> <div class="mediatypes details"> - <div class="mediatype"><div class="title">produces:</div><div class="mono">application/json, application/xml</div><div class="clear"></div></div> + <div class="mediatype"><div class="title">produces:</div><div class="mono">application/json</div><div class="clear"></div></div> </div> <table> @@ -1000,16 +1031,6 @@ </tr> <tr> - <td>403</td> - <td> - - string - - </td> - <td>Client is not authorized to make this request.</td> - </tr> - - <tr> <td>409</td> <td> @@ -1289,23 +1310,19 @@ <div class="endpoints"> - <span class="path hidden">/cluster</span> + <span class="path hidden">/connections/{id}</span> <div class="endpoint get"> <div class="operation-handle"> <div class="method">GET</div> <div class="path mono"></div> - <div class="summary">Gets the contents of the cluster</div> + <div class="summary">Gets a connection</div> <div class="clear"></div> </div> <div class="operation hidden"> - <div class="description"> - Returns the contents of the cluster including all nodes and their status. - </div> - <div class="title">Request</div> <div class="mediatypes details"> @@ -1326,16 +1343,16 @@ <tr> - <td>clientId</td> - <td>query</td> + <td>id</td> + <td>path</td> - <td>string</td> + <td>string </td> - <td>If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.</td> + <td>The connection id.</td> </tr> @@ -1345,7 +1362,7 @@ <div class="title">Response</div> <div class="mediatypes details"> - <div class="mediatype"><div class="title">produces:</div><div class="mono">application/xml, application/json</div><div class="clear"></div></div> + <div class="mediatype"><div class="title">produces:</div><div class="mono">application/json</div><div class="clear"></div></div> </div> <table> @@ -1362,7 +1379,7 @@ <td>200</td> <td> - <a class="type-link" href="javascript:void(0);">ClusterEntity</a> + <a class="type-link" href="javascript:void(0);">ConnectionEntity</a> </td> <td>successful operation</td> @@ -1399,6 +1416,16 @@ </tr> <tr> + <td>404</td> + <td> + + string + + </td> + <td>The specified resource could not be found.</td> + </tr> + + <tr> <td>409</td> <td> @@ -1414,15 +1441,11 @@ <div class="authorization details"> - <div>Read Only</div> - - - - <div>DFM</div> + <div>Read Source - /{component-type}/{uuid}</div> - <div>Admin</div> + <div>Read Destination - /{component-type}/{uuid}</div> </div> @@ -1430,19 +1453,11 @@ </div> - -</div> - - -<div class="endpoints"> - <span class="path hidden">/cluster/connections/{id}/status</span> - - - <div class="endpoint get"> + <div class="endpoint put"> <div class="operation-handle"> - <div class="method">GET</div> + <div class="method">PUT</div> <div class="path mono"></div> - <div class="summary">Gets connection status across the cluster</div> + <div class="summary">Updates a connection</div> <div class="clear"></div> </div> @@ -1451,7 +1466,7 @@ <div class="title">Request</div> <div class="mediatypes details"> - <div class="mediatype"><div class="title">consumes:</div><div class="mono">*/*</div><div class="clear"></div></div> + <div class="mediatype"><div class="title">consumes:</div><div class="mono">application/json</div><div class="clear"></div></div> </div> @@ -1468,29 +1483,28 @@ <tr> - <td>clientId</td> - <td>query</td> + <td>id</td> + <td>path</td> - <td>string</td> + <td>string </td> - <td>If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.</td> + <td>The connection id.</td> </tr> <tr> - <td>id</td> - <td>path</td> + <td></td> + <td>body</td> + <td> - - <td>string </td> - - + <a class="type-link" href="javascript:void(0);">ConnectionEntity</a> + </td> - <td>The connection id</td> + <td>The connection configuration details.</td> </tr> @@ -1500,7 +1514,7 @@ <div class="title">Response</div> <div class="mediatypes details"> - <div class="mediatype"><div class="title">produces:</div><div class="mono">application/xml, application/json</div><div class="clear"></div></div> + <div class="mediatype"><div class="title">produces:</div><div class="mono">application/json</div><div class="clear"></div></div> </div> <table> @@ -1517,7 +1531,7 @@ <td>200</td> <td> - <a class="type-link" href="javascript:void(0);">ClusterConnectionStatusEntity</a> + <a class="type-link" href="javascript:void(0);">ConnectionEntity</a> </td> <td>successful operation</td> @@ -1579,15 +1593,19 @@ <div class="authorization details"> - <div>Read Only</div> + <div>Write Source - /{component-type}/{uuid}</div> + + + + <div>Write Destination - /{component-type}/{uuid}</div> - <div>DFM</div> + <div>Write New Destination - /{component-type}/{uuid} - if updating Destination</div> - <div>Admin</div> + <div>Write Process Group - /process-groups/{uuid} - if updating Destination</div> </div> @@ -1595,19 +1613,11 @@ </div> - -</div> - - -<div class="endpoints"> - <span class="path hidden">/cluster/connections/{id}/status/history</span> - - - <div class="endpoint get"> + <div class="endpoint delete"> <div class="operation-handle"> - <div class="method">GET</div> + <div class="method">DELETE</div> <div class="path mono"></div> - <div class="summary">Gets connection status history across the cluster</div> + <div class="summary">Deletes a connection</div> <div class="clear"></div> </div> @@ -1633,6 +1643,19 @@ <tr> + <td>version</td> + <td>query</td> + + + + <td>string</td> + + + + <td>The revision is used to verify the client is working with the latest version of the flow.</td> + </tr> + + <tr> <td>clientId</td> <td>query</td> @@ -1665,7 +1688,7 @@ <div class="title">Response</div> <div class="mediatypes details"> - <div class="mediatype"><div class="title">produces:</div><div class="mono">application/xml, application/json</div><div class="clear"></div></div> + <div class="mediatype"><div class="title">produces:</div><div class="mono">application/json</div><div class="clear"></div></div> </div> <table> @@ -1682,7 +1705,7 @@ <td>200</td> <td> - <a class="type-link" href="javascript:void(0);">ClusterStatusHistoryEntity</a> + <a class="type-link" href="javascript:void(0);">ConnectionEntity</a> </td> <td>successful operation</td> @@ -1744,35 +1767,29 @@ <div class="authorization details"> - <div>Read Only</div> + <div>Write Source - /{component-type}/{uuid}</div> - <div>DFM</div> - - - - <div>Admin</div> + <div>Write Destination - /{component-type}/{uuid}</div> </div> </div> </div> - - </div> <div class="endpoints"> - <span class="path hidden">/cluster/input-ports/{id}/status</span> + <span class="path hidden">/controller-services/{id}</span> <div class="endpoint get"> <div class="operation-handle"> <div class="method">GET</div> <div class="path mono"></div> - <div class="summary">Gets input port status across the cluster</div> + <div class="summary">Gets a controller service</div> <div class="clear"></div> </div> @@ -1798,19 +1815,6 @@ <tr> - <td>clientId</td> - <td>query</td> - - - - <td>string</td> - - - - <td>If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.</td> - </tr> - - <tr> <td>id</td> <td>path</td> @@ -1820,7 +1824,7 @@ - <td>The input port id.</td> + <td>The controller service id.</td> </tr> @@ -1830,7 +1834,7 @@ <div class="title">Response</div> <div class="mediatypes details"> - <div class="mediatype"><div class="title">produces:</div><div class="mono">application/xml, application/json</div><div class="clear"></div></div> + <div class="mediatype"><div class="title">produces:</div><div class="mono">application/json</div><div class="clear"></div></div> </div> <table> @@ -1847,7 +1851,7 @@ <td>200</td> <td> - <a class="type-link" href="javascript:void(0);">ClusterPortStatusEntity</a> + <a class="type-link" href="javascript:void(0);">ControllerServiceEntity</a> </td> <td>successful operation</td> @@ -1909,15 +1913,7 @@ <div class="authorization details"> - <div>Read Only</div> - - - - <div>DFM</div> - - - - <div>Admin</div> + <div>Read - /controller-services/{uuid}</div> </div> @@ -1925,19 +1921,11 @@ </div> - -</div> - - -<div class="endpoints"> - <span class="path hidden">/cluster/nodes/{id}</span> - - - <div class="endpoint get"> + <div class="endpoint put"> <div class="operation-handle"> - <div class="method">GET</div> + <div class="method">PUT</div> <div class="path mono"></div> - <div class="summary">Gets a node in the cluster</div> + <div class="summary">Updates a controller service</div> <div class="clear"></div> </div> @@ -1946,7 +1934,7 @@ <div class="title">Request</div> <div class="mediatypes details"> - <div class="mediatype"><div class="title">consumes:</div><div class="mono">*/*</div><div class="clear"></div></div> + <div class="mediatype"><div class="title">consumes:</div><div class="mono">application/json</div><div class="clear"></div></div> </div> @@ -1963,29 +1951,28 @@ <tr> - <td>clientId</td> - <td>query</td> + <td>id</td> + <td>path</td> - <td>string</td> + <td>string </td> - <td>If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.</td> + <td>The controller service id.</td> </tr> <tr> - <td>id</td> - <td>path</td> + <td></td> + <td>body</td> + <td> - - <td>string </td> - - + <a class="type-link" href="javascript:void(0);">ControllerServiceEntity</a> + </td> - <td>The node id.</td> + <td>The controller service configuration details.</td> </tr> @@ -1995,7 +1982,7 @@ <div class="title">Response</div> <div class="mediatypes details"> - <div class="mediatype"><div class="title">produces:</div><div class="mono">application/json, application/xml</div><div class="clear"></div></div> + <div class="mediatype"><div class="title">produces:</div><div class="mono">application/json</div><div class="clear"></div></div> </div> <table> @@ -2012,7 +1999,7 @@ <td>200</td> <td> - <a class="type-link" href="javascript:void(0);">NodeEntity</a> + <a class="type-link" href="javascript:void(0);">ControllerServiceEntity</a> </td> <td>successful operation</td> @@ -2074,15 +2061,11 @@ <div class="authorization details"> - <div>Read Only</div> - - - - <div>Data Flow Manager</div> + <div>Write - /controller-services/{uuid}</div> - <div>Administrator</div> + <div>Read - any referenced Controller Services - /controller-services/{uuid}</div> </div> @@ -2090,11 +2073,11 @@ </div> - <div class="endpoint put"> + <div class="endpoint delete"> <div class="operation-handle"> - <div class="method">PUT</div> + <div class="method">DELETE</div> <div class="path mono"></div> - <div class="summary">Updates a node in the cluster</div> + <div class="summary">Deletes a controller service</div> <div class="clear"></div> </div> @@ -2103,7 +2086,7 @@ <div class="title">Request</div> <div class="mediatypes details"> - <div class="mediatype"><div class="title">consumes:</div><div class="mono">application/json, application/xml</div><div class="clear"></div></div> + <div class="mediatype"><div class="title">consumes:</div><div class="mono">*/*</div><div class="clear"></div></div> </div> @@ -2120,28 +2103,42 @@ <tr> - <td>id</td> - <td>path</td> + <td>version</td> + <td>query</td> - <td>string </td> + <td>string</td> - <td>The node id.</td> + <td>The revision is used to verify the client is working with the latest version of the flow.</td> </tr> <tr> - <td></td> - <td>body</td> + <td>clientId</td> + <td>query</td> - <td> - <a class="type-link" href="javascript:void(0);">NodeEntity</a> - </td> + + <td>string</td> + + - <td>The node configuration. The only configuration that will be honored at this endpoint is the status or primary flag.</td> + <td>If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.</td> + </tr> + + <tr> + <td>id</td> + <td>path</td> + + + + <td>string </td> + + + + <td>The controller service id.</td> </tr> @@ -2151,7 +2148,7 @@ <div class="title">Response</div> <div class="mediatypes details"> - <div class="mediatype"><div class="title">produces:</div><div class="mono">application/json, application/xml</div><div class="clear"></div></div> + <div class="mediatype"><div class="title">produces:</div><div class="mono">application/json</div><div class="clear"></div></div> </div> <table> @@ -2168,7 +2165,7 @@ <td>200</td> <td> - <a class="type-link" href="javascript:void(0);">NodeEntity</a> + <a class="type-link" href="javascript:void(0);">ControllerServiceEntity</a> </td> <td>successful operation</td> @@ -2230,19 +2227,25 @@ <div class="authorization details"> - <div>Administrator</div> + <div>Write - /controller-services/{uuid}</div> </div> </div> </div> +</div> + + +<div class="endpoints"> + <span class="path hidden">/controller-services/{id}/descriptors</span> + - <div class="endpoint delete"> + <div class="endpoint get"> <div class="operation-handle"> - <div class="method">DELETE</div> + <div class="method">GET</div> <div class="path mono"></div> - <div class="summary">Removes a node from the cluster</div> + <div class="summary">Gets a controller service property descriptor</div> <div class="clear"></div> </div> @@ -2268,21 +2271,21 @@ <tr> - <td>clientId</td> - <td>query</td> + <td>id</td> + <td>path</td> - <td>string</td> + <td>string </td> - <td>If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.</td> + <td>The controller service id.</td> </tr> <tr> - <td>id</td> - <td>path</td> + <td>propertyName</td> + <td>query</td> @@ -2290,7 +2293,7 @@ - <td>The node id.</td> + <td>The property name to return the descriptor for.</td> </tr> @@ -2300,7 +2303,7 @@ <div class="title">Response</div> <div class="mediatypes details"> - <div class="mediatype"><div class="title">produces:</div><div class="mono">application/json, application/xml</div><div class="clear"></div></div> + <div class="mediatype"><div class="title">produces:</div><div class="mono">application/json</div><div class="clear"></div></div> </div> <table> @@ -2317,7 +2320,7 @@ <td>200</td> <td> - <a class="type-link" href="javascript:void(0);">NodeEntity</a> + <a class="type-link" href="javascript:void(0);">PropertyDescriptorEntity</a> </td> <td>successful operation</td> @@ -2379,25 +2382,27 @@ <div class="authorization details"> - <div>Administrator</div> + <div>Read - /controller-services/{uuid}</div> </div> </div> </div> + + </div> <div class="endpoints"> - <span class="path hidden">/cluster/nodes/{id}/status</span> + <span class="path hidden">/controller-services/{id}/references</span> <div class="endpoint get"> <div class="operation-handle"> <div class="method">GET</div> <div class="path mono"></div> - <div class="summary">Gets process group status for a node in the cluster</div> + <div class="summary">Gets a controller service</div> <div class="clear"></div> </div> @@ -2423,19 +2428,6 @@ <tr> - <td>clientId</td> - <td>query</td> - - - - <td>string</td> - - - - <td>If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.</td> - </tr> - - <tr> <td>id</td> <td>path</td> @@ -2445,7 +2437,7 @@ - <td>The node id.</td> + <td>The controller service id.</td> </tr> @@ -2455,7 +2447,7 @@ <div class="title">Response</div> <div class="mediatypes details"> - <div class="mediatype"><div class="title">produces:</div><div class="mono">application/json, application/xml</div><div class="clear"></div></div> + <div class="mediatype"><div class="title">produces:</div><div class="mono">application/json</div><div class="clear"></div></div> </div> <table> @@ -2472,7 +2464,7 @@ <td>200</td> <td> - <a class="type-link" href="javascript:void(0);">ProcessGroupStatusEntity</a> + <a class="type-link" href="javascript:void(0);">ControllerServiceEntity</a> </td> <td>successful operation</td> @@ -2534,15 +2526,7 @@ <div class="authorization details"> - <div>Read Only</div> - - - - <div>Data Flow Manager</div> - - - - <div>Administrator</div> + <div>Read - /controller-services/{uuid}</div> </div> @@ -2550,19 +2534,11 @@ </div> - -</div> - - -<div class="endpoints"> - <span class="path hidden">/cluster/nodes/{id}/system-diagnostics</span> - - - <div class="endpoint get"> + <div class="endpoint put"> <div class="operation-handle"> - <div class="method">GET</div> + <div class="method">PUT</div> <div class="path mono"></div> - <div class="summary">Gets system diagnostics for a node in the cluester</div> + <div class="summary">Updates a controller services references</div> <div class="clear"></div> </div> @@ -2571,7 +2547,7 @@ <div class="title">Request</div> <div class="mediatypes details"> - <div class="mediatype"><div class="title">consumes:</div><div class="mono">*/*</div><div class="clear"></div></div> + <div class="mediatype"><div class="title">consumes:</div><div class="mono">application/json</div><div class="clear"></div></div> </div> @@ -2588,29 +2564,28 @@ <tr> - <td>clientId</td> - <td>query</td> + <td>id</td> + <td>path</td> - <td>string</td> + <td>string </td> - <td>If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.</td> + <td>The controller service id.</td> </tr> <tr> - <td>id</td> - <td>path</td> + <td></td> + <td>body</td> + <td> - - <td>string </td> - - + <a class="type-link" href="javascript:void(0);">UpdateControllerServiceReferenceRequestEntity</a> + </td> - <td>The node id.</td> + <td>The controller service request update request.</td> </tr> @@ -2620,7 +2595,7 @@ <div class="title">Response</div> <div class="mediatypes details"> - <div class="mediatype"><div class="title">produces:</div><div class="mono">application/json, application/xml</div><div class="clear"></div></div> + <div class="mediatype"><div class="title">produces:</div><div class="mono">application/json</div><div class="clear"></div></div> </div> <table> @@ -2637,7 +2612,7 @@ <td>200</td> <td> - <a class="type-link" href="javascript:void(0);">SystemDiagnosticsEntity</a> + <a class="type-link" href="javascript:void(0);">ControllerServiceReferencingComponentsEntity</a> </td> <td>successful operation</td> @@ -2699,15 +2674,7 @@ <div class="authorization details"> - <div>Read Only</div> - - - - <div>Data Flow Manager</div> - - - - <div>Administrator</div> + <div>Write - /{component-type}/{uuid} - For each referencing component specified</div> </div> @@ -2715,19 +2682,18 @@ </div> - </div> <div class="endpoints"> - <span class="path hidden">/cluster/output-ports/{id}/status</span> + <span class="path hidden">/controller-services/{id}/state</span> <div class="endpoint get"> <div class="operation-handle"> <div class="method">GET</div> <div class="path mono"></div> - <div class="summary">Gets output port status across the cluster</div> + <div class="summary">Gets the state for a controller service</div> <div class="clear"></div> </div> @@ -2753,19 +2719,6 @@ <tr> - <td>clientId</td> - <td>query</td> - - - - <td>string</td> - - - - <td>If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.</td> - </tr> - - <tr> <td>id</td> <td>path</td> @@ -2775,7 +2728,7 @@ - <td>The output port id.</td> + <td>The controller service id.</td> </tr> @@ -2785,7 +2738,7 @@ <div class="title">Response</div> <div class="mediatypes details"> - <div class="mediatype"><div class="title">produces:</div><div class="mono">application/xml, application/json</div><div class="clear"></div></div> + <div class="mediatype"><div class="title">produces:</div><div class="mono">application/json</div><div class="clear"></div></div> </div> <table> @@ -2802,7 +2755,7 @@ <td>200</td> <td> - <a class="type-link" href="javascript:void(0);">ClusterPortStatusEntity</a> + <a class="type-link" href="javascript:void(0);">ComponentStateDTO</a> </td> <td>successful operation</td> @@ -2864,15 +2817,7 @@ <div class="authorization details"> - <div>Read Only</div> - - - - <div>DFM</div> - - - - <div>Admin</div> + <div>Write - /controller-services/{uuid}</div> </div> @@ -2885,14 +2830,13 @@ <div class="endpoints"> - <span class="path hidden">/cluster/process-groups/{id}/status</span> + <span class="path hidden">/controller-services/{id}/state/clear-requests</span> - - <div class="endpoint get"> + <div class="endpoint post"> <div class="operation-handle"> - <div class="method">GET</div> + <div class="method">POST</div> <div class="path mono"></div> - <div class="summary">Gets process group status across the cluster</div> + <div class="summary">Clears the state for a controller service</div> <div class="clear"></div> </div> @@ -2918,19 +2862,6 @@ <tr> - <td>clientId</td> - <td>query</td> - - - - <td>string</td> - - - - <td>If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.</td> - </tr> - - <tr> <td>id</td> <td>path</td> @@ -2940,7 +2871,7 @@ - <td>The process group id.</td> + <td>The controller service id.</td> </tr> @@ -2950,7 +2881,7 @@ <div class="title">Response</div> <div class="mediatypes details"> - <div class="mediatype"><div class="title">produces:</div><div class="mono">application/xml, application/json</div><div class="clear"></div></div> + <div class="mediatype"><div class="title">produces:</div><div class="mono">application/json</div><div class="clear"></div></div> </div> <table> @@ -2967,7 +2898,7 @@ <td>200</td> <td> - <a class="type-link" href="javascript:void(0);">ClusterProcessGroupStatusEntity</a> + <a class="type-link" href="javascript:void(0);">ComponentStateDTO</a> </td> <td>successful operation</td> @@ -3029,15 +2960,7 @@ <div class="authorization details"> - <div>Read Only</div> - - - - <div>DFM</div> - - - - <div>Admin</div> + <div>Write - /controller-services/{uuid}</div> </div> @@ -3046,23 +2969,28 @@ + </div> <div class="endpoints"> - <span class="path hidden">/cluster/process-groups/{id}/status/history</span> + <span class="path hidden">/controller/cluster</span> <div class="endpoint get"> <div class="operation-handle"> <div class="method">GET</div> <div class="path mono"></div> - <div class="summary">Gets process group status history across the cluster</div> + <div class="summary">Gets the contents of the cluster</div> <div class="clear"></div> </div> <div class="operation hidden"> + <div class="description"> + Returns the contents of the cluster including all nodes and their status. + </div> + <div class="title">Request</div> <div class="mediatypes details"> @@ -3070,69 +2998,29 @@ </div> + + + <div class="title">Response</div> + <div class="mediatypes details"> + + <div class="mediatype"><div class="title">produces:</div><div class="mono">application/json</div><div class="clear"></div></div> + + </div> <table> <thead> <tr> - <th>Name</th> - <th>Location</th> + <th>Status Code</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody> - - - <tr> - <td>clientId</td> - <td>query</td> - + <tr> + <td>200</td> + <td> - <td>string</td> - - - - <td>If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.</td> - </tr> - - <tr> - <td>id</td> - <td>path</td> - - - - <td>string </td> - - - - <td>The process group id.</td> - </tr> - - - </tbody> - </table> - - <div class="title">Response</div> - <div class="mediatypes details"> - - <div class="mediatype"><div class="title">produces:</div><div class="mono">application/xml, application/json</div><div class="clear"></div></div> - - </div> - <table> - <thead> - <tr> - <th>Status Code</th> - <th>Type</th> - <th>Description</th> - </tr> - </thead> - <tbody> - - <tr> - <td>200</td> - <td> - - <a class="type-link" href="javascript:void(0);">ClusterStatusHistoryEntity</a> + <a class="type-link" href="javascript:void(0);">ClusterEntity</a> </td> <td>successful operation</td> @@ -3169,16 +3057,6 @@ </tr> <tr> - <td>404</td> - <td> - - string - - </td> - <td>The specified resource could not be found.</td> - </tr> - - <tr> <td>409</td> <td> @@ -3194,15 +3072,7 @@ <div class="authorization details"> - <div>Read Only</div> - - - - <div>DFM</div> - - - - <div>Admin</div> + <div>Read - /controller</div> </div> @@ -3215,14 +3085,14 @@ <div class="endpoints"> - <span class="path hidden">/cluster/processors/{id}</span> + <span class="path hidden">/controller/cluster/nodes/{id}</span> <div class="endpoint get"> <div class="operation-handle"> <div class="method">GET</div> <div class="path mono"></div> - <div class="summary">Gets the specified processor</div> + <div class="summary">Gets a node in the cluster</div> <div class="clear"></div> </div> @@ -3248,19 +3118,6 @@ <tr> - <td>clientId</td> - <td>query</td> - - - - <td>string</td> - - - - <td>If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.</td> - </tr> - - <tr> <td>id</td> <td>path</td> @@ -3270,7 +3127,7 @@ - <td>The processor id.</td> + <td>The node id.</td> </tr> @@ -3280,7 +3137,7 @@ <div class="title">Response</div> <div class="mediatypes details"> - <div class="mediatype"><div class="title">produces:</div><div class="mono">application/xml, application/json</div><div class="clear"></div></div> + <div class="mediatype"><div class="title">produces:</div><div class="mono">application/json</div><div class="clear"></div></div> </div> <table> @@ -3297,7 +3154,7 @@ <td>200</td> <td> - <a class="type-link" href="javascript:void(0);">ProcessorEntity</a> + <a class="type-link" href="javascript:void(0);">NodeEntity</a> </td> <td>successful operation</td> @@ -3359,15 +3216,7 @@ <div class="authorization details"> - <div>Read Only</div> - - - - <div>DFM</div> - - - - <div>Admin</div> + <div>Read - /controller</div> </div> @@ -3379,7 +3228,7 @@ <div class="operation-handle"> <div class="method">PUT</div> <div class="path mono"></div> - <div class="summary">Updates processor data</div> + <div class="summary">Updates a node in the cluster</div> <div class="clear"></div> </div> @@ -3388,7 +3237,7 @@ <div class="title">Request</div> <div class="mediatypes details"> - <div class="mediatype"><div class="title">consumes:</div><div class="mono">application/json, application/xml</div><div class="clear"></div></div> + <div class="mediatype"><div class="title">consumes:</div><div class="mono">application/json</div><div class="clear"></div></div> </div> @@ -3414,7 +3263,7 @@ - <td>The processor id.</td> + <td>The node id.</td> </tr> <tr> @@ -3423,10 +3272,10 @@ <td> - <a class="type-link" href="javascript:void(0);">ProcessorEntity</a> + <a class="type-link" href="javascript:void(0);">NodeEntity</a> </td> - <td>The processor configuration details. The only configuration that will be honored at this endpoint is the processor annontation data.</td> + <td>The node configuration. The only configuration that will be honored at this endpoint is the status or primary flag.</td> </tr> @@ -3436,7 +3285,7 @@ <div class="title">Response</div> <div class="mediatypes details"> - <div class="mediatype"><div class="title">produces:</div><div class="mono">application/xml, application/json</div><div class="clear"></div></div> + <div class="mediatype"><div class="title">produces:</div><div class="mono">application/json</div><div class="clear"></div></div> </div> <table> @@ -3453,7 +3302,7 @@ <td>200</td> <td> - <a class="type-link" href="javascript:void(0);">ProcessorEntity</a> + <a class="type-link" href="javascript:void(0);">NodeEntity</a> </td> <td>successful operation</td> @@ -3515,15 +3364,7 @@ <div class="authorization details"> - <div>Read Only</div> - - - - <div>DFM</div> - - - - <div>Admin</div> + <div>Write - /controller</div> </div> @@ -3531,18 +3372,11 @@ </div> -</div> - - -<div class="endpoints"> - <span class="path hidden">/cluster/processors/{id}/status</span> - - - <div class="endpoint get"> + <div class="endpoint delete"> <div class="operation-handle"> - <div class="method">GET</div> + <div class="method">DELETE</div> <div class="path mono"></div> - <div class="summary">Gets the processor status across the cluster</div> + <div class="summary">Removes a node from the cluster</div> <div class="clear"></div> </div> @@ -3568,19 +3402,6 @@ <tr> - <td>clientId</td> - <td>query</td> - - - - <td>string</td> - - - - <td>If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.</td> - </tr> - - <tr> <td>id</td> <td>path</td> @@ -3590,7 +3411,7 @@ - <td>The processor id</td> + <td>The node id.</td> </tr> @@ -3600,7 +3421,7 @@ <div class="title">Response</div> <div class="mediatypes details"> - <div class="mediatype"><div class="title">produces:</div><div class="mono">application/xml, application/json</div><div class="clear"></div></div> + <div class="mediatype"><div class="title">produces:</div><div class="mono">application/json</div><div class="clear"></div></div> </div> <table> @@ -3617,7 +3438,7 @@ <td>200</td> <td> - <a class="type-link" href="javascript:void(0);">ClusterProcessorStatusEntity</a> + <a class="type-link" href="javascript:void(0);">NodeEntity</a> </td> <td>successful operation</td> @@ -3679,35 +3500,25 @@ <div class="authorization details"> - <div>Read Only</div> - - - - <div>DFM</div> - - - - <div>Admin</div> + <div>Write - /controller</div> </div> </div> </div> - - </div> <div class="endpoints"> - <span class="path hidden">/cluster/processors/{id}/status/history</span> + <span class="path hidden">/controller/config</span> <div class="endpoint get"> <div class="operation-handle"> <div class="method">GET</div> <div class="path mono"></div> - <div class="summary">Gets processor status history across the cluster</div> + <div class="summary">Retrieves the configuration for this NiFi Controller</div> <div class="clear"></div> </div> @@ -3720,52 +3531,12 @@ </div> - <table> - <thead> - <tr> - <th>Name</th> - <th>Location</th> - <th>Type</th> - <th>Description</th> - </tr> - </thead> - <tbody> - - - <tr> - <td>clientId</td> - <td>query</td> - - - - <td>string</td> - - - - <td>If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.</td> - </tr> - - <tr> - <td>id</td> - <td>path</td> - - - - <td>string </td> - - - - <td>The processor id</td> - </tr> - - </tbody> - </table> <div class="title">Response</div> <div class="mediatypes details"> - <div class="mediatype"><div class="title">produces:</div><div class="mono">application/xml, application/json</div><div class="clear"></div></div> + <div class="mediatype"><div class="title">produces:</div><div class="mono">application/json</div><div class="clear"></div></div> </div> <table> @@ -3782,7 +3553,7 @@ <td>200</td> <td> - <a class="type-link" href="javascript:void(0);">ClusterStatusHistoryEntity</a> + <a class="type-link" href="javascript:void(0);">ControllerConfigurationEntity</a> </td> <td>successful operation</td> @@ -3819,16 +3590,6 @@ </tr> <tr> - <td>404</td> - <td> - - string - - </td> - <td>The specified resource could not be found.</td> - </tr> - - <tr> <td>409</td> <td> @@ -3844,15 +3605,7 @@ <div class="authorization details"> - <div>Read Only</div> - - - - <div>DFM</div> - - - - <div>Admin</div> + <div>Read - /controller</div> </div> @@ -3860,19 +3613,11 @@ </div> - -</div> - - -<div class="endpoints"> - <span class="path hidden">/cluster/remote-process-groups/{id}/status</span> - - - <div class="endpoint get"> + <div class="endpoint put"> <div class="operation-handle"> - <div class="method">GET</div> + <div class="method">PUT</div> <div class="path mono"></div> - <div class="summary">Gets remote process group status across the cluster</div> + <div class="summary">Retrieves the configuration for this NiFi</div> <div class="clear"></div> </div> @@ -3881,7 +3626,7 @@ <div class="title">Request</div> <div class="mediatypes details"> - <div class="mediatype"><div class="title">consumes:</div><div class="mono">*/*</div><div class="clear"></div></div> + <div class="mediatype"><div class="title">consumes:</div><div class="mono">application/json</div><div class="clear"></div></div> </div> @@ -3898,29 +3643,15 @@ <tr> - <td>clientId</td> - <td>query</td> - - - - <td>string</td> - - - - <td>If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.</td> - </tr> - - <tr> - <td>id</td> - <td>path</td> + <td></td> + <td>body</td> + <td> - - <td>string </td> - - + <a class="type-link" href="javascript:void(0);">ControllerConfigurationEntity</a> + </td> - <td>The remote process group id.</td> + <td>The controller configuration.</td> </tr> @@ -3930,7 +3661,7 @@ <div class="title">Response</div> <div class="mediatypes details"> - <div class="mediatype"><div class="title">produces:</div><div class="mono">application/xml, application/json</div><div class="clear"></div></div> + <div class="mediatype"><div class="title">produces:</div><div class="mono">application/json</div><div class="clear"></div></div> </div> <table> @@ -3947,7 +3678,7 @@ <td>200</td> <td> - <a class="type-link" href="javascript:void(0);">ClusterRemoteProcessGroupStatusEntity</a> + <a class="type-link" href="javascript:void(0);">ControllerConfigurationEntity</a> </td> <td>successful operation</td> @@ -3984,16 +3715,6 @@ </tr> <tr> - <td>404</td> - <td> - - string - - </td> - <td>The specified resource could not be found.</td> - </tr> - - <tr> <td>409</td> <td> @@ -4009,15 +3730,7 @@ <div class="authorization details"> - <div>Read Only</div> - - - - <div>DFM</div> - - - - <div>Admin</div> + <div>Write - /controller</div> </div> @@ -4025,19 +3738,17 @@ </div> - </div> <div class="endpoints"> - <span class="path hidden">/cluster/remote-process-groups/{id}/status/history</span> - + <span class="path hidden">/controller/controller-services</span> - <div class="endpoint get"> + <div class="endpoint post"> <div class="operation-handle"> - <div class="method">GET</div> + <div class="method">POST</div> <div class="path mono"></div> - <div class="summary">Gets the remote process group status history across the cluster</div> + <div class="summary">Creates a new controller service</div> <div class="clear"></div> </div> @@ -4046,7 +3757,7 @@ <div class="title">Request</div> <div class="mediatypes details"> - <div class="mediatype"><div class="title">consumes:</div><div class="mono">*/*</div><div class="clear"></div></div> + <div class="mediatype"><div class="title">consumes:</div><div class="mono">application/json</div><div class="clear"></div></div> </div> @@ -4063,29 +3774,15 @@ <tr> - <td>clientId</td> - <td>query</td> - - - - <td>string</td> - - - - <td>If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.</td> - </tr> - - <tr> - <td>id</td> - <td>path</td> + <td></td> + <td>body</td> + <td> - - <td>string </td> - - + <a class="type-link" href="javascript:void(0);">ControllerServiceEntity</a> + </td> - <td>The remote process group id.</td> + <td>The controller service configuration details.</td> </tr> @@ -4095,7 +3792,7 @@ <div class="title">Response</div> <div class="mediatypes details"> - <div class="mediatype"><div class="title">produces:</div><div class="mono">application/xml, application/json</div><div class="clear"></div></div> + <div class="mediatype"><div class="title">produces:</div><div class="mono">application/json</div><div class="clear"></div></div> </div> <table> @@ -4112,7 +3809,7 @@ <td>200</td> <td> - <a class="type-link" href="javascript:void(0);">ClusterStatusHistoryEntity</a> + <a class="type-link" href="javascript:void(0);">ControllerServiceEntity</a> </td> <td>successful operation</td> @@ -4149,16 +3846,6 @@ </tr> <tr> - <td>404</td> - <td> - - string - - </td> - <td>The specified resource could not be found.</td> - </tr> - - <tr> <td>409</td> <td> @@ -4174,15 +3861,11 @@ <div class="authorization details"> - <div>Read Only</div> - - - - <div>DFM</div> + <div>Write - /controller</div> - <div>Admin</div> + <div>Read - any referenced Controller Services - /controller-services/{uuid}</div> </div> @@ -4191,18 +3874,21 @@ + </div> <div class="endpoints"> - <span class="path hidden">/cluster/search-results</span> + <span class="path hidden">/controller/history</span> - <div class="endpoint get"> + + + <div class="endpoint delete"> <div class="operation-handle"> - <div class="method">GET</div> + <div class="method">DELETE</div> <div class="path mono"></div> - <div class="summary">Searches the cluster for a node with the specified address</div> + <div class="summary">Purges history</div> <div class="clear"></div> </div> @@ -4228,16 +3914,16 @@ <tr> - <td>q</td> + <td>endDate</td> <td>query</td> - <td>string </td> + <td>string</td> - <td>Node address to search for.</td> + <td>Purge actions before this date/time.</td> </tr> @@ -4247,7 +3933,7 @@ <div class="title">Response</div> <div class="mediatypes details"> - <div class="mediatype"><div class="title">produces:</div><div class="mono">application/xml, application/json</div><div class="clear"></div></div> + <div class="mediatype"><div class="title">produces:</div><div class="mono">application/json</div><div class="clear"></div></div> </div> <table> @@ -4264,7 +3950,7 @@ <td>200</td> <td> - <a class="type-link" href="javascript:void(0);">ClusterSearchResultsEntity</a> + <a class="type-link" href="javascript:void(0);">HistoryEntity</a> </td> <td>successful operation</td> @@ -4301,16 +3987,6 @@ </tr> <tr> - <td>404</td> - <td> - - string - - </td> - <td>The specified resource could not be found.</td> - </tr> - - <tr> <td>409</td> <td> @@ -4326,35 +4002,24 @@ <div class="authorization details"> - <div>Read Only</div> - - - - <div>DFM</div> - - - - <div>Admin</div> + <div>Write - /controller</div> </div> </div> </div> - - </div> <div class="endpoints"> - <span class="path hidden">/cluster/status</span> + <span class="path hidden">/controller/reporting-tasks</span> - - <div class="endpoint get"> + <div class="endpoint post"> <div class="operation-handle"> - <div class="method">GET</div> + <div class="method">POST</div> <div class="path mono"></div> - <div class="summary">Gets the status of the cluster</div> + <div class="summary">Creates a new reporting task</div> <div class="clear"></div> </div> @@ -4363,7 +4028,7 @@ <div class="title">Request</div> <div class="mediatypes details"> - <div class="mediatype"><div class="title">consumes:</div><div class="mono">*/*</div><div class="clear"></div></div> + <div class="mediatype"><div class="title">consumes:</div><div class="mono">application/json</div><div class="clear"></div></div> </div> @@ -4380,16 +4045,15 @@ <tr> - <td>clientId</td> - <td>query</td> + <td></td> + <td>body</td> + <td> - - <td>string</td> - - + <a class="type-link" href="javascript:void(0);">ReportingTaskEntity</a> + </td> - <td>If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.</td> + <td>The reporting task configuration details.</td> </tr> @@ -4399,7 +4063,7 @@ <div class="title">Response</div> <div class="mediatypes details"> - <div class="mediatype"><div class="title">produces:</div><div class="mono">application/json, application/xml</div><div class="clear"></div></div> + <div class="mediatype"><div class="title">produces:</div><div class="mono">application/json</div><div class="clear"></div></div> </div> <table> @@ -4416,7 +4080,7 @@ <td>200</td> <td> - <a class="type-link" href="javascript:void(0);">ClusterStatusEntity</a> + <a class="type-link" href="javascript:void(0);">ReportingTaskEntity</a> </td> <td>successful operation</td> @@ -4468,15 +4132,11 @@ <div class="authorization details"> - <div>Read Only</div> + <div>Write - /controller</div> - <div>DFM</div> - - - - <div>Admin</div> + <div>Read - any referenced Controller Services - /controller-services/{uuid}</div> </div> @@ -4485,23 +4145,28 @@ + </div> <div class="endpoints"> - <span class="path hidden">/controller</span> + <span class="path hidden">/counters</span> <div class="endpoint get"> <div class="operation-handle"> <div class="method">GET</div> <div class="path mono"></div> - <div class="summary">Returns the details about this NiFi necessary to communicate via site to site</div> + <div class="summary">Gets the current counters for this NiFi</div> <div class="clear"></div> </div> <div class="operation hidden"> + <div class="description"> + Note: This endpoint is subject to change as NiFi and it's REST API evolve. + </div> + <div class="title">Request</div> <div class="mediatypes details"> @@ -4522,16 +4187,29 @@ <tr> - <td>clientId</td> + <td>nodewise</td> <td>query</td> - <td>string</td> + <td>boolean </td> - <td>If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.</td> + <td>Whether or not to include the breakdown per node. Optional, defaults to false</td> + </tr> + + <tr> + <td>clusterNodeId</td> + <td>query</td> + + + + <td>string </td> + + + + <td>The id of the node where to get the status.</td> </tr> @@ -4541,7 +4219,7 @@ <div class="title">Response</div> <div class="mediatypes details"> - <div class="mediatype"><div class="title">produces:</div><div class="mono">application/json, application/xml</div><div class="clear"></div></div> + <div class="mediatype"><div class="title">produces:</div><div class="mono">application/json</div><div class="clear"></div></div> </div> <table> @@ -4558,7 +4236,7 @@ <td>200</td> <td> - <a class="type-link" href="javascript:void(0);">ControllerEntity</a> + <a class="type-link" href="javascript:void(0);">CountersEntity</a> </td> <td>successful operation</td> @@ -4610,7 +4288,7 @@ <div class="authorization details"> - <div>NiFi</div> + <div>Read - /counters</div> </div> @@ -4623,19 +4301,24 @@ <div class="endpoints"> - <span class="path hidden">/controller/about</span> + <span class="path hidden">/counters/{id}</span> - <div class="endpoint get"> + + <div class="endpoint put"> <div class="operation-handle"> - <div class="method">GET</div> + <div class="method">PUT</div> <div class="path mono"></div> - <div class="summary">Retrieves details about this NiFi to put in the About dialog</div> + <div class="summary">Updates the specified counter. This will reset the counter value to 0</div> <div class="clear"></div> </div> <div class="operation hidden"> + <div class="description"> + Note: This endpoint is subject to change as NiFi and it's REST API evolve. + </div> + <div class="title">Request</div> <div class="mediatypes details"> @@ -4656,16 +4339,16 @@ <tr> - <td>clientId</td> - <td>query</td> + <td>id</td> + <td>path</td> - <td>string</td> + <td>string </td> - <td>If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.</td> + <td></td> </tr> @@ -4675,7 +4358,7 @@ <div class="title">Response</div> <div class="mediatypes details"> - <div class="mediatype"><div class="title">produces:</div><div class="mono">application/json, application/xml</div><div class="clear"></div></div> + <div class="mediatype"><div class="title">produces:</div><div class="mono">application/json</div><div class="clear"></div></div> </div> <table> @@ -4692,7 +4375,7 @@ <td>200</td> <td> - <a class="type-link" href="javascript:void(0);">AboutEntity</a> + <a class="type-link" href="javascript:void(0);">CounterEntity</a> </td> <td>successful operation</td> @@ -4729,6 +4412,16 @@ </tr> <tr> + <td>404</td> + <td> + + string + + </td> + <td>The specified resource could not be found.</td> + </tr> + + <tr> <td>409</td> <td> @@ -4744,15 +4437,7 @@ <div class="authorization details"> - <div>Read Only</div> - - - - <div>Data Flow Manager</div> - - - - <div>Administrator</div> + <div>Write - /counters</div> </div> @@ -4760,31 +4445,28 @@ </div> - </div> <div class="endpoints"> - <span class="path hidden">/controller/archive</span> + <span class="path hidden">/data-transfer/input-ports/{portId}/transactions/{transactionId}</span> - <div class="endpoint post"> + + + <div class="endpoint put"> <div class="operation-handle"> - <div class="method">POST</div> + <div class="method">PUT</div> <div class="path mono"></div> - <div class="summary">Creates a new archive of this NiFi flow configuration</div> + <div class="summary">Extend transaction TTL</div> <div class="clear"></div> </div> <div class="operation hidden"> - <div class="description"> - This POST operation returns a URI that is not representative of the thing that was actually created. The archive that is created cannot be referenced at a later time, therefore there is no corresponding URI. Instead the request URI is returned. - </div> - <div class="title">Request</div> <div class="mediatypes details"> - <div class="mediatype"><div class="title">consumes:</div><div class="mono">application/x-www-form-urlencoded</div><div class="clear"></div></div> + <div class="mediatype"><div class="title">consumes:</div><div class="mono">*/*</div><div class="clear"></div></div> </div> @@ -4801,29 +4483,29 @@ <tr> - <td>version</td> - <td>formData</td> + <td>portId</td> + <td>path</td> - <td>string</td> + <td>string </td> - <td>The revision is used to verify the client is working with the latest version of the flow.</td> + <td></td> </tr> <tr> - <td>clientId</td> - <td>formData</td> + <td>transactionId</td> + <td>path</td> - <td>string</td> + <td>string </td> - <td>If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.</td> + <td></td> </tr> @@ -4833,7 +4515,7 @@ <div class="title">Response</div> <div class="mediatypes details"> - <div class="mediatype"><div class="title">produces:</div><div class="mono">application/json, application/xml</div><div class="clear"></div></div> + <div class="mediatype"><div class="title">produces:</div><div class="mono">application/json</div><div class="clear"></div></div> </div> <table> @@ -4850,7 +4532,7 @@ <td>200</td> <td> - <a class="type-link" href="javascript:void(0);">ProcessGroupEntity</a> + <a class="type-link" href="javascript:void(0);">TransactionResultEntity</a> </td> <td>successful operation</td> @@ -4887,6 +4569,16 @@ </tr> <tr> + <td>404</td> + <td> + + string + + </td> + <td>The specified resource could not be found.</td> + </tr> + + <tr> <td>409</td> <td> @@ -4902,7 +4594,7 @@ <div class="authorization details"> - <div>Data Flow Manager</div> + <div>Write - /data-transfer/input-ports/{uuid}</div> </div> @@ -4910,20 +4602,11 @@ </div> - - -</div> - - -<div class="endpoints"> - <span class="path hidden">/controller/authorities</span> - - - <div class="endpoint get"> + <div class="endpoint delete"> <div class="operation-handle"> - <div class="method">GET</div> + <div class="method">DELETE</div> <div class="path mono"></div>
[... 40868 lines stripped ...]
