NiFi Rest Api
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 authorizations required to invoke each service.
For more information, please visit https://nifi.apache.org
Automatically generated by the Swagger Codegen
Building the API client library requires:
To install the API client library to your local Maven repository, simply execute:
mvn clean installTo deploy it to a remote Maven repository instead, configure the settings of the repository and execute:
mvn clean deployRefer to the OSSRH Guide for more information.
Add this dependency to your project's POM:
<dependency>
<groupId>com.github.hermannpencole</groupId>
<artifactId>nifi-swagger-client</artifactId>
<version>1.1.0</version>
<scope>compile</scope>
</dependency>Add this dependency to your project's build file:
compile "com.github.hermannpencole:nifi-swagger-client:1.1.0"At first generate the JAR by executing:
mvn clean packageThen manually install the following JARs:
target/nifi-swagger-client-1.1.0.jartarget/lib/*.jarPlease follow the installation instruction and execute the following Java code:
import com.github.hermannpencole.nifi.swagger.*;
import com.github.hermannpencole.nifi.swagger.auth.*;
import com.github.hermannpencole.nifi.swagger.client.model.*;
import com.github.hermannpencole.nifi.swagger.client.AccessApi;
import java.io.File;
import java.util.*;
public class AccessApiExample {
public static void main(String[] args) {
AccessApi apiInstance = new AccessApi();
String username = "username_example"; // String |
String password = "password_example"; // String |
try {
String result = apiInstance.createAccessToken(username, password);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling AccessApi#createAccessToken");
e.printStackTrace();
}
}
}
All URIs are relative to http://localhost/nifi-api
| Class | Method | HTTP request | Description |
|---|---|---|---|
| AccessApi | createAccessToken | POST /access/token | Creates a token for accessing the REST API via username/password |
| AccessApi | createAccessTokenFromTicket | POST /access/kerberos | Creates a token for accessing the REST API via Kerberos ticket exchange / SPNEGO negotiation |
| AccessApi | createDownloadToken | POST /access/download-token | Creates a single use access token for downloading FlowFile content. |
| AccessApi | createUiExtensionToken | POST /access/ui-extension-token | Creates a single use access token for accessing a NiFi UI extension. |
| AccessApi | getAccessStatus | GET /access | Gets the status the client's access |
| AccessApi | getLoginConfig | GET /access/config | Retrieves the access configuration for this NiFi |
| AccessApi | knoxCallback | GET /access/knox/callback | Redirect/callback URI for processing the result of the Apache Knox login sequence. |
| AccessApi | knoxRequest | GET /access/knox/request | Initiates a request to authenticate through Apache Knox. |
| AccessApi | oidcCallback | GET /access/oidc/callback | Redirect/callback URI for processing the result of the OpenId Connect login sequence. |
| AccessApi | oidcExchange | POST /access/oidc/exchange | Retrieves a JWT following a successful login sequence using the configured OpenId Connect provider. |
| AccessApi | oidcRequest | GET /access/oidc/request | Initiates a request to authenticate through the configured OpenId Connect provider. |
| ConnectionsApi | deleteConnection | DELETE /connections/{id} | Deletes a connection |
| ConnectionsApi | getConnection | GET /connections/{id} | Gets a connection |
| ConnectionsApi | updateConnection | PUT /connections/{id} | Updates a connection |
| ControllerApi | createBulletin | POST /controller/bulletin | Creates a new bulletin |
| ControllerApi | createControllerService | POST /controller/controller-services | Creates a new controller service |
| ControllerApi | createRegistryClient | POST /controller/registry-clients | Creates a new registry client |
| ControllerApi | createReportingTask | POST /controller/reporting-tasks | Creates a new reporting task |
| ControllerApi | deleteHistory | DELETE /controller/history | Purges history |
| ControllerApi | deleteNode | DELETE /controller/cluster/nodes/{id} | Removes a node from the cluster |
| ControllerApi | deleteRegistryClient | DELETE /controller/registry-clients/{id} | Deletes a registry client |
| ControllerApi | getCluster | GET /controller/cluster | Gets the contents of the cluster |
| ControllerApi | getControllerConfig | GET /controller/config | Retrieves the configuration for this NiFi Controller |
| ControllerApi | getNode | GET /controller/cluster/nodes/{id} | Gets a node in the cluster |
| ControllerApi | getRegistryClient | GET /controller/registry-clients/{id} | Gets a registry client |
| ControllerApi | getRegistryClients | GET /controller/registry-clients | Gets the listing of available registry clients |
| ControllerApi | updateControllerConfig | PUT /controller/config | Retrieves the configuration for this NiFi |
| ControllerApi | updateNode | PUT /controller/cluster/nodes/{id} | Updates a node in the cluster |
| ControllerApi | updateRegistryClient | PUT /controller/registry-clients/{id} | Updates a registry client |
| ControllerServicesApi | clearState | POST /controller-services/{id}/state/clear-requests | Clears the state for a controller service |
| ControllerServicesApi | getControllerService | GET /controller-services/{id} | Gets a controller service |
| ControllerServicesApi | getControllerServiceReferences | GET /controller-services/{id}/references | Gets a controller service |
| ControllerServicesApi | getPropertyDescriptor | GET /controller-services/{id}/descriptors | Gets a controller service property descriptor |
| ControllerServicesApi | getState | GET /controller-services/{id}/state | Gets the state for a controller service |
| ControllerServicesApi | removeControllerService | DELETE /controller-services/{id} | Deletes a controller service |
| ControllerServicesApi | updateControllerService | PUT /controller-services/{id} | Updates a controller service |
| ControllerServicesApi | updateControllerServiceReferences | PUT /controller-services/{id}/references | Updates a controller services references |
| CountersApi | getCounters | GET /counters | Gets the current counters for this NiFi |
| CountersApi | updateCounter | PUT /counters/{id} | Updates the specified counter. This will reset the counter value to 0 |
| DataTransferApi | commitInputPortTransaction | DELETE /data-transfer/input-ports/{portId}/transactions/{transactionId} | Commit or cancel the specified transaction |
| DataTransferApi | commitOutputPortTransaction | DELETE /data-transfer/output-ports/{portId}/transactions/{transactionId} | Commit or cancel the specified transaction |
| DataTransferApi | createPortTransaction | POST /data-transfer/{portType}/{portId}/transactions | Create a transaction to the specified output port or input port |
| DataTransferApi | extendInputPortTransactionTTL | PUT /data-transfer/input-ports/{portId}/transactions/{transactionId} | Extend transaction TTL |
| DataTransferApi | extendOutputPortTransactionTTL | PUT /data-transfer/output-ports/{portId}/transactions/{transactionId} | Extend transaction TTL |
| DataTransferApi | receiveFlowFiles | POST /data-transfer/input-ports/{portId}/transactions/{transactionId}/flow-files | Transfer flow files to the input port |
| DataTransferApi | transferFlowFiles | GET /data-transfer/output-ports/{portId}/transactions/{transactionId}/flow-files | Transfer flow files from the output port |
| FlowApi | activateControllerServices | PUT /flow/process-groups/{id}/controller-services | Enable or disable Controller Services in the specified Process Group. |
| FlowApi | generateClientId | GET /flow/client-id | Generates a client id. |
| FlowApi | getAboutInfo | GET /flow/about | Retrieves details about this NiFi to put in the About dialog |
| FlowApi | getAction | GET /flow/history/{id} | Gets an action |
| FlowApi | getBanners | GET /flow/banners | Retrieves the banners for this NiFi |
| FlowApi | getBuckets | GET /flow/registries/{id}/buckets | Gets the buckets from the specified registry for the current user |
| FlowApi | getBulletinBoard | GET /flow/bulletin-board | Gets current bulletins |
| FlowApi | getBulletins | GET /flow/controller/bulletins | Retrieves Controller level bulletins |
| FlowApi | getClusterSummary | GET /flow/cluster/summary | The cluster summary for this NiFi |
| FlowApi | getComponentHistory | GET /flow/history/components/{componentId} | Gets configuration history for a component |
| FlowApi | getConnectionStatus | GET /flow/connections/{id}/status | Gets status for a connection |
| FlowApi | getConnectionStatusHistory | GET /flow/connections/{id}/status/history | Gets the status history for a connection |
| FlowApi | getControllerServiceTypes | GET /flow/controller-service-types | Retrieves the types of controller services that this NiFi supports |
| FlowApi | getControllerServicesFromController | GET /flow/controller/controller-services | Gets all controller services |
| FlowApi | getControllerServicesFromGroup | GET /flow/process-groups/{id}/controller-services | Gets all controller services |
| FlowApi | getControllerStatus | GET /flow/status | Gets the current status of this NiFi |
| FlowApi | getCurrentUser | GET /flow/current-user | Retrieves the user identity of the user making the request |
| FlowApi | getFlow | GET /flow/process-groups/{id} | Gets a process group |
| FlowApi | getFlowConfig | GET /flow/config | Retrieves the configuration for this NiFi flow |
| FlowApi | getFlows | GET /flow/registries/{registry-id}/buckets/{bucket-id}/flows | Gets the flows from the specified registry and bucket for the current user |
| FlowApi | getInputPortStatus | GET /flow/input-ports/{id}/status | Gets status for an input port |
| FlowApi | getOutputPortStatus | GET /flow/output-ports/{id}/status | Gets status for an output port |
| FlowApi | getPrioritizers | GET /flow/prioritizers | Retrieves the types of prioritizers that this NiFi supports |
| FlowApi | getProcessGroupStatus | GET /flow/process-groups/{id}/status | Gets the status for a process group |
| FlowApi | getProcessGroupStatusHistory | GET /flow/process-groups/{id}/status/history | Gets status history for a remote process group |
| FlowApi | getProcessorStatus | GET /flow/processors/{id}/status | Gets status for a processor |
| FlowApi | getProcessorStatusHistory | GET /flow/processors/{id}/status/history | Gets status history for a processor |
| FlowApi | getProcessorTypes | GET /flow/processor-types | Retrieves the types of processors that this NiFi supports |
| FlowApi | getRegistries | GET /flow/registries | Gets the listing of available registries |
| FlowApi | getRemoteProcessGroupStatus | GET /flow/remote-process-groups/{id}/status | Gets status for a remote process group |
| FlowApi | getRemoteProcessGroupStatusHistory | GET /flow/remote-process-groups/{id}/status/history | Gets the status history |
| FlowApi | getReportingTaskTypes | GET /flow/reporting-task-types | Retrieves the types of reporting tasks that this NiFi supports |
| FlowApi | getReportingTasks | GET /flow/reporting-tasks | Gets all reporting tasks |
| FlowApi | getTemplates | GET /flow/templates | Gets all templates |
| FlowApi | getVersions | GET /flow/registries/{registry-id}/buckets/{bucket-id}/flows/{flow-id}/versions | Gets the flow versions from the specified registry and bucket for the specified flow for the current user |
| FlowApi | queryHistory | GET /flow/history | Gets configuration history |
| FlowApi | scheduleComponents | PUT /flow/process-groups/{id} | Schedule or unschedule components in the specified Process Group. |
| FlowApi | searchCluster | GET /flow/cluster/search-results | Searches the cluster for a node with the specified address |
| FlowApi | searchFlow | GET /flow/search-results | Performs a search against this NiFi using the specified search term |
| FlowfileQueuesApi | createDropRequest | POST /flowfile-queues/{id}/drop-requests | Creates a request to drop the contents of the queue in this connection. |
| FlowfileQueuesApi | createFlowFileListing | POST /flowfile-queues/{id}/listing-requests | Lists the contents of the queue in this connection. |
| FlowfileQueuesApi | deleteListingRequest | DELETE /flowfile-queues/{id}/listing-requests/{listing-request-id} | Cancels and/or removes a request to list the contents of this connection. |
| FlowfileQueuesApi | downloadFlowFileContent | GET /flowfile-queues/{id}/flowfiles/{flowfile-uuid}/content | Gets the content for a FlowFile in a Connection. |
| FlowfileQueuesApi | getDropRequest | GET /flowfile-queues/{id}/drop-requests/{drop-request-id} | Gets the current status of a drop request for the specified connection. |
| FlowfileQueuesApi | getFlowFile | GET /flowfile-queues/{id}/flowfiles/{flowfile-uuid} | Gets a FlowFile from a Connection. |
| FlowfileQueuesApi | getListingRequest | GET /flowfile-queues/{id}/listing-requests/{listing-request-id} | Gets the current status of a listing request for the specified connection. |
| FlowfileQueuesApi | removeDropRequest | DELETE /flowfile-queues/{id}/drop-requests/{drop-request-id} | Cancels and/or removes a request to drop the contents of this connection. |
| FunnelApi | getFunnel | GET /funnels/{id} | Gets a funnel |
| FunnelApi | removeFunnel | DELETE /funnels/{id} | Deletes a funnel |
| FunnelApi | updateFunnel | PUT /funnels/{id} | Updates a funnel |
| InputPortsApi | getInputPort | GET /input-ports/{id} | Gets an input port |
| InputPortsApi | removeInputPort | DELETE /input-ports/{id} | Deletes an input port |
| InputPortsApi | updateInputPort | PUT /input-ports/{id} | Updates an input port |
| LabelsApi | getLabel | GET /labels/{id} | Gets a label |
| LabelsApi | removeLabel | DELETE /labels/{id} | Deletes a label |
| LabelsApi | updateLabel | PUT /labels/{id} | Updates a label |
| OutputPortsApi | getOutputPort | GET /output-ports/{id} | Gets an output port |
| OutputPortsApi | removeOutputPort | DELETE /output-ports/{id} | Deletes an output port |
| OutputPortsApi | updateOutputPort | PUT /output-ports/{id} | Updates an output port |
| PoliciesApi | createAccessPolicy | POST /policies | Creates an access policy |
| PoliciesApi | getAccessPolicy | GET /policies/{id} | Gets an access policy |
| PoliciesApi | getAccessPolicyForResource | GET /policies/{action}/{resource} | Gets an access policy for the specified action and resource |
| PoliciesApi | removeAccessPolicy | DELETE /policies/{id} | Deletes an access policy |
| PoliciesApi | updateAccessPolicy | PUT /policies/{id} | Updates a access policy |
| ProcessGroupsApi | copySnippet | POST /process-groups/{id}/snippet-instance | Copies a snippet and discards it. |
| ProcessGroupsApi | createConnection | POST /process-groups/{id}/connections | Creates a connection |
| ProcessGroupsApi | createControllerService | POST /process-groups/{id}/controller-services | Creates a new controller service |
| ProcessGroupsApi | createFunnel | POST /process-groups/{id}/funnels | Creates a funnel |
| ProcessGroupsApi | createInputPort | POST /process-groups/{id}/input-ports | Creates an input port |
| ProcessGroupsApi | createLabel | POST /process-groups/{id}/labels | Creates a label |
| ProcessGroupsApi | createOutputPort | POST /process-groups/{id}/output-ports | Creates an output port |
| ProcessGroupsApi | createProcessGroup | POST /process-groups/{id}/process-groups | Creates a process group |
| ProcessGroupsApi | createProcessor | POST /process-groups/{id}/processors | Creates a new processor |
| ProcessGroupsApi | createRemoteProcessGroup | POST /process-groups/{id}/remote-process-groups | Creates a new process group |
| ProcessGroupsApi | createTemplate | POST /process-groups/{id}/templates | Creates a template and discards the specified snippet. |
| ProcessGroupsApi | deleteVariableRegistryUpdateRequest | DELETE /process-groups/{groupId}/variable-registry/update-requests/{updateId} | Deletes an update request for a process group's variable registry. If the request is not yet complete, it will automatically be cancelled. |
| ProcessGroupsApi | getConnections | GET /process-groups/{id}/connections | Gets all connections |
| ProcessGroupsApi | getFunnels | GET /process-groups/{id}/funnels | Gets all funnels |
| ProcessGroupsApi | getInputPorts | GET /process-groups/{id}/input-ports | Gets all input ports |
| ProcessGroupsApi | getLabels | GET /process-groups/{id}/labels | Gets all labels |
| ProcessGroupsApi | getLocalModifications | GET /process-groups/{id}/local-modifications | Gets a list of local modifications to the Process Group since it was last synchronized with the Flow Registry |
| ProcessGroupsApi | getOutputPorts | GET /process-groups/{id}/output-ports | Gets all output ports |
| ProcessGroupsApi | getProcessGroup | GET /process-groups/{id} | Gets a process group |
| ProcessGroupsApi | getProcessGroups | GET /process-groups/{id}/process-groups | Gets all process groups |
| ProcessGroupsApi | getProcessors | GET /process-groups/{id}/processors | Gets all processors |
| ProcessGroupsApi | getRemoteProcessGroups | GET /process-groups/{id}/remote-process-groups | Gets all remote process groups |
| ProcessGroupsApi | getVariableRegistry | GET /process-groups/{id}/variable-registry | Gets a process group's variable registry |
| ProcessGroupsApi | getVariableRegistryUpdateRequest | GET /process-groups/{groupId}/variable-registry/update-requests/{updateId} | Gets a process group's variable registry |
| ProcessGroupsApi | importTemplate | POST /process-groups/{id}/templates/import | Imports a template |
| ProcessGroupsApi | instantiateTemplate | POST /process-groups/{id}/template-instance | Instantiates a template |
| ProcessGroupsApi | removeProcessGroup | DELETE /process-groups/{id} | Deletes a process group |
| ProcessGroupsApi | submitUpdateVariableRegistryRequest | POST /process-groups/{id}/variable-registry/update-requests | Submits a request to update a process group's variable registry |
| ProcessGroupsApi | updateProcessGroup | PUT /process-groups/{id} | Updates a process group |
| ProcessGroupsApi | updateVariableRegistry | PUT /process-groups/{id}/variable-registry | Updates the contents of a Process Group's variable Registry |
| ProcessGroupsApi | uploadTemplate | POST /process-groups/{id}/templates/upload | Uploads a template |
| ProcessorsApi | clearState | POST /processors/{id}/state/clear-requests | Clears the state for a processor |
| ProcessorsApi | deleteProcessor | DELETE /processors/{id} | Deletes a processor |
| ProcessorsApi | getProcessor | GET /processors/{id} | Gets a processor |
| ProcessorsApi | getPropertyDescriptor | GET /processors/{id}/descriptors | Gets the descriptor for a processor property |
| ProcessorsApi | getState | GET /processors/{id}/state | Gets the state for a processor |
| ProcessorsApi | updateProcessor | PUT /processors/{id} | Updates a processor |
| ProvenanceApi | deleteLineage | DELETE /provenance/lineage/{id} | Deletes a lineage query |
| ProvenanceApi | deleteProvenance | DELETE /provenance/{id} | Deletes a provenance query |
| ProvenanceApi | getLineage | GET /provenance/lineage/{id} | Gets a lineage query |
| ProvenanceApi | getProvenance | GET /provenance/{id} | Gets a provenance query |
| ProvenanceApi | getSearchOptions | GET /provenance/search-options | Gets the searchable attributes for provenance events |
| ProvenanceApi | submitLineageRequest | POST /provenance/lineage | Submits a lineage query |
| ProvenanceApi | submitProvenanceRequest | POST /provenance | Submits a provenance query |
| ProvenanceEventsApi | getInputContent | GET /provenance-events/{id}/content/input | Gets the input content for a provenance event |
| ProvenanceEventsApi | getOutputContent | GET /provenance-events/{id}/content/output | Gets the output content for a provenance event |
| ProvenanceEventsApi | getProvenanceEvent | GET /provenance-events/{id} | Gets a provenance event |
| ProvenanceEventsApi | submitReplay | POST /provenance-events/replays | Replays content from a provenance event |
| RemoteProcessGroupsApi | getRemoteProcessGroup | GET /remote-process-groups/{id} | Gets a remote process group |
| RemoteProcessGroupsApi | removeRemoteProcessGroup | DELETE /remote-process-groups/{id} | Deletes a remote process group |
| RemoteProcessGroupsApi | updateRemoteProcessGroup | PUT /remote-process-groups/{id} | Updates a remote process group |
| RemoteProcessGroupsApi | updateRemoteProcessGroupInputPort | PUT /remote-process-groups/{id}/input-ports/{port-id} | Updates a remote port |
| RemoteProcessGroupsApi | updateRemoteProcessGroupOutputPort | PUT /remote-process-groups/{id}/output-ports/{port-id} | Updates a remote port |
| ReportingTasksApi | clearState | POST /reporting-tasks/{id}/state/clear-requests | Clears the state for a reporting task |
| ReportingTasksApi | getPropertyDescriptor | GET /reporting-tasks/{id}/descriptors | Gets a reporting task property descriptor |
| ReportingTasksApi | getReportingTask | GET /reporting-tasks/{id} | Gets a reporting task |
| ReportingTasksApi | getState | GET /reporting-tasks/{id}/state | Gets the state for a reporting task |
| ReportingTasksApi | removeReportingTask | DELETE /reporting-tasks/{id} | Deletes a reporting task |
| ReportingTasksApi | updateReportingTask | PUT /reporting-tasks/{id} | Updates a reporting task |
| ResourcesApi | getResources | GET /resources | Gets the available resources that support access/authorization policies |
| SiteToSiteApi | getPeers | GET /site-to-site/peers | Returns the available Peers and its status of this NiFi |
| SiteToSiteApi | getSiteToSiteDetails | GET /site-to-site | Returns the details about this NiFi necessary to communicate via site to site |
| SnippetsApi | createSnippet | POST /snippets | Creates a snippet. The snippet will be automatically discarded if not used in a subsequent request after 1 minute. |
| SnippetsApi | deleteSnippet | DELETE /snippets/{id} | Deletes the components in a snippet and discards the snippet |
| SnippetsApi | updateSnippet | PUT /snippets/{id} | Move's the components in this Snippet into a new Process Group and discards the snippet |
| SystemDiagnosticsApi | getSystemDiagnostics | GET /system-diagnostics | Gets the diagnostics for the system NiFi is running on |
| TemplatesApi | exportTemplate | GET /templates/{id}/download | Exports a template |
| TemplatesApi | removeTemplate | DELETE /templates/{id} | Deletes a template |
| TenantsApi | createUser | POST /tenants/users | Creates a user |
| TenantsApi | createUserGroup | POST /tenants/user-groups | Creates a user group |
| TenantsApi | getUser | GET /tenants/users/{id} | Gets a user |
| TenantsApi | getUserGroup | GET /tenants/user-groups/{id} | Gets a user group |
| TenantsApi | getUserGroups | GET /tenants/user-groups | Gets all user groups |
| TenantsApi | getUsers | GET /tenants/users | Gets all users |
| TenantsApi | removeUser | DELETE /tenants/users/{id} | Deletes a user |
| TenantsApi | removeUserGroup | DELETE /tenants/user-groups/{id} | Deletes a user group |
| TenantsApi | searchTenants | GET /tenants/search-results | Searches for a tenant with the specified identity |
| TenantsApi | updateUser | PUT /tenants/users/{id} | Updates a user |
| TenantsApi | updateUserGroup | PUT /tenants/user-groups/{id} | Updates a user group |
| VersionsApi | createVersionControlRequest | POST /versions/active-requests | Creates a request so that a Process Group can be placed under Version Control or have its Version Control configuration changed. Creating this request will prevent any other threads from simultaneously saving local changes to Version Control. It will not, however, actually save the local flow to the Flow Registry. A POST to /versions/process-groups/{id} should be used to initiate saving of the local flow to the Flow Registry. |
| VersionsApi | deleteRevertRequest | DELETE /versions/revert-requests/{id} | Deletes the Revert Request with the given ID. After a request is created via a POST to /versions/revert-requests/process-groups/{id}, it is expected that the client will properly clean up the request by DELETE'ing it, once the Revert process has completed. If the request is deleted before the request completes, then the Revert request will finish the step that it is currently performing and then will cancel any subsequent steps. |
| VersionsApi | deleteUpdateRequest | DELETE /versions/update-requests/{id} | Deletes the Update Request with the given ID. After a request is created via a POST to /versions/update-requests/process-groups/{id}, it is expected that the client will properly clean up the request by DELETE'ing it, once the Update process has completed. If the request is deleted before the request completes, then the Update request will finish the step that it is currently performing and then will cancel any subsequent steps. |
| VersionsApi | deleteVersionControlRequest | DELETE /versions/active-requests/{id} | Deletes the Version Control Request with the given ID. This will allow other threads to save flows to the Flow Registry. See also the documentation for POSTing to /versions/active-requests for information regarding why this is done. |
| VersionsApi | getRevertRequest | GET /versions/revert-requests/{id} | Returns the Revert Request with the given ID. Once a Revert Request has been created by performing a POST to /versions/revert-requests/process-groups/{id}, that request can subsequently be retrieved via this endpoint, and the request that is fetched will contain the updated state, such as percent complete, the current state of the request, and any failures. |
| VersionsApi | getUpdateRequest | GET /versions/update-requests/{id} | Returns the Update Request with the given ID. Once an Update Request has been created by performing a POST to /versions/update-requests/process-groups/{id}, that request can subsequently be retrieved via this endpoint, and the request that is fetched will contain the updated state, such as percent complete, the current state of the request, and any failures. |
| VersionsApi | getVersionInformation | GET /versions/process-groups/{id} | Gets the Version Control information for a process group |
| VersionsApi | initiateRevertFlowVersion | POST /versions/revert-requests/process-groups/{id} | For a Process Group that is already under Version Control, this will initiate the action of reverting any local changes that have been made to the Process Group since it was last synchronized with the Flow Registry. This will result in the flow matching the Versioned Flow that exists in the Flow Registry. This can be a lengthy process, as it will stop any Processors and disable any Controller Services necessary to perform the action and then restart them. As a result, the endpoint will immediately return a VersionedFlowUpdateRequestEntity, and the process of updating the flow will occur asynchronously in the background. The client may then periodically poll the status of the request by issuing a GET request to /versions/revert-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /versions/revert-requests/{requestId}. |
| VersionsApi | initiateVersionControlUpdate | POST /versions/update-requests/process-groups/{id} | For a Process Group that is already under Version Control, this will initiate the action of changing from a specific version of the flow in the Flow Registry to a different version of the flow. This can be a lengthy process, as it will stop any Processors and disable any Controller Services necessary to perform the action and then restart them. As a result, the endpoint will immediately return a VersionedFlowUpdateRequestEntity, and the process of updating the flow will occur asynchronously in the background. The client may then periodically poll the status of the request by issuing a GET request to /versions/update-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /versions/update-requests/{requestId}. |
| VersionsApi | saveToFlowRegistry | POST /versions/process-groups/{id} | Begins version controlling the Process Group with the given ID or commits changes to the Versioned Flow, depending on if the provided VersionControlInformation includes a flowId |
| VersionsApi | stopVersionControl | DELETE /versions/process-groups/{id} | Stops version controlling the Process Group with the given ID. The Process Group will no longer track to any Versioned Flow. |
| VersionsApi | updateFlowVersion | PUT /versions/process-groups/{id} | For a Process Group that is already under Version Control, this will update the version of the flow to a different version. This endpoint expects that the given snapshot will not modify any Processor that is currently running or any Controller Service that is enabled. |
| VersionsApi | updateVersionControlRequest | PUT /versions/active-requests/{id} | Updates the request with the given ID |
Authentication schemes defined for the API:
It's recommended to create an instance of ApiClient per thread in a multithreaded environment to avoid any potential issues.