Skip to content

Latest commit

 

History

History
728 lines (715 loc) · 76.5 KB

README.md

File metadata and controls

728 lines (715 loc) · 76.5 KB

Go API client for nifi

REST API definition for Apache NiFi web services

Overview

This API client was generated by the swagger-codegen project. By using the swagger-spec from a remote server, you can easily generate an API client.

  • API version: 2.1.0
  • Package version: 1.0.0
  • Build package: io.swagger.codegen.v3.generators.go.GoClientCodegen For more information, please visit https://nifi.apache.org

Installation

Put the package under your project folder and add the following in import:

import "./nifi"

Documentation for API Endpoints

All URIs are relative to /

Class Method HTTP request Description
AccessApi CreateAccessToken Post /access/token Creates a token for accessing the REST API via username/password
AccessApi LogOut Delete /access/logout Performs a logout for other providers that have been issued a JWT.
AccessApi LogOutComplete Get /access/logout/complete Completes the logout sequence by removing the cached Logout Request and Cookie if they existed and redirects to /nifi/login.
AuthenticationApi GetAuthenticationConfiguration Get /authentication/configuration Retrieves the authentication configuration endpoint and status information
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 AnalyzeFlowAnalysisRuleConfiguration Post /controller/flow-analysis-rules/{id}/config/analysis Performs analysis of the component's configuration, providing information about which attributes are referenced.
ControllerApi ClearState Post /controller/flow-analysis-rules/{id}/state/clear-requests Clears the state for a flow analysis rule
ControllerApi CreateBulletin Post /controller/bulletin Creates a new bulletin
ControllerApi CreateControllerService Post /controller/controller-services Creates a new controller service
ControllerApi CreateFlowAnalysisRule Post /controller/flow-analysis-rules Creates a new flow analysis rule
ControllerApi CreateFlowRegistryClient Post /controller/registry-clients Creates a new flow registry client
ControllerApi CreateParameterProvider Post /controller/parameter-providers Creates a new parameter provider
ControllerApi CreateReportingTask Post /controller/reporting-tasks Creates a new reporting task
ControllerApi DeleteFlowAnalysisRuleVerificationRequest Delete /controller/flow-analysis-rules/{id}/config/verification-requests/{requestId} Deletes the Verification Request with the given ID
ControllerApi DeleteFlowRegistryClient Delete /controller/registry-clients/{id} Deletes a flow registry client
ControllerApi DeleteHistory Delete /controller/history Purges history
ControllerApi DeleteNar Delete /controller/nar-manager/nars/{id} Deletes an installed NAR
ControllerApi DeleteNode Delete /controller/cluster/nodes/{id} Removes a node from the cluster
ControllerApi DownloadNar Get /controller/nar-manager/nars/{id}/content Retrieves the content of the NAR with the given id
ControllerApi GetCluster Get /controller/cluster Gets the contents of the cluster
ControllerApi GetControllerConfig Get /controller/config Retrieves the configuration for this NiFi Controller
ControllerApi GetFlowAnalysisRule Get /controller/flow-analysis-rules/{id} Gets a flow analysis rule
ControllerApi GetFlowAnalysisRulePropertyDescriptor Get /controller/flow-analysis-rules/{id}/descriptors Gets a flow analysis rule property descriptor
ControllerApi GetFlowAnalysisRuleState Get /controller/flow-analysis-rules/{id}/state Gets the state for a flow analysis rule
ControllerApi GetFlowAnalysisRuleVerificationRequest Get /controller/flow-analysis-rules/{id}/config/verification-requests/{requestId} Returns the Verification Request with the given ID
ControllerApi GetFlowAnalysisRules Get /controller/flow-analysis-rules Gets all flow analysis rules
ControllerApi GetFlowRegistryClient Get /controller/registry-clients/{id} Gets a flow registry client
ControllerApi GetFlowRegistryClients Get /controller/registry-clients Gets the listing of available flow registry clients
ControllerApi GetNarDetails Get /controller/nar-manager/nars/{id}/details Retrieves the component types available from the installed NARs
ControllerApi GetNarSummaries Get /controller/nar-manager/nars Retrieves summary information for installed NARs
ControllerApi GetNarSummary Get /controller/nar-manager/nars/{id} Retrieves the summary information for the NAR with the given identifier
ControllerApi GetNode Get /controller/cluster/nodes/{id} Gets a node in the cluster
ControllerApi GetNodeStatusHistory Get /controller/status/history Gets status history for the node
ControllerApi GetPropertyDescriptor Get /controller/registry-clients/{id}/descriptors Gets a flow registry client property descriptor
ControllerApi GetRegistryClientTypes Get /controller/registry-types Retrieves the types of flow that this NiFi supports
ControllerApi ImportReportingTaskSnapshot Post /controller/reporting-tasks/import Imports a reporting task snapshot
ControllerApi RemoveFlowAnalysisRule Delete /controller/flow-analysis-rules/{id} Deletes a flow analysis rule
ControllerApi SubmitFlowAnalysisRuleConfigVerificationRequest Post /controller/flow-analysis-rules/{id}/config/verification-requests Performs verification of the Flow Analysis Rule's configuration
ControllerApi UpdateControllerConfig Put /controller/config Retrieves the configuration for this NiFi
ControllerApi UpdateFlowAnalysisRule Put /controller/flow-analysis-rules/{id} Updates a flow analysis rule
ControllerApi UpdateFlowRegistryClient Put /controller/registry-clients/{id} Updates a flow registry client
ControllerApi UpdateNode Put /controller/cluster/nodes/{id} Updates a node in the cluster
ControllerApi UpdateRunStatus Put /controller/flow-analysis-rules/{id}/run-status Updates run status of a flow analysis rule
ControllerApi UploadNar Post /controller/nar-manager/nars/content Uploads a NAR and requests for it to be installed
ControllerServicesApi AnalyzeConfiguration Post /controller-services/{id}/config/analysis Performs analysis of the component's configuration, providing information about which attributes are referenced.
ControllerServicesApi ClearState1 Post /controller-services/{id}/state/clear-requests Clears the state for a controller service
ControllerServicesApi DeleteVerificationRequest Delete /controller-services/{id}/config/verification-requests/{requestId} Deletes the Verification Request with the given ID
ControllerServicesApi GetControllerService Get /controller-services/{id} Gets a controller service
ControllerServicesApi GetControllerServiceReferences Get /controller-services/{id}/references Gets a controller service
ControllerServicesApi GetPropertyDescriptor1 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 GetVerificationRequest Get /controller-services/{id}/config/verification-requests/{requestId} Returns the Verification Request with the given ID
ControllerServicesApi RemoveControllerService Delete /controller-services/{id} Deletes a controller service
ControllerServicesApi SubmitConfigVerificationRequest Post /controller-services/{id}/config/verification-requests Performs verification of the Controller Service's configuration
ControllerServicesApi UpdateControllerService Put /controller-services/{id} Updates a controller service
ControllerServicesApi UpdateControllerServiceReferences Put /controller-services/{id}/references Updates a controller services references
ControllerServicesApi UpdateRunStatus1 Put /controller-services/{id}/run-status Updates run status of a controller service
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 DownloadReportingTaskSnapshot Get /flow/reporting-tasks/download Download a snapshot of the given reporting tasks and any controller services they use
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 GetAdditionalDetails Get /flow/additional-details/{group}/{artifact}/{version}/{type} Retrieves the additional details for the specified component type.
FlowApi GetAllFlowAnalysisResults Get /flow/flow-analysis/results Returns all flow analysis results currently in effect
FlowApi GetBanners Get /flow/banners Retrieves the banners for this NiFi
FlowApi GetBranches Get /flow/registries/{id}/branches Gets the branches from the specified registry for the current user
FlowApi GetBreadcrumbs Get /flow/process-groups/{id}/breadcrumbs Gets the breadcrumbs for a process group
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 GetConnectionStatistics Get /flow/connections/{id}/statistics Gets statistics for a connection
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 GetContentViewers Get /flow/content-viewers Retrieves the registered content viewers
FlowApi GetControllerServiceDefinition Get /flow/controller-service-definition/{group}/{artifact}/{version}/{type} Retrieves the Controller Service Definition for the specified component type.
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 controller services for reporting tasks
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 GetDetails Get /flow/registries/{registry-id}/buckets/{bucket-id}/flows/{flow-id}/details Gets the details of a flow from the specified registry and bucket for the specified flow for the current user
FlowApi GetFlow Get /flow/process-groups/{id} Gets a process group
FlowApi GetFlowAnalysisResults Get /flow/flow-analysis/results/{processGroupId} Returns flow analysis results produced by the analysis of a given process group
FlowApi GetFlowAnalysisRuleDefinition Get /flow/flow-analysis-rule-definition/{group}/{artifact}/{version}/{type} Retrieves the Flow Analysis Rule Definition for the specified component type.
FlowApi GetFlowAnalysisRuleTypes Get /flow/flow-analysis-rule-types Retrieves the types of available Flow Analysis Rules
FlowApi GetFlowConfig Get /flow/config Retrieves the configuration for this NiFi flow
FlowApi GetFlowMetrics Get /flow/metrics/{producer} Gets all metrics for the flow from a particular node
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 GetParameterContexts Get /flow/parameter-contexts Gets all Parameter Contexts
FlowApi GetParameterProviderDefinition Get /flow/parameter-provider-definition/{group}/{artifact}/{version}/{type} Retrieves the Parameter Provider Definition for the specified component type.
FlowApi GetParameterProviderTypes Get /flow/parameter-provider-types Retrieves the types of parameter providers that this NiFi supports
FlowApi GetParameterProviders Get /flow/parameter-providers Gets all parameter providers
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 GetProcessorDefinition Get /flow/processor-definition/{group}/{artifact}/{version}/{type} Retrieves the Processor Definition for the specified component type.
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 GetRegistryClients Get /flow/registries Gets the listing of available flow registry clients
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 GetReportingTaskDefinition Get /flow/reporting-task-definition/{group}/{artifact}/{version}/{type} Retrieves the Reporting Task Definition for the specified component type.
FlowApi GetReportingTaskSnapshot Get /flow/reporting-tasks/snapshot Get a snapshot of the given reporting tasks and any controller services they use
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 GetRuntimeManifest Get /flow/runtime-manifest Retrieves the runtime manifest for this NiFi instance.
FlowApi GetVersionDifferences Get /flow/registries/{registry-id}/branches/{branch-id-a}/buckets/{bucket-id-a}/flows/{flow-id-a}/{version-a}/diff/branches/{branch-id-b}/buckets/{bucket-id-b}/flows/{flow-id-b}/{version-b} Gets the differences between two versions of the same versioned flow, the basis of the comparison will be the first version
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.
FunnelsApi GetFunnel Get /funnels/{id} Gets a funnel
FunnelsApi RemoveFunnel Delete /funnels/{id} Deletes a funnel
FunnelsApi 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
InputPortsApi UpdateRunStatus2 Put /input-ports/{id}/run-status Updates run status of 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
OutputPortsApi UpdateRunStatus3 Put /output-ports/{id}/run-status Updates run status of an output-port
ParameterContextsApi CreateAsset Post /parameter-contexts/{contextId}/assets Creates a new Asset in the given Parameter Context
ParameterContextsApi CreateParameterContext Post /parameter-contexts Create a Parameter Context
ParameterContextsApi DeleteAsset Delete /parameter-contexts/{contextId}/assets/{assetId} Deletes an Asset from the given Parameter Context
ParameterContextsApi DeleteParameterContext Delete /parameter-contexts/{id} Deletes the Parameter Context with the given ID
ParameterContextsApi DeleteUpdateRequest Delete /parameter-contexts/{contextId}/update-requests/{requestId} Deletes the Update Request with the given ID
ParameterContextsApi DeleteValidationRequest Delete /parameter-contexts/{contextId}/validation-requests/{id} Deletes the Validation Request with the given ID
ParameterContextsApi GetAssetContent Get /parameter-contexts/{contextId}/assets/{assetId} Retrieves the content of the asset with the given id
ParameterContextsApi GetAssets Get /parameter-contexts/{contextId}/assets Lists the assets that belong to the Parameter Context with the given ID
ParameterContextsApi GetParameterContext Get /parameter-contexts/{id} Returns the Parameter Context with the given ID
ParameterContextsApi GetParameterContextUpdate Get /parameter-contexts/{contextId}/update-requests/{requestId} Returns the Update Request with the given ID
ParameterContextsApi GetValidationRequest Get /parameter-contexts/{contextId}/validation-requests/{id} Returns the Validation Request with the given ID
ParameterContextsApi SubmitParameterContextUpdate Post /parameter-contexts/{contextId}/update-requests Initiate the Update Request of a Parameter Context
ParameterContextsApi SubmitValidationRequest Post /parameter-contexts/{contextId}/validation-requests Initiate a Validation Request to determine how the validity of components will change if a Parameter Context were to be updated
ParameterContextsApi UpdateParameterContext Put /parameter-contexts/{id} Modifies a Parameter Context
ParameterProvidersApi AnalyzeConfiguration1 Post /parameter-providers/{id}/config/analysis Performs analysis of the component's configuration, providing information about which attributes are referenced.
ParameterProvidersApi ClearState2 Post /parameter-providers/{id}/state/clear-requests Clears the state for a parameter provider
ParameterProvidersApi DeleteApplyParametersRequest Delete /parameter-providers/{providerId}/apply-parameters-requests/{requestId} Deletes the Apply Parameters Request with the given ID
ParameterProvidersApi DeleteVerificationRequest1 Delete /parameter-providers/{id}/config/verification-requests/{requestId} Deletes the Verification Request with the given ID
ParameterProvidersApi FetchParameters Post /parameter-providers/{id}/parameters/fetch-requests Fetches and temporarily caches the parameters for a provider
ParameterProvidersApi GetParameterProvider Get /parameter-providers/{id} Gets a parameter provider
ParameterProvidersApi GetParameterProviderApplyParametersRequest Get /parameter-providers/{providerId}/apply-parameters-requests/{requestId} Returns the Apply Parameters Request with the given ID
ParameterProvidersApi GetParameterProviderReferences Get /parameter-providers/{id}/references Gets all references to a parameter provider
ParameterProvidersApi GetPropertyDescriptor2 Get /parameter-providers/{id}/descriptors Gets a parameter provider property descriptor
ParameterProvidersApi GetState1 Get /parameter-providers/{id}/state Gets the state for a parameter provider
ParameterProvidersApi GetVerificationRequest1 Get /parameter-providers/{id}/config/verification-requests/{requestId} Returns the Verification Request with the given ID
ParameterProvidersApi RemoveParameterProvider Delete /parameter-providers/{id} Deletes a parameter provider
ParameterProvidersApi SubmitApplyParameters Post /parameter-providers/{providerId}/apply-parameters-requests Initiate a request to apply the fetched parameters of a Parameter Provider
ParameterProvidersApi SubmitConfigVerificationRequest1 Post /parameter-providers/{id}/config/verification-requests Performs verification of the Parameter Provider's configuration
ParameterProvidersApi UpdateParameterProvider Put /parameter-providers/{id} Updates a parameter provider
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 Copy Post /process-groups/{id}/copy Generates a copy response for the given copy request
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 CreateControllerService1 Post /process-groups/{id}/controller-services Creates a new controller service
ProcessGroupsApi CreateEmptyAllConnectionsRequest Post /process-groups/{id}/empty-all-connections-requests Creates a request to drop all flowfiles of all connection queues in this process group.
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 DeleteReplaceProcessGroupRequest Delete /process-groups/replace-requests/{id} Deletes the Replace Request with the given ID
ProcessGroupsApi ExportProcessGroup Get /process-groups/{id}/download Gets a process group for download
ProcessGroupsApi GetConnections Get /process-groups/{id}/connections Gets all connections
ProcessGroupsApi GetDropAllFlowfilesRequest Get /process-groups/{id}/empty-all-connections-requests/{drop-request-id} Gets the current status of a drop all flowfiles request.
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 GetReplaceProcessGroupRequest Get /process-groups/replace-requests/{id} Returns the Replace Request with the given ID
ProcessGroupsApi ImportProcessGroup Post /process-groups/{id}/process-groups/import Imports a specified process group
ProcessGroupsApi InitiateReplaceProcessGroup Post /process-groups/{id}/replace-requests Initiate the Replace Request of a Process Group with the given ID
ProcessGroupsApi Paste Put /process-groups/{id}/paste Pastes into the specified process group
ProcessGroupsApi RemoveDropRequest1 Delete /process-groups/{id}/empty-all-connections-requests/{drop-request-id} Cancels and/or removes a request to drop all flowfiles.
ProcessGroupsApi RemoveProcessGroup Delete /process-groups/{id} Deletes a process group
ProcessGroupsApi ReplaceProcessGroup Put /process-groups/{id}/flow-contents Replace Process Group contents with the given ID with the specified Process Group contents
ProcessGroupsApi UpdateProcessGroup Put /process-groups/{id} Updates a process group
ProcessGroupsApi UploadProcessGroup Post /process-groups/{id}/process-groups/upload Uploads a versioned flow definition and creates a process group
ProcessorsApi AnalyzeConfiguration2 Post /processors/{id}/config/analysis Performs analysis of the component's configuration, providing information about which attributes are referenced.
ProcessorsApi ClearState3 Post /processors/{id}/state/clear-requests Clears the state for a processor
ProcessorsApi DeleteProcessor Delete /processors/{id} Deletes a processor
ProcessorsApi DeleteVerificationRequest2 Delete /processors/{id}/config/verification-requests/{requestId} Deletes the Verification Request with the given ID
ProcessorsApi GetProcessor Get /processors/{id} Gets a processor
ProcessorsApi GetProcessorDiagnostics Get /processors/{id}/diagnostics Gets diagnostics information about a processor
ProcessorsApi GetProcessorRunStatusDetails Post /processors/run-status-details/queries Submits a query to retrieve the run status details of all processors that are in the given list of Processor IDs
ProcessorsApi GetPropertyDescriptor3 Get /processors/{id}/descriptors Gets the descriptor for a processor property
ProcessorsApi GetState2 Get /processors/{id}/state Gets the state for a processor
ProcessorsApi GetVerificationRequest2 Get /processors/{id}/config/verification-requests/{requestId} Returns the Verification Request with the given ID
ProcessorsApi SubmitProcessorVerificationRequest Post /processors/{id}/config/verification-requests Performs verification of the Processor's configuration
ProcessorsApi TerminateProcessor Delete /processors/{id}/threads Terminates a processor, essentially "deleting" its threads and any active tasks
ProcessorsApi UpdateProcessor Put /processors/{id} Updates a processor
ProcessorsApi UpdateRunStatus4 Put /processors/{id}/run-status Updates run status of 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 GetLatestProvenanceEvents Get /provenance-events/latest/{componentId} Retrieves the latest cached Provenance Events for the specified component
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
ProvenanceEventsApi SubmitReplayLatestEvent Post /provenance-events/latest/replays Replays content from a provenance event
RemoteProcessGroupsApi GetRemoteProcessGroup Get /remote-process-groups/{id} Gets a remote process group
RemoteProcessGroupsApi GetState3 Get /remote-process-groups/{id}/state Gets the state for a RemoteProcessGroup
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 UpdateRemoteProcessGroupInputPortRunStatus Put /remote-process-groups/{id}/input-ports/{port-id}/run-status Updates run status of a remote port
RemoteProcessGroupsApi UpdateRemoteProcessGroupOutputPort Put /remote-process-groups/{id}/output-ports/{port-id} Updates a remote port
RemoteProcessGroupsApi UpdateRemoteProcessGroupOutputPortRunStatus Put /remote-process-groups/{id}/output-ports/{port-id}/run-status Updates run status of a remote port
RemoteProcessGroupsApi UpdateRemoteProcessGroupRunStatus Put /remote-process-groups/{id}/run-status Updates run status of a remote process group
RemoteProcessGroupsApi UpdateRemoteProcessGroupRunStatuses Put /remote-process-groups/process-group/{id}/run-status Updates run status of all remote process groups in a process group (recursively)
ReportingTasksApi AnalyzeConfiguration3 Post /reporting-tasks/{id}/config/analysis Performs analysis of the component's configuration, providing information about which attributes are referenced.
ReportingTasksApi ClearState4 Post /reporting-tasks/{id}/state/clear-requests Clears the state for a reporting task
ReportingTasksApi DeleteVerificationRequest3 Delete /reporting-tasks/{id}/config/verification-requests/{requestId} Deletes the Verification Request with the given ID
ReportingTasksApi GetPropertyDescriptor4 Get /reporting-tasks/{id}/descriptors Gets a reporting task property descriptor
ReportingTasksApi GetReportingTask Get /reporting-tasks/{id} Gets a reporting task
ReportingTasksApi GetState4 Get /reporting-tasks/{id}/state Gets the state for a reporting task
ReportingTasksApi GetVerificationRequest3 Get /reporting-tasks/{id}/config/verification-requests/{requestId} Returns the Verification Request with the given ID
ReportingTasksApi RemoveReportingTask Delete /reporting-tasks/{id} Deletes a reporting task
ReportingTasksApi SubmitConfigVerificationRequest2 Post /reporting-tasks/{id}/config/verification-requests Performs verification of the Reporting Task's configuration
ReportingTasksApi UpdateReportingTask Put /reporting-tasks/{id} Updates a reporting task
ReportingTasksApi UpdateRunStatus5 Put /reporting-tasks/{id}/run-status Updates run status of 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 GetJmxMetrics Get /system-diagnostics/jmx-metrics Retrieve available JMX metrics
SystemDiagnosticsApi GetSystemDiagnostics Get /system-diagnostics Gets the diagnostics for the system NiFi is running on
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 Create a version control request
VersionsApi DeleteRevertRequest Delete /versions/revert-requests/{id} Deletes the Revert Request with the given ID
VersionsApi DeleteUpdateRequest1 Delete /versions/update-requests/{id} Deletes the Update Request with the given ID
VersionsApi DeleteVersionControlRequest Delete /versions/active-requests/{id} Deletes the version control request with the given ID
VersionsApi ExportFlowVersion Get /versions/process-groups/{id}/download Gets the latest version of a Process Group for download
VersionsApi GetRevertRequest Get /versions/revert-requests/{id} Returns the Revert Request with the given ID
VersionsApi GetUpdateRequest Get /versions/update-requests/{id} Returns the Update Request with the given ID
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} Initiate the Revert Request of a Process Group with the given ID
VersionsApi InitiateVersionControlUpdate Post /versions/update-requests/process-groups/{id} Initiate the Update Request of a Process Group with the given ID
VersionsApi SaveToFlowRegistry Post /versions/process-groups/{id} Save the Process Group with the given ID
VersionsApi StopVersionControl Delete /versions/process-groups/{id} Stops version controlling the Process Group with the given ID
VersionsApi UpdateFlowVersion Put /versions/process-groups/{id} Update the version of a Process Group with the given ID
VersionsApi UpdateVersionControlRequest Put /versions/active-requests/{id} Updates the request with the given ID

Documentation For Models

Documentation For Authorization

Endpoints do not require authorization.

Author

dev@nifi.apache.org