NiFi Rest API-1.27.0

GET

Gets the status the client's access

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

Request

consumes:

*/*

Response

produces:

application/json

Status Code	Type	Description
200	AccessStatusEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Unable to determine access status because the client could not be authenticated.
403	string	Unable to determine access status because the client is not authorized to make this request.
409	string	Unable to determine access status because NiFi is not in the appropriate state.
500	string	Unable to determine access status because an unexpected error occurred.

Authorization

GET

Retrieves the access configuration for this NiFi

Request

consumes:

*/*

Response

produces:

application/json

Status Code	Type	Description
200	AccessConfigurationEntity	successful operation

Authorization

POST

Creates a token for accessing the REST API via Kerberos ticket exchange / SPNEGO negotiation

The token returned is formatted as a JSON Web Token (JWT). The token is base64 encoded and comprised of three parts. The header, the body, and the signature. The expiration of the token is a contained within the body. The token can be used in the Authorization header in the format 'Authorization: Bearer <token>'. It is also stored in the browser as a cookie.

Request

consumes:

text/plain

Response

produces:

text/plain

Status Code	Type	Description
200		successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	NiFi was unable to complete the request because it did not contain a valid Kerberos ticket in the Authorization header. Retry this request after initializing a ticket with kinit and ensuring your browser is configured to support SPNEGO.
409	string	Unable to create access token because NiFi is not in the appropriate state. (i.e. may not be configured to support Kerberos login.
500	string	Unable to create access token because an unexpected error occurred.

Authorization

GET

Redirect/callback URI for processing the result of the Apache Knox login sequence.

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

Request

consumes:

*/*

Response

produces:

*/*

Status Code	Type	Description
default	string	successful operation

Authorization

GET

Performs a logout in the Apache Knox.

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

Request

consumes:

*/*

Response

produces:

*/*

Status Code	Type	Description
default	string	successful operation

Authorization

GET

Initiates a request to authenticate through Apache Knox.

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

Request

consumes:

*/*

Response

produces:

*/*

Status Code	Type	Description
default	string	successful operation

Authorization

DELETE

Performs a logout for other providers that have been issued a JWT.

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

Request

consumes:

*/*

Response

produces:

*/*

Status Code	Type	Description
200	string	User was logged out successfully.
401	string	Authentication token provided was empty or not in the correct JWT format.
500	string	Client failed to log out.

Authorization

GET

Completes the logout sequence by removing the cached Logout Request and Cookie if they existed and redirects to /nifi/login.

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

Request

consumes:

*/*

Response

produces:

*/*

Status Code	Type	Description
200	string	User was logged out successfully.
401	string	Authentication token provided was empty or not in the correct JWT format.
500	string	Client failed to log out.

Authorization

POST

Creates a token for accessing the REST API via username/password

The token returned is formatted as a JSON Web Token (JWT). The token is base64 encoded and comprised of three parts. The header, the body, and the signature. The expiration of the token is a contained within the body. It is stored in the browser as a cookie, but also returned inthe response body to be stored/used by third party client scripts.

Request

consumes:

application/x-www-form-urlencoded

Name	Location	Type	Description
username	formData	string
password	formData	string

Response

produces:

text/plain

Status Code	Type	Description
200		successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
403	string	Client is not authorized to make this request.
409	string	Unable to create access token because NiFi is not in the appropriate state. (i.e. may not be configured to support username/password login.
500	string	Unable to create access token because an unexpected error occurred.

Authorization

GET

Get expiration for current Access Token

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

Request

Response

produces:

application/json

Status Code	Type	Description
200	AccessTokenExpirationEntity	Access Token Expiration found
401	string	Access Token not authorized
409	string	Access Token not resolved

Authorization

GET

Gets a connection

Request

consumes:

*/*

Name	Location	Type	Description
id	path	string	The connection id.

Response

produces:

application/json

Status Code	Type	Description
200	ConnectionEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Read Source - /{component-type}/{uuid}

Read Destination - /{component-type}/{uuid}

PUT

Updates a connection

Request

consumes:

application/json

Name	Location	Type	Description
id	path	string	The connection id.
	body	ConnectionEntity	The connection configuration details.

Response

produces:

application/json

Status Code	Type	Description
200	ConnectionEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Write Source - /{component-type}/{uuid}

Write Destination - /{component-type}/{uuid}

Write New Destination - /{component-type}/{uuid} - if updating Destination

Write Process Group - /process-groups/{uuid} - if updating Destination

DELETE

Deletes a connection

Request

consumes:

*/*

Name	Location	Type	Description
version	query	string	The revision is used to verify the client is working with the latest version of the flow.
clientId	query	string	If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.
disconnectedNodeAcknowledged	query	boolean	Acknowledges that this node is disconnected to allow for mutable requests to proceed.
id	path	string	The connection id.

Response

produces:

application/json

Status Code	Type	Description
200	ConnectionEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Write Source - /{component-type}/{uuid}

Write - Parent Process Group - /process-groups/{uuid}

Write Destination - /{component-type}/{uuid}

GET

Gets a controller service

If the uiOnly query parameter is provided with a value of true, the returned entity may only contain fields that are necessary for rendering the NiFi User Interface. As such, the selected fields may change at any time, even during incremental releases, without warning. As a result, this parameter should not be provided by any client other than the UI.

Request

consumes:

*/*

Name	Location	Type	Description
id	path	string	The controller service id.
uiOnly	query	boolean

Response

produces:

application/json

Status Code	Type	Description
200	ControllerServiceEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Read - /controller-services/{uuid}

PUT

Updates a controller service

Request

consumes:

application/json

Name	Location	Type	Description
id	path	string	The controller service id.
	body	ControllerServiceEntity	The controller service configuration details.

Response

produces:

application/json

Status Code	Type	Description
200	ControllerServiceEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Write - /controller-services/{uuid}

Read - any referenced Controller Services if this request changes the reference - /controller-services/{uuid}

DELETE

Deletes a controller service

Request

consumes:

*/*

Name	Location	Type	Description
version	query	string	The revision is used to verify the client is working with the latest version of the flow.
clientId	query	string	If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.
disconnectedNodeAcknowledged	query	boolean	Acknowledges that this node is disconnected to allow for mutable requests to proceed.
id	path	string	The controller service id.

Response

produces:

application/json

Status Code	Type	Description
200	ControllerServiceEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Write - /controller-services/{uuid}

Write - Parent Process Group if scoped by Process Group - /process-groups/{uuid}

Write - Controller if scoped by Controller - /controller

Read - any referenced Controller Services - /controller-services/{uuid}

POST

Performs analysis of the component's configuration, providing information about which attributes are referenced.

Request

consumes:

application/json

Name	Location	Type	Description
id	path	string	The controller service id.
	body	ConfigurationAnalysisEntity	The configuration analysis request.

Response

produces:

application/json

Status Code	Type	Description
200	ConfigurationAnalysisEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Read - /controller-services/{uuid}

POST

Performs verification of the Controller Service's configuration

This will initiate the process of verifying a given Controller Service configuration. This may be a long-running task. As a result, this endpoint will immediately return a ControllerServiceConfigVerificationRequestEntity, and the process of performing the verification will occur asynchronously in the background. The client may then periodically poll the status of the request by issuing a GET request to /controller-services/{serviceId}/verification-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /controller-services/{serviceId}/verification-requests/{requestId}.

Request

consumes:

application/json

Name	Location	Type	Description
id	path	string	The controller service id.
	body	VerifyConfigRequestEntity	The controller service configuration verification request.

Response

produces:

application/json

Status Code	Type	Description
200	VerifyConfigRequestEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Read - /controller-services/{uuid}

GET

Returns the Verification Request with the given ID

Returns the Verification Request with the given ID. Once an Verification Request has been created, 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.

Request

consumes:

*/*

Name	Location	Type	Description
id	path	string	The ID of the Controller Service
requestId	path	string	The ID of the Verification Request

Response

produces:

application/json

Status Code	Type	Description
200	VerifyConfigRequestEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Only the user that submitted the request can get it

DELETE

Deletes the Verification Request with the given ID

Deletes the Verification Request with the given ID. After a request is created, it is expected that the client will properly clean up the request by DELETE'ing it, once the Verification process has completed. If the request is deleted before the request completes, then the Verification request will finish the step that it is currently performing and then will cancel any subsequent steps.

Request

consumes:

*/*

Name	Location	Type	Description
id	path	string	The ID of the Controller Service
requestId	path	string	The ID of the Verification Request

Response

produces:

application/json

Status Code	Type	Description
200	VerifyConfigRequestEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Only the user that submitted the request can remove it

GET

Gets a controller service property descriptor

Request

consumes:

*/*

Name	Location	Type	Description
id	path	string	The controller service id.
propertyName	query	string	The property name to return the descriptor for.
sensitive	query	boolean	Property Descriptor requested sensitive status

Response

produces:

application/json

Status Code	Type	Description
200	PropertyDescriptorEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Read - /controller-services/{uuid}

GET

Gets a controller service

Request

consumes:

*/*

Name	Location	Type	Description
id	path	string	The controller service id.

Response

produces:

application/json

Status Code	Type	Description
200	ControllerServiceReferencingComponentsEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Read - /controller-services/{uuid}

PUT

Updates a controller services references

Request

consumes:

application/json

Name	Location	Type	Description
id	path	string	The controller service id.
	body	UpdateControllerServiceReferenceRequestEntity	The controller service request update request.

Response

produces:

application/json

Status Code	Type	Description
200	ControllerServiceReferencingComponentsEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Write - /{component-type}/{uuid} or /operate/{component-type}/{uuid} - For each referencing component specified

PUT

Updates run status of a controller service

Request

consumes:

application/json

Name	Location	Type	Description
id	path	string	The controller service id.
	body	ControllerServiceRunStatusEntity	The controller service run status.

Response

produces:

application/json

Status Code	Type	Description
200	ControllerServiceEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Write - /controller-services/{uuid} or /operation/controller-services/{uuid}

GET

Gets the state for a controller service

Request

consumes:

*/*

Name	Location	Type	Description
id	path	string	The controller service id.

Response

produces:

application/json

Status Code	Type	Description
200	ComponentStateEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Write - /controller-services/{uuid}

POST

Clears the state for a controller service

Request

consumes:

*/*

Name	Location	Type	Description
id	path	string	The controller service id.

Response

produces:

application/json

Status Code	Type	Description
200	ComponentStateEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Write - /controller-services/{uuid}

POST

Creates a new bulletin

Request

consumes:

application/json

Name	Location	Type	Description
	body	BulletinEntity	The reporting task configuration details.

Response

produces:

application/json

Status Code	Type	Description
200	BulletinEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Write - /controller

GET

Gets the contents of the cluster

Returns the contents of the cluster including all nodes and their status.

Request

consumes:

*/*

Response

produces:

application/json

Status Code	Type	Description
200	ClusterEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Read - /controller

GET

Gets a node in the cluster

Request

consumes:

*/*

Name	Location	Type	Description
id	path	string	The node id.

Response

produces:

application/json

Status Code	Type	Description
200	NodeEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Read - /controller

PUT

Updates a node in the cluster

Request

consumes:

application/json

Name	Location	Type	Description
id	path	string	The node id.
	body	NodeEntity	The node configuration. The only configuration that will be honored at this endpoint is the status.

Response

produces:

application/json

Status Code	Type	Description
200	NodeEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Write - /controller

DELETE

Removes a node from the cluster

Request

consumes:

*/*

Name	Location	Type	Description
id	path	string	The node id.

Response

produces:

application/json

Status Code	Type	Description
200	NodeEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Write - /controller

GET

Retrieves the configuration for this NiFi Controller

Request

consumes:

*/*

Response

produces:

application/json

Status Code	Type	Description
200	ControllerConfigurationEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Read - /controller

PUT

Retrieves the configuration for this NiFi

Request

consumes:

application/json

Name	Location	Type	Description
	body	ControllerConfigurationEntity	The controller configuration.

Response

produces:

application/json

Status Code	Type	Description
200	ControllerConfigurationEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Write - /controller

POST

Creates a new controller service

Request

consumes:

application/json

Name	Location	Type	Description
	body	ControllerServiceEntity	The controller service configuration details.

Response

produces:

application/json

Status Code	Type	Description
200	ControllerServiceEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Write - /controller

Read - any referenced Controller Services - /controller-services/{uuid}

Write - if the Controller Service is restricted - /restricted-components

DELETE

Purges history

Request

consumes:

*/*

Name	Location	Type	Description
endDate	query	string	Purge actions before this date/time.

Response

produces:

application/json

Status Code	Type	Description
200	HistoryEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Write - /controller

POST

Creates a new parameter provider

Request

consumes:

application/json

Name	Location	Type	Description
	body	ParameterProviderEntity	The parameter provider configuration details.

Response

produces:

application/json

Status Code	Type	Description
200	ParameterProviderEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Write - /controller

Read - any referenced Controller Services - /controller-services/{uuid}

Write - if the Parameter Provider is restricted - /restricted-components

POST

Creates a new flow registry client

Request

consumes:

application/json

Name	Location	Type	Description
	body	FlowRegistryClientEntity	The flow registry client configuration details.

Response

produces:

application/json

Status Code	Type	Description
200	FlowRegistryClientEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Write - /controller

GET

Gets the listing of available flow registry clients

Request

consumes:

*/*

Response

produces:

application/json

Status Code	Type	Description
200	FlowRegistryClientsEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Read - /flow

GET

Gets a flow registry client

Request

consumes:

*/*

Name	Location	Type	Description
id	path	string	The flow registry client id.

Response

produces:

application/json

Status Code	Type	Description
200	FlowRegistryClientEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Read - /controller

PUT

Updates a flow registry client

Request

consumes:

application/json

Name	Location	Type	Description
id	path	string	The flow registry client id.
	body	FlowRegistryClientEntity	The flow registry client configuration details.

Response

produces:

application/json

Status Code	Type	Description
200	FlowRegistryClientEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Write - /controller

DELETE

Deletes a flow registry client

Request

consumes:

*/*

Name	Location	Type	Description
version	query	string	The revision is used to verify the client is working with the latest version of the flow.
clientId	query	string	If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.
disconnectedNodeAcknowledged	query	boolean	Acknowledges that this node is disconnected to allow for mutable requests to proceed.
id	path	string	The flow registry client id.

Response

produces:

application/json

Status Code	Type	Description
200	FlowRegistryClientEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Write - /controller

GET

Gets a flow registry client property descriptor

Request

consumes:

*/*

Name	Location	Type	Description
id	path	string	The flow registry client id.
propertyName	query	string	The property name.
sensitive	query	boolean	Property Descriptor requested sensitive status

Response

produces:

application/json

Status Code	Type	Description
200	PropertyDescriptorEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Read - /controller/registry-clients/{uuid}

GET

Retrieves the types of flow that this NiFi supports

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

Request

consumes:

*/*

Response

produces:

application/json

Status Code	Type	Description
200	FlowRegistryClientTypesEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Read - /flow

POST

Creates a new reporting task

Request

consumes:

application/json

Name	Location	Type	Description
	body	ReportingTaskEntity	The reporting task configuration details.

Response

produces:

application/json

Status Code	Type	Description
200	ReportingTaskEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Write - /controller

Read - any referenced Controller Services - /controller-services/{uuid}

Write - if the Reporting Task is restricted - /restricted-components

GET

Gets status history for the node

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

Request

consumes:

*/*

Response

produces:

application/json

Status Code	Type	Description
200	ComponentHistoryEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Read - /controller

GET

Gets the current counters for this NiFi

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

Request

consumes:

*/*

Name	Location	Type	Description
nodewise	query	boolean	Whether or not to include the breakdown per node. Optional, defaults to false
clusterNodeId	query	string	The id of the node where to get the status.

Response

produces:

application/json

Status Code	Type	Description
200	CountersEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Read - /counters

PUT

Updates the specified counter. This will reset the counter value to 0

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

Request

consumes:

*/*

Name	Location	Type	Description
id	path	string	The id of the counter.

Response

produces:

application/json

Status Code	Type	Description
200	CounterEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Write - /counters

PUT

Extend transaction TTL

Request

consumes:

*/*

Name	Location	Type	Description
portId	path	string
transactionId	path	string

Response

produces:

application/json

Status Code	Type	Description
200	TransactionResultEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Write - /data-transfer/input-ports/{uuid}

DELETE

Commit or cancel the specified transaction

Request

consumes:

application/octet-stream

Name	Location	Type	Description
responseCode	query	integer (int32)	The response code. Available values are BAD_CHECKSUM(19), CONFIRM_TRANSACTION(12) or CANCEL_TRANSACTION(15).
portId	path	string	The input port id.
transactionId	path	string	The transaction id.

Response

produces:

application/json

Status Code	Type	Description
200	TransactionResultEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.
503	string	NiFi instance is not ready for serving request, or temporarily overloaded. Retrying the same request later may be successful

Authorization

Write - /data-transfer/input-ports/{uuid}

POST

Transfer flow files to the input port

Request

consumes:

application/octet-stream

Name	Location	Type	Description
portId	path	string	The input port id.
transactionId	path	string

Response

produces:

text/plain

Status Code	Type	Description
200		successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.
503	string	NiFi instance is not ready for serving request, or temporarily overloaded. Retrying the same request later may be successful

Authorization

Write - /data-transfer/input-ports/{uuid}

PUT

Extend transaction TTL

Request

consumes:

*/*

Name	Location	Type	Description
portId	path	string
transactionId	path	string

Response

produces:

application/json

Status Code	Type	Description
200	TransactionResultEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.
503	string	NiFi instance is not ready for serving request, or temporarily overloaded. Retrying the same request later may be successful

Authorization

Write - /data-transfer/output-ports/{uuid}

DELETE

Commit or cancel the specified transaction

Request

consumes:

application/octet-stream

Name	Location	Type	Description
responseCode	query	integer (int32)	The response code. Available values are CONFIRM_TRANSACTION(12) or CANCEL_TRANSACTION(15).
checksum	query	string	A checksum calculated at client side using CRC32 to check flow file content integrity. It must match with the value calculated at server side.
portId	path	string	The output port id.
transactionId	path	string	The transaction id.

Response

produces:

application/json

Status Code	Type	Description
200	TransactionResultEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.
503	string	NiFi instance is not ready for serving request, or temporarily overloaded. Retrying the same request later may be successful

Authorization

Write - /data-transfer/output-ports/{uuid}

GET

Transfer flow files from the output port

Request

consumes:

*/*

Name	Location	Type	Description
portId	path	string	The output port id.
transactionId	path	string

Response

produces:

application/octet-stream

Status Code	Type	Description
200	StreamingOutput	There is no flow file to return.
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.
503	string	NiFi instance is not ready for serving request, or temporarily overloaded. Retrying the same request later may be successful

Authorization

Write - /data-transfer/output-ports/{uuid}

POST

Create a transaction to the specified output port or input port

Request

Name	Location	Type	Description
portType	path	string	The port type.
portId	path	string

Response

produces:

application/json

Status Code	Type	Description
200	TransactionResultEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.
503	string	NiFi instance is not ready for serving request, or temporarily overloaded. Retrying the same request later may be successful

Authorization

Write - /data-transfer/{component-type}/{uuid}

GET

Retrieves details about this NiFi to put in the About dialog

Request

consumes:

*/*

Response

produces:

application/json

Status Code	Type	Description
200	AboutEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Read - /flow

GET

Retrieves the banners for this NiFi

Request

consumes:

*/*

Response

produces:

application/json

Status Code	Type	Description
200	BannerEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Read - /flow

GET

Gets current bulletins

Request

consumes:

*/*

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

Response

produces:

application/json

Status Code	Type	Description
200	BulletinBoardEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Read - /flow

Read - /{component-type}/{uuid} - For component specific bulletins

GET

Generates a client id.

Request

consumes:

*/*

Response

produces:

text/plain

Status Code	Type	Description
200		successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Read - /flow

GET

Searches the cluster for a node with the specified address

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

Request

consumes:

*/*

Name	Location	Type	Description
q	query	string	Node address to search for.

Response

produces:

application/json

Status Code	Type	Description
200	ClusterSearchResultsEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Read - /flow

GET

The cluster summary for this NiFi

Request

consumes:

*/*

Response

produces:

application/json

Status Code	Type	Description
200	ClusteSummaryEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Read - /flow

GET

Retrieves the configuration for this NiFi flow

Request

consumes:

*/*

Response

produces:

application/json

Status Code	Type	Description
200	FlowConfigurationEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Read - /flow

GET

Gets statistics for a connection

Request

consumes:

*/*

Name	Location	Type	Description
nodewise	query	boolean	Whether or not to include the breakdown per node. Optional, defaults to false
clusterNodeId	query	string	The id of the node where to get the statistics.
id	path	string	The connection id.

Response

produces:

application/json

Status Code	Type	Description
200	ConnectionStatisticsEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Read - /flow

GET

Gets status for a connection

Request

consumes:

*/*

Name	Location	Type	Description
nodewise	query	boolean	Whether or not to include the breakdown per node. Optional, defaults to false
clusterNodeId	query	string	The id of the node where to get the status.
id	path	string	The connection id.

Response

produces:

application/json

Status Code	Type	Description
200	ConnectionStatusEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Read - /flow

GET

Gets the status history for a connection

Request

consumes:

*/*

Name	Location	Type	Description
id	path	string	The connection id.

Response

produces:

application/json

Status Code	Type	Description
200	StatusHistoryEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Read - /flow

GET

Retrieves the types of controller services that this NiFi supports

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

Request

consumes:

*/*

Name	Location	Type	Description
serviceType	query	string	If specified, will only return controller services that are compatible with this type of service.
serviceBundleGroup	query	string	If serviceType specified, is the bundle group of the serviceType.
serviceBundleArtifact	query	string	If serviceType specified, is the bundle artifact of the serviceType.
serviceBundleVersion	query	string	If serviceType specified, is the bundle version of the serviceType.
bundleGroupFilter	query	string	If specified, will only return types that are a member of this bundle group.
bundleArtifactFilter	query	string	If specified, will only return types that are a member of this bundle artifact.
typeFilter	query	string	If specified, will only return types whose fully qualified classname matches.

Response

produces:

application/json

Status Code	Type	Description
200	ControllerServiceTypesEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Read - /flow

GET

Retrieves Controller level bulletins

Request

consumes:

*/*

Response

produces:

application/json

Status Code	Type	Description
200	ControllerBulletinsEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Read - /flow

Read - /controller - For controller bulletins

Read - /controller-services/{uuid} - For controller service bulletins

Read - /reporting-tasks/{uuid} - For reporting task bulletins

GET

Gets controller services for reporting tasks

If the uiOnly query parameter is provided with a value of true, the returned entity may only contain fields that are necessary for rendering the NiFi User Interface. As such, the selected fields may change at any time, even during incremental releases, without warning. As a result, this parameter should not be provided by any client other than the UI.

Request

consumes:

*/*

Name	Location	Type	Description
uiOnly	query	boolean
includeReferencingComponents	query	boolean	Whether or not to include services' referencing components in the response

Response

produces:

application/json

Status Code	Type	Description
200	ControllerServicesEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Read - /flow

GET

Retrieves the user identity of the user making the request

Request

consumes:

*/*

Response

produces:

application/json

Status Code	Type	Description
200	CurrentUserEntity	successful operation

Authorization

Read - /flow

GET

Gets configuration history

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

Request

consumes:

*/*

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

Response

produces:

application/json

Status Code	Type	Description
200	HistoryEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Read - /flow

GET

Gets configuration history for a component

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

Request

consumes:

*/*

Name	Location	Type	Description
componentId	path	string	The component id.

Response

produces:

application/json

Status Code	Type	Description
200	ComponentHistoryEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Read - /flow

Read underlying component - /{component-type}/{uuid}

GET

Gets an action

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

Request

consumes:

*/*

Name	Location	Type	Description
id	path	string	The action id.

Response

produces:

application/json

Status Code	Type	Description
200	ActionEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Read - /flow

GET

Gets status for an input port

Request

consumes:

*/*

Name	Location	Type	Description
nodewise	query	boolean	Whether or not to include the breakdown per node. Optional, defaults to false
clusterNodeId	query	string	The id of the node where to get the status.
id	path	string	The input port id.

Response

produces:

application/json

Status Code	Type	Description
200	PortStatusEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Read - /flow

GET

Gets all metrics for the flow from a particular node

Request

consumes:

*/*

Name	Location	Type	Description
producer	path	string	The producer for flow file metrics. Each producer may have its own output format.
includedRegistries	query	Array[string] (multi)	Set of included metrics registries
sampleName	query	string	Regular Expression Pattern to be applied against the sample name field
sampleLabelValue	query	string	Regular Expression Pattern to be applied against the sample label value field
rootFieldName	query	string	Name of the first field of JSON object. Applicable for JSON producer only.

Response

produces:

*/*

Status Code	Type	Description
200	StreamingOutput	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Read - /flow

GET

Gets status for an output port

Request

consumes:

*/*

Name	Location	Type	Description
nodewise	query	boolean	Whether or not to include the breakdown per node. Optional, defaults to false
clusterNodeId	query	string	The id of the node where to get the status.
id	path	string	The output port id.

Response

produces:

application/json

Status Code	Type	Description
200	PortStatusEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Read - /flow

GET

Gets all Parameter Contexts

Request

consumes:

*/*

Response

produces:

application/json

Status Code	Type	Description
200	ParameterContextsEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Read - /parameter-contexts/{id} for each Parameter Context

GET

Retrieves the types of parameter providers that this NiFi supports

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

Request

consumes:

*/*

Name	Location	Type	Description
bundleGroupFilter	query	string	If specified, will only return types that are a member of this bundle group.
bundleArtifactFilter	query	string	If specified, will only return types that are a member of this bundle artifact.
type	query	string	If specified, will only return types whose fully qualified classname matches.

Response

produces:

application/json

Status Code	Type	Description
200	ParameterProviderTypesEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Read - /flow

GET

Gets all parameter providers

Request

consumes:

*/*

Response

produces:

application/json

Status Code	Type	Description
200	ParameterProvidersEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Read - /flow

GET

Retrieves the types of prioritizers that this NiFi supports

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

Request

consumes:

*/*

Response

produces:

application/json

Status Code	Type	Description
200	PrioritizerTypesEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Read - /flow

GET

Gets a process group

If the uiOnly query parameter is provided with a value of true, the returned entity may only contain fields that are necessary for rendering the NiFi User Interface. As such, the selected fields may change at any time, even during incremental releases, without warning. As a result, this parameter should not be provided by any client other than the UI.

Request

consumes:

*/*

Name	Location	Type	Description
id	path	string	The process group id.
uiOnly	query	boolean

Response

produces:

application/json

Status Code	Type	Description
200	ProcessGroupFlowEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Read - /flow

PUT

Schedule or unschedule components in the specified Process Group.

Request

consumes:

application/json

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

Response

produces:

application/json

Status Code	Type	Description
200	ScheduleComponentsEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Read - /flow

Write - /{component-type}/{uuid} or /operation/{component-type}/{uuid} - For every component being scheduled/unscheduled

GET

Gets all controller services

If the uiOnly query parameter is provided with a value of true, the returned entity may only contain fields that are necessary for rendering the NiFi User Interface. As such, the selected fields may change at any time, even during incremental releases, without warning. As a result, this parameter should not be provided by any client other than the UI.

Request

consumes:

*/*

Name	Location	Type	Description
id	path	string	The process group id.
includeAncestorGroups	query	boolean	Whether or not to include parent/ancestor process groups
includeDescendantGroups	query	boolean	Whether or not to include descendant process groups
includeReferencingComponents	query	boolean	Whether or not to include services' referencing components in the response
uiOnly	query	boolean

Response

produces:

application/json

Status Code	Type	Description
200	ControllerServicesEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Read - /flow

PUT

Enable or disable Controller Services in the specified Process Group.

Request

consumes:

application/json

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

Response

produces:

application/json

Status Code	Type	Description
200	ActivateControllerServicesEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Read - /flow

Write - /{component-type}/{uuid} or /operation/{component-type}/{uuid} - For every service being enabled/disabled

GET

Gets the status for a process group

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

Request

consumes:

*/*

Name	Location	Type	Description
recursive	query	boolean	Whether all descendant groups and the status of their content will be included. Optional, defaults to false
nodewise	query	boolean	Whether or not to include the breakdown per node. Optional, defaults to false
clusterNodeId	query	string	The id of the node where to get the status.
id	path	string	The process group id.

Response

produces:

application/json

Status Code	Type	Description
200	ProcessGroupStatusEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Read - /flow

GET

Gets status history for a remote process group

Request

consumes:

*/*

Name	Location	Type	Description
id	path	string	The process group id.

Response

produces:

application/json

Status Code	Type	Description
200	StatusHistoryEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Read - /flow

GET

Retrieves the types of processors that this NiFi supports

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

Request

consumes:

*/*

Name	Location	Type	Description
bundleGroupFilter	query	string	If specified, will only return types that are a member of this bundle group.
bundleArtifactFilter	query	string	If specified, will only return types that are a member of this bundle artifact.
type	query	string	If specified, will only return types whose fully qualified classname matches.

Response

produces:

application/json

Status Code	Type	Description
200	ProcessorTypesEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Read - /flow

GET

Gets status for a processor

Request

consumes:

*/*

Name	Location	Type	Description
nodewise	query	boolean	Whether or not to include the breakdown per node. Optional, defaults to false
clusterNodeId	query	string	The id of the node where to get the status.
id	path	string	The processor id.

Response

produces:

application/json

Status Code	Type	Description
200	ProcessorStatusEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Read - /flow

GET

Gets status history for a processor

Request

consumes:

*/*

Name	Location	Type	Description
id	path	string	The processor id.

Response

produces:

application/json

Status Code	Type	Description
200	StatusHistoryEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Read - /flow

GET

Gets the listing of available flow registry clients

Request

consumes:

*/*

Response

produces:

application/json

Status Code	Type	Description
200	FlowRegistryClientsEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Read - /flow

GET

Gets the buckets from the specified registry for the current user

Request

consumes:

*/*

Name	Location	Type	Description
id	path	string	The registry id.

Response

produces:

application/json

Status Code	Type	Description
200	FlowRegistryBucketsEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Read - /flow

GET

Gets the flows from the specified registry and bucket for the current user

Request

consumes:

*/*

Name	Location	Type	Description
registry-id	path	string	The registry client id.
bucket-id	path	string	The bucket id.

Response

produces:

application/json

Status Code	Type	Description
200	VersionedFlowsEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Read - /flow

GET

Gets the details of a flow from the specified registry and bucket for the specified flow for the current user

Request

consumes:

*/*

Name	Location	Type	Description
registry-id	path	string	The registry client id.
bucket-id	path	string	The bucket id.
flow-id	path	string	The flow id.

Response

produces:

application/json

Status Code	Type	Description
200	VersionedFlowEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Read - /flow

GET

Gets the flow versions from the specified registry and bucket for the specified flow for the current user

Request

consumes:

*/*

Name	Location	Type	Description
registry-id	path	string	The registry client id.
bucket-id	path	string	The bucket id.
flow-id	path	string	The flow id.

Response

produces:

application/json

Status Code	Type	Description
200	VersionedFlowSnapshotMetadataSetEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Read - /flow

GET

Gets the differences between two versions of the same versioned flow, the basis of the comparison will be the first version

Request

consumes:

*/*

Name	Location	Type	Description
registry-id	path	string	The registry client id.
bucket-id	path	string	The bucket id.
flow-id	path	string	The flow id.
version-a	path	integer (int32)	The base version.
version-b	path	integer (int32)	The compared version.
offset	query	integer (int32)	Must be a non-negative number. Specifies the starting point of the listing. 0 means start from the beginning.
limit	query	integer (int32)	Limits the number of differences listed. This might lead to partial result. 0 means no limitation is applied.

Response

produces:

application/json

Status Code	Type	Description
200	FlowComparisonEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it.

Authorization

Read - /flow

GET

Gets status for a remote process group

Request

consumes:

*/*

Name	Location	Type	Description
nodewise	query	boolean	Whether or not to include the breakdown per node. Optional, defaults to false
clusterNodeId	query	string	The id of the node where to get the status.
id	path	string	The remote process group id.

Response

produces:

application/json

Status Code	Type	Description
200	RemoteProcessGroupStatusEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Read - /flow

GET

Gets the status history

Request

consumes:

*/*

Name	Location	Type	Description
id	path	string	The remote process group id.

Response

produces:

application/json

Status Code	Type	Description
200	StatusHistoryEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Read - /flow

GET

Retrieves the types of reporting tasks that this NiFi supports

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

Request

consumes:

*/*

Name	Location	Type	Description
bundleGroupFilter	query	string	If specified, will only return types that are a member of this bundle group.
bundleArtifactFilter	query	string	If specified, will only return types that are a member of this bundle artifact.
type	query	string	If specified, will only return types whose fully qualified classname matches.

Response

produces:

application/json

Status Code	Type	Description
200	ReportingTaskTypesEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Read - /flow

GET

Gets all reporting tasks

Request

consumes:

*/*

Response

produces:

application/json

Status Code	Type	Description
200	ReportingTasksEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Read - /flow

GET

Download a snapshot of the given reporting tasks and any controller services they use

Request

consumes:

*/*

Name	Location	Type	Description
reportingTaskId	query	string	Specifies a reporting task id to export. If not specified, all reporting tasks will be exported.

Response

produces:

application/json

Status Code	Type	Description
200		successful operation
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Read - /flow

GET

Get a snapshot of the given reporting tasks and any controller services they use

Request

consumes:

*/*

Name	Location	Type	Description
reportingTaskId	query	string	Specifies a reporting task id to export. If not specified, all reporting tasks will be exported.

Response

produces:

application/json

Status Code	Type	Description
200	VersionedReportingTaskSnapshot	successful operation
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Read - /flow

GET

Retrieves the runtime manifest for this NiFi instance.

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

Request

consumes:

*/*

Response

produces:

application/json

Status Code	Type	Description
200	RuntimeManifestEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Read - /flow

GET

Performs a search against this NiFi using the specified search term

Only search results from authorized components will be returned.

Request

consumes:

*/*

Name	Location	Type	Description
q	query	string
a	query	string

Response

produces:

application/json

Status Code	Type	Description
200	SearchResultsEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Read - /flow

GET

Gets the current status of this NiFi

Request

consumes:

*/*

Response

produces:

application/json

Status Code	Type	Description
200	ControllerStatusEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Read - /flow

GET

Gets all templates

Request

consumes:

*/*

Response

produces:

application/json

Status Code	Type	Description
200	TemplatesEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Read - /flow

POST

Creates a request to drop the contents of the queue in this connection.

Request

consumes:

*/*

Name	Location	Type	Description
id	path	string	The connection id.

Response

produces:

application/json

Status Code	Type	Description
200	DropRequestEntity	successful operation
202	string	The request has been accepted. A HTTP response header will contain the URI where the response can be polled.
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Write Source Data - /data/{component-type}/{uuid}

GET

Gets the current status of a drop request for the specified connection.

Request

consumes:

*/*

Name	Location	Type	Description
id	path	string	The connection id.
drop-request-id	path	string	The drop request id.

Response

produces:

application/json

Status Code	Type	Description
200	DropRequestEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Write Source Data - /data/{component-type}/{uuid}

DELETE

Cancels and/or removes a request to drop the contents of this connection.

Request

consumes:

*/*

Name	Location	Type	Description
id	path	string	The connection id.
drop-request-id	path	string	The drop request id.

Response

produces:

application/json

Status Code	Type	Description
200	DropRequestEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Write Source Data - /data/{component-type}/{uuid}

GET

Gets a FlowFile from a Connection.

Request

consumes:

*/*

Name	Location	Type	Description
id	path	string	The connection id.
flowfile-uuid	path	string	The flowfile uuid.
clusterNodeId	query	string	The id of the node where the content exists if clustered.

Response

produces:

application/json

Status Code	Type	Description
200	FlowFileEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Read Source Data - /data/{component-type}/{uuid}

GET

Gets the content for a FlowFile in a Connection.

Request

consumes:

*/*

Name	Location	Type	Description
clientId	query	string	If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.
id	path	string	The connection id.
flowfile-uuid	path	string	The flowfile uuid.
clusterNodeId	query	string	The id of the node where the content exists if clustered.

Response

produces:

*/*

Status Code	Type	Description
200	StreamingOutput	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Read Source Data - /data/{component-type}/{uuid}

POST

Lists the contents of the queue in this connection.

Request

consumes:

*/*

Name	Location	Type	Description
id	path	string	The connection id.

Response

produces:

application/json

Status Code	Type	Description
200	ListingRequestEntity	successful operation
202	string	The request has been accepted. A HTTP response header will contain the URI where the response can be polled.
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Read Source Data - /data/{component-type}/{uuid}

GET

Gets the current status of a listing request for the specified connection.

Request

consumes:

*/*

Name	Location	Type	Description
id	path	string	The connection id.
listing-request-id	path	string	The listing request id.

Response

produces:

application/json

Status Code	Type	Description
200	ListingRequestEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Read Source Data - /data/{component-type}/{uuid}

DELETE

Cancels and/or removes a request to list the contents of this connection.

Request

consumes:

*/*

Name	Location	Type	Description
id	path	string	The connection id.
listing-request-id	path	string	The listing request id.

Response

produces:

application/json

Status Code	Type	Description
200	ListingRequestEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Read Source Data - /data/{component-type}/{uuid}

GET

Gets a funnel

Request

consumes:

*/*

Name	Location	Type	Description
id	path	string	The funnel id.

Response

produces:

application/json

Status Code	Type	Description
200	FunnelEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Read - /funnels/{uuid}

PUT

Updates a funnel

Request

consumes:

application/json

Name	Location	Type	Description
id	path	string	The funnel id.
	body	FunnelEntity	The funnel configuration details.

Response

produces:

application/json

Status Code	Type	Description
200	FunnelEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Write - /funnels/{uuid}

DELETE

Deletes a funnel

Request

consumes:

*/*

Name	Location	Type	Description
version	query	string	The revision is used to verify the client is working with the latest version of the flow.
clientId	query	string	If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.
disconnectedNodeAcknowledged	query	boolean	Acknowledges that this node is disconnected to allow for mutable requests to proceed.
id	path	string	The funnel id.

Response

produces:

application/json

Status Code	Type	Description
200	FunnelEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Write - /funnels/{uuid}

Write - Parent Process Group - /process-groups/{uuid}

GET

Gets an input port

Request

consumes:

*/*

Name	Location	Type	Description
id	path	string	The input port id.

Response

produces:

application/json

Status Code	Type	Description
200	PortEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Read - /input-ports/{uuid}

PUT

Updates an input port

Request

consumes:

application/json

Name	Location	Type	Description
id	path	string	The input port id.
	body	PortEntity	The input port configuration details.

Response

produces:

application/json

Status Code	Type	Description
200	PortEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Write - /input-ports/{uuid}

DELETE

Deletes an input port

Request

consumes:

*/*

Name	Location	Type	Description
version	query	string	The revision is used to verify the client is working with the latest version of the flow.
clientId	query	string	If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.
disconnectedNodeAcknowledged	query	boolean	Acknowledges that this node is disconnected to allow for mutable requests to proceed.
id	path	string	The input port id.

Response

produces:

application/json

Status Code	Type	Description
200	PortEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Write - /input-ports/{uuid}

Write - Parent Process Group - /process-groups/{uuid}

PUT

Updates run status of an input-port

Request

consumes:

application/json

Name	Location	Type	Description
id	path	string	The port id.
	body	PortRunStatusEntity	The port run status.

Response

produces:

application/json

Status Code	Type	Description
200	ProcessorEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Write - /input-ports/{uuid} or /operation/input-ports/{uuid}

GET

Gets a label

Request

consumes:

*/*

Name	Location	Type	Description
id	path	string	The label id.

Response

produces:

application/json

Status Code	Type	Description
200	LabelEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Read - /labels/{uuid}

PUT

Updates a label

Request

consumes:

application/json

Name	Location	Type	Description
id	path	string	The label id.
	body	LabelEntity	The label configuration details.

Response

produces:

application/json

Status Code	Type	Description
200	LabelEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Write - /labels/{uuid}

DELETE

Deletes a label

Request

consumes:

*/*

Name	Location	Type	Description
version	query	string	The revision is used to verify the client is working with the latest version of the flow.
clientId	query	string	If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.
disconnectedNodeAcknowledged	query	boolean	Acknowledges that this node is disconnected to allow for mutable requests to proceed.
id	path	string	The label id.

Response

produces:

application/json

Status Code	Type	Description
200	LabelEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Write - /labels/{uuid}

Write - Parent Process Group - /process-groups/{uuid}

GET

Gets an output port

Request

consumes:

*/*

Name	Location	Type	Description
id	path	string	The output port id.

Response

produces:

application/json

Status Code	Type	Description
200	PortEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Read - /output-ports/{uuid}

PUT

Updates an output port

Request

consumes:

application/json

Name	Location	Type	Description
id	path	string	The output port id.
	body	PortEntity	The output port configuration details.

Response

produces:

application/json

Status Code	Type	Description
200	PortEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Write - /output-ports/{uuid}

DELETE

Deletes an output port

Request

consumes:

*/*

Name	Location	Type	Description
version	query	string	The revision is used to verify the client is working with the latest version of the flow.
clientId	query	string	If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.
disconnectedNodeAcknowledged	query	boolean	Acknowledges that this node is disconnected to allow for mutable requests to proceed.
id	path	string	The output port id.

Response

produces:

application/json

Status Code	Type	Description
200	PortEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Write - /output-ports/{uuid}

Write - Parent Process Group - /process-groups/{uuid}

PUT

Updates run status of an output-port

Request

consumes:

application/json

Name	Location	Type	Description
id	path	string	The port id.
	body	PortRunStatusEntity	The port run status.

Response

produces:

application/json

Status Code	Type	Description
200	ProcessorEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Write - /output-ports/{uuid} or /operation/output-ports/{uuid}

POST

Create a Parameter Context

Request

consumes:

application/json

Name	Location	Type	Description
	body	ParameterContextEntity	The Parameter Context.

Response

produces:

application/json

Status Code	Type	Description
200	ParameterContextEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Write - /parameter-contexts

Read - for every inherited parameter context

POST

Initiate the Update Request of a Parameter Context

This will initiate the process of updating a Parameter Context. Changing the value of a Parameter may require that one or more components be stopped and restarted, so this action may take significantly more time than many other REST API actions. As a result, this endpoint will immediately return a ParameterContextUpdateRequestEntity, and the process of updating the necessary components will occur asynchronously in the background. The client may then periodically poll the status of the request by issuing a GET request to /parameter-contexts/update-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /parameter-contexts/update-requests/{requestId}.

Request

consumes:

application/json

Name	Location	Type	Description
contextId	path	string
	body	ParameterContextEntity	The updated version of the parameter context.

Response

produces:

application/json

Status Code	Type	Description
200	ParameterContextUpdateRequestEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Read - /parameter-contexts/{parameterContextId}

Write - /parameter-contexts/{parameterContextId}

Read - for every component that is affected by the update

Write - for every component that is affected by the update

Read - for every currently inherited parameter context

Read - for any new inherited parameter context

GET

Returns the Update Request with the given ID

Returns the Update Request with the given ID. Once an Update Request has been created by performing a POST to /nifi-api/parameter-contexts, 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.

Request

consumes:

*/*

Name	Location	Type	Description
contextId	path	string	The ID of the Parameter Context
requestId	path	string	The ID of the Update Request

Response

produces:

application/json

Status Code	Type	Description
200	ParameterContextUpdateRequestEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Only the user that submitted the request can get it

DELETE

Deletes the Update Request with the given ID

Deletes the Update Request with the given ID. After a request is created via a POST to /nifi-api/parameter-contexts/update-requests, 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.

Request

consumes:

*/*

Name	Location	Type	Description
disconnectedNodeAcknowledged	query	boolean	Acknowledges that this node is disconnected to allow for mutable requests to proceed.
contextId	path	string	The ID of the ParameterContext
requestId	path	string	The ID of the Update Request

Response

produces:

application/json

Status Code	Type	Description
200	ParameterContextUpdateRequestEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Only the user that submitted the request can remove it

POST

Initiate a Validation Request to determine how the validity of components will change if a Parameter Context were to be updated

This will initiate the process of validating all components whose Process Group is bound to the specified Parameter Context. Performing validation against an arbitrary number of components may be expect and take significantly more time than many other REST API actions. As a result, this endpoint will immediately return a ParameterContextValidationRequestEntity, and the process of validating the necessary components will occur asynchronously in the background. The client may then periodically poll the status of the request by issuing a GET request to /parameter-contexts/validation-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /parameter-contexts/validation-requests/{requestId}.

Request

consumes:

application/json

Name	Location	Type	Description
contextId	path	string
	body	ParameterContextValidationRequestEntity	The validation request

Response

produces:

application/json

Status Code	Type	Description
200	ParameterContextValidationRequestEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Read - /parameter-contexts/{parameterContextId}

GET

Returns the Validation Request with the given ID

Returns the Validation Request with the given ID. Once a Validation Request has been created by performing a POST to /nifi-api/validation-contexts, 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.

Request

consumes:

*/*

Name	Location	Type	Description
contextId	path	string	The ID of the Parameter Context
id	path	string	The ID of the Validation Request

Response

produces:

application/json

Status Code	Type	Description
200	ParameterContextValidationRequestEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Only the user that submitted the request can get it

DELETE

Deletes the Validation Request with the given ID

Deletes the Validation Request with the given ID. After a request is created via a POST to /nifi-api/validation-contexts, it is expected that the client will properly clean up the request by DELETE'ing it, once the validation process has completed. If the request is deleted before the request completes, then the Validation request will finish the step that it is currently performing and then will cancel any subsequent steps.

Request

consumes:

*/*

Name	Location	Type	Description
disconnectedNodeAcknowledged	query	boolean	Acknowledges that this node is disconnected to allow for mutable requests to proceed.
contextId	path	string	The ID of the Parameter Context
id	path	string	The ID of the Update Request

Response

produces:

application/json

Status Code	Type	Description
200	ParameterContextValidationRequestEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Only the user that submitted the request can remove it

GET

Returns the Parameter Context with the given ID

Returns the Parameter Context with the given ID.

Request

consumes:

*/*

Name	Location	Type	Description
id	path	string	The ID of the Parameter Context
includeInheritedParameters	query	boolean	Whether or not to include inherited parameters from other parameter contexts, and therefore also overridden values. If true, the result will be the 'effective' parameter context.

Response

produces:

application/json

Status Code	Type	Description
200	ParameterContextEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Read - /parameter-contexts/{id}

PUT

Modifies a Parameter Context

This endpoint will update a Parameter Context to match the provided entity. However, this request will fail if any component is running and is referencing a Parameter in the Parameter Context. Generally, this endpoint is not called directly. Instead, an update request should be submitted by making a POST to the /parameter-contexts/update-requests endpoint. That endpoint will, in turn, call this endpoint.

Request

consumes:

application/json

Name	Location	Type	Description
id	path	string
	body	ParameterContextEntity	The updated Parameter Context

Response

produces:

application/json

Status Code	Type	Description
200	ParameterContextEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Read - /parameter-contexts/{id}

Write - /parameter-contexts/{id}

DELETE

Deletes the Parameter Context with the given ID

Deletes the Parameter Context with the given ID.

Request

consumes:

*/*

Name	Location	Type	Description
version	query	string	The version is used to verify the client is working with the latest version of the flow.
clientId	query	string	If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response.
disconnectedNodeAcknowledged	query	boolean	Acknowledges that this node is disconnected to allow for mutable requests to proceed.
id	path	string	The Parameter Context ID.

Response

produces:

application/json

Status Code	Type	Description
200	ParameterContextEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Read - /parameter-contexts/{uuid}

Write - /parameter-contexts/{uuid}

Read - /process-groups/{uuid}, for any Process Group that is currently bound to the Parameter Context

Write - /process-groups/{uuid}, for any Process Group that is currently bound to the Parameter Context

GET

Gets a parameter provider

Request

consumes:

*/*

Name	Location	Type	Description
id	path	string	The parameter provider id.

Response

produces:

application/json

Status Code	Type	Description
200	ParameterProviderEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Read - /parameter-providers/{uuid}

PUT

Updates a parameter provider

Request

consumes:

application/json

Name	Location	Type	Description
id	path	string	The parameter provider id.
	body	ParameterProviderEntity	The parameter provider configuration details.

Response

produces:

application/json

Status Code	Type	Description
200	ParameterProviderEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Write - /parameter-providers/{uuid}

Read - any referenced Controller Services if this request changes the reference - /controller-services/{uuid}

DELETE

Deletes a parameter provider

Request

consumes:

*/*

Name	Location	Type	Description
version	query	string	The revision is used to verify the client is working with the latest version of the flow.
clientId	query	string	If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.
disconnectedNodeAcknowledged	query	boolean	Acknowledges that this node is disconnected to allow for mutable requests to proceed.
id	path	string	The parameter provider id.

Response

produces:

application/json

Status Code	Type	Description
200	ParameterProviderEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Write - /parameter-providers/{uuid}

Write - /controller

Read - any referenced Controller Services - /controller-services/{uuid}

POST

Performs analysis of the component's configuration, providing information about which attributes are referenced.

Request

consumes:

application/json

Name	Location	Type	Description
id	path	string	The parameter provider id.
	body	ConfigurationAnalysisEntity	The configuration analysis request.

Response

produces:

application/json

Status Code	Type	Description
200	ConfigurationAnalysisEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Read - /parameter-providers/{uuid}

POST

Performs verification of the Parameter Provider's configuration

This will initiate the process of verifying a given Parameter Provider configuration. This may be a long-running task. As a result, this endpoint will immediately return a ParameterProviderConfigVerificationRequestEntity, and the process of performing the verification will occur asynchronously in the background. The client may then periodically poll the status of the request by issuing a GET request to /parameter-providers/{serviceId}/verification-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /parameter-providers/{providerId}/verification-requests/{requestId}.

Request

consumes:

application/json

Name	Location	Type	Description
id	path	string	The parameter provider id.
	body	VerifyConfigRequestEntity	The parameter provider configuration verification request.

Response

produces:

application/json

Status Code	Type	Description
200	VerifyConfigRequestEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Read - /parameter-providers/{uuid}

GET

Returns the Verification Request with the given ID

Returns the Verification Request with the given ID. Once an Verification Request has been created, 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.

Request

consumes:

*/*

Name	Location	Type	Description
id	path	string	The ID of the Parameter Provider
requestId	path	string	The ID of the Verification Request

Response

produces:

application/json

Status Code	Type	Description
200	VerifyConfigRequestEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Only the user that submitted the request can get it

DELETE

Deletes the Verification Request with the given ID

Deletes the Verification Request with the given ID. After a request is created, it is expected that the client will properly clean up the request by DELETE'ing it, once the Verification process has completed. If the request is deleted before the request completes, then the Verification request will finish the step that it is currently performing and then will cancel any subsequent steps.

Request

consumes:

*/*

Name	Location	Type	Description
id	path	string	The ID of the Parameter Provider
requestId	path	string	The ID of the Verification Request

Response

produces:

application/json

Status Code	Type	Description
200	VerifyConfigRequestEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Only the user that submitted the request can remove it

GET

Gets a parameter provider property descriptor

Request

consumes:

*/*

Name	Location	Type	Description
id	path	string	The parameter provider id.
propertyName	query	string	The property name.

Response

produces:

application/json

Status Code	Type	Description
200	PropertyDescriptorEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Read - /parameter-providers/{uuid}

POST

Fetches and temporarily caches the parameters for a provider

Request

consumes:

application/json

Name	Location	Type	Description
id	path	string	The parameter provider id.
	body	ParameterProviderParameterFetchEntity	The parameter fetch request.

Response

produces:

application/json

Status Code	Type	Description
200	ParameterProviderEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Write - /parameter-providers/{uuid} or or /operation/parameter-providers/{uuid}

GET

Gets all references to a parameter provider

Request

consumes:

*/*

Name	Location	Type	Description
id	path	string	The parameter provider id.

Response

produces:

application/json

Status Code	Type	Description
200	ParameterProviderReferencingComponentsEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Read - /parameter-providers/{uuid}

GET

Gets the state for a parameter provider

Request

consumes:

*/*

Name	Location	Type	Description
id	path	string	The parameter provider id.

Response

produces:

application/json

Status Code	Type	Description
200	ComponentStateEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Write - /parameter-providers/{uuid}

POST

Clears the state for a parameter provider

Request

consumes:

*/*

Name	Location	Type	Description
id	path	string	The parameter provider id.

Response

produces:

application/json

Status Code	Type	Description
200	ComponentStateEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Write - /parameter-providers/{uuid}

POST

Initiate a request to apply the fetched parameters of a Parameter Provider

This will initiate the process of applying fetched parameters to all referencing Parameter Contexts. Changing the value of a Parameter may require that one or more components be stopped and restarted, so this action may take significantly more time than many other REST API actions. As a result, this endpoint will immediately return a ParameterProviderApplyParametersRequestEntity, and the process of updating the necessary components will occur asynchronously in the background. The client may then periodically poll the status of the request by issuing a GET request to /parameter-providers/apply-parameters-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /parameter-providers/apply-parameters-requests/{requestId}.

Request

consumes:

application/json

Name	Location	Type	Description
providerId	path	string
	body	ParameterProviderParameterApplicationEntity	The apply parameters request.

Response

produces:

application/json

Status Code	Type	Description
200	ParameterProviderApplyParametersRequestEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Read - /parameter-providers/{parameterProviderId}

Write - /parameter-providers/{parameterProviderId}

Read - for every component that is affected by the update

Write - for every component that is affected by the update

GET

Returns the Apply Parameters Request with the given ID

Returns the Apply Parameters Request with the given ID. Once an Apply Parameters Request has been created by performing a POST to /nifi-api/parameter-providers, that request can subsequently be retrieved via this endpoint, and the request that is fetched will contain the state, such as percent complete, the current state of the request, and any failures.

Request

consumes:

*/*

Name	Location	Type	Description
providerId	path	string	The ID of the Parameter Provider
requestId	path	string	The ID of the Apply Parameters Request

Response

produces:

application/json

Status Code	Type	Description
200	ParameterProviderApplyParametersRequestEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Only the user that submitted the request can get it

DELETE

Deletes the Apply Parameters Request with the given ID

Deletes the Apply Parameters Request with the given ID. After a request is created via a POST to /nifi-api/parameter-providers/apply-parameters-requests, it is expected that the client will properly clean up the request by DELETE'ing it, once the Apply process has completed. If the request is deleted before the request completes, then the Apply Parameters Request will finish the step that it is currently performing and then will cancel any subsequent steps.

Request

consumes:

*/*

Name	Location	Type	Description
disconnectedNodeAcknowledged	query	boolean	Acknowledges that this node is disconnected to allow for mutable requests to proceed.
providerId	path	string	The ID of the Parameter Provider
requestId	path	string	The ID of the Apply Parameters Request

Response

produces:

application/json

Status Code	Type	Description
200	ParameterProviderApplyParametersRequestEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Only the user that submitted the request can remove it

POST

Creates an access policy

Request

consumes:

application/json

Name	Location	Type	Description
	body	AccessPolicyEntity	The access policy configuration details.

Response

produces:

application/json

Status Code	Type	Description
200	AccessPolicyEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Write - /policies/{resource}

GET

Gets an access policy for the specified action and resource

Will return the effective policy if no component specific policy exists for the specified action and resource. Must have Read permissions to the policy with the desired action and resource. Permissions for the policy that is returned will be indicated in the response. This means the client could be authorized to get the policy for a given component but the effective policy may be inherited from an ancestor Process Group. If the client does not have permissions to that policy, the response will not include the policy and the permissions in the response will be marked accordingly. If the client does not have permissions to the policy of the desired action and resource a 403 response will be returned.

Request

consumes:

*/*

Name	Location	Type	Description
action	path	string	The request action.
resource	path	string	The resource of the policy.

Response

produces:

application/json

Status Code	Type	Description
200	AccessPolicyEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Read - /policies/{resource}

GET

Gets an access policy

Request

consumes:

*/*

Name	Location	Type	Description
id	path	string	The access policy id.

Response

produces:

application/json

Status Code	Type	Description
200	AccessPolicyEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Read - /policies/{resource}

PUT

Updates a access policy

Request

consumes:

application/json

Name	Location	Type	Description
id	path	string	The access policy id.
	body	AccessPolicyEntity	The access policy configuration details.

Response

produces:

application/json

Status Code	Type	Description
200	AccessPolicyEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Write - /policies/{resource}

DELETE

Deletes an access policy

Request

consumes:

*/*

Name	Location	Type	Description
version	query	string	The revision is used to verify the client is working with the latest version of the flow.
clientId	query	string	If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.
disconnectedNodeAcknowledged	query	boolean	Acknowledges that this node is disconnected to allow for mutable requests to proceed.
id	path	string	The access policy id.

Response

produces:

application/json

Status Code	Type	Description
200	AccessPolicyEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Write - /policies/{resource}

Write - Policy of the parent resource - /policies/{resource}

GET

Returns the Replace Request with the given ID

Returns the Replace Request with the given ID. Once a Replace Request has been created by performing a POST to /process-groups/{id}/replace-requests, 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. Note: This endpoint is subject to change as NiFi and it's REST API evolve.

Request

consumes:

*/*

Name	Location	Type	Description
id	path	string	The ID of the Replace Request

Response

produces:

application/json

Status Code	Type	Description
200	ProcessGroupReplaceRequestEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Only the user that submitted the request can get it

DELETE

Deletes the Replace Request with the given ID

Deletes the Replace Request with the given ID. After a request is created via a POST to /process-groups/{id}/replace-requests, it is expected that the client will properly clean up the request by DELETE'ing it, once the Replace process has completed. If the request is deleted before the request completes, then the Replace request will finish the step that it is currently performing and then will cancel any subsequent steps. Note: This endpoint is subject to change as NiFi and it's REST API evolve.

Request

consumes:

*/*

Name	Location	Type	Description
disconnectedNodeAcknowledged	query	boolean	Acknowledges that this node is disconnected to allow for mutable requests to proceed.
id	path	string	The ID of the Update Request

Response

produces:

application/json

Status Code	Type	Description
200	ProcessGroupReplaceRequestEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Only the user that submitted the request can remove it

GET

Gets a process group's variable registry

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

Request

consumes:

*/*

Name	Location	Type	Description
groupId	path	string	The process group id.
updateId	path	string	The ID of the Variable Registry Update Request

Response

produces:

application/json

Status Code	Type	Description
200	VariableRegistryUpdateRequestEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Read - /process-groups/{uuid}

DELETE

Deletes an update request for a process group's variable registry. If the request is not yet complete, it will automatically be cancelled.

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

Request

consumes:

*/*

Name	Location	Type	Description
groupId	path	string	The process group id.
updateId	path	string	The ID of the Variable Registry Update Request
disconnectedNodeAcknowledged	query	boolean	Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Response

produces:

application/json

Status Code	Type	Description
200	VariableRegistryUpdateRequestEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Read - /process-groups/{uuid}

GET

Gets a process group

Request

consumes:

*/*

Name	Location	Type	Description
id	path	string	The process group id.

Response

produces:

application/json

Status Code	Type	Description
200	ProcessGroupEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Read - /process-groups/{uuid}

PUT

Updates a process group

Request

consumes:

application/json

Name	Location	Type	Description
id	path	string	The process group id.
	body	ProcessGroupEntity	The process group configuration details.

Response

produces:

application/json

Status Code	Type	Description
200	ProcessGroupEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Write - /process-groups/{uuid}

DELETE

Deletes a process group

Request

consumes:

*/*

Name	Location	Type	Description
version	query	string	The revision is used to verify the client is working with the latest version of the flow.
clientId	query	string	If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.
disconnectedNodeAcknowledged	query	boolean	Acknowledges that this node is disconnected to allow for mutable requests to proceed.
id	path	string	The process group id.

Response

produces:

application/json

Status Code	Type	Description
200	ProcessGroupEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Write - /process-groups/{uuid}

Write - Parent Process Group - /process-groups/{uuid}

Read - any referenced Controller Services by any encapsulated components - /controller-services/{uuid}

Write - /{component-type}/{uuid} - For all encapsulated components

POST

Creates a connection

Request

consumes:

application/json

Name	Location	Type	Description
id	path	string	The process group id.
	body	ConnectionEntity	The connection configuration details.

Response

produces:

application/json

Status Code	Type	Description
200	ConnectionEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Write - /process-groups/{uuid}

Write Source - /{component-type}/{uuid}

Write Destination - /{component-type}/{uuid}

GET

Gets all connections

Request

consumes:

*/*

Name	Location	Type	Description
id	path	string	The process group id.

Response

produces:

application/json

Status Code	Type	Description
200	ConnectionsEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Read - /process-groups/{uuid}

POST

Creates a new controller service

Request

consumes:

application/json

Name	Location	Type	Description
id	path	string	The process group id.
	body	ControllerServiceEntity	The controller service configuration details.

Response

produces:

application/json

Status Code	Type	Description
200	ControllerServiceEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Write - /process-groups/{uuid}

Read - any referenced Controller Services - /controller-services/{uuid}

Write - if the Controller Service is restricted - /restricted-components

GET

Gets a process group for download

Request

consumes:

*/*

Name	Location	Type	Description
id	path	string	The process group id.
includeReferencedServices	query	boolean	If referenced services from outside the target group should be included

Response

produces:

application/json

Status Code	Type	Description
200		successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Read - /process-groups/{uuid}

POST

Creates a request to drop all flowfiles of all connection queues in this process group.

Request

consumes:

*/*

Name	Location	Type	Description
id	path	string	The process group id.

Response

produces:

application/json

Status Code	Type	Description
200	DropRequestEntity	successful operation
202	string	The request has been accepted. An HTTP response header will contain the URI where the status can be polled.
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Read - /process-groups/{uuid} - For this and all encapsulated process groups

Write Source Data - /data/{component-type}/{uuid} - For all encapsulated connections

GET

Gets the current status of a drop all flowfiles request.

Request

consumes:

*/*

Name	Location	Type	Description
id	path	string	The process group id.
drop-request-id	path	string	The drop request id.

Response

produces:

application/json

Status Code	Type	Description
200	DropRequestEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Read - /process-groups/{uuid} - For this and all encapsulated process groups

Write Source Data - /data/{component-type}/{uuid} - For all encapsulated connections

DELETE

Cancels and/or removes a request to drop all flowfiles.

Request

consumes:

*/*

Name	Location	Type	Description
id	path	string	The process group id.
drop-request-id	path	string	The drop request id.

Response

produces:

application/json

Status Code	Type	Description
200	DropRequestEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Read - /process-groups/{uuid} - For this and all encapsulated process groups

Write Source Data - /data/{component-type}/{uuid} - For all encapsulated connections

PUT

Replace Process Group contents with the given ID with the specified Process Group contents

This endpoint is used for replication within a cluster, when replacing a flow with a new flow. It expects that the flow beingreplaced is not under version control and that the given snapshot will not modify any Processor that is currently running or any Controller Service that is enabled. Note: This endpoint is subject to change as NiFi and it's REST API evolve.

Request

consumes:

application/json

Name	Location	Type	Description
id	path	string	The process group id.
	body	ProcessGroupImportEntity	The process group replace request entity.

Response

produces:

application/json

Status Code	Type	Description
200	ProcessGroupImportEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Read - /process-groups/{uuid}

Write - /process-groups/{uuid}

POST

Creates a funnel

Request

consumes:

application/json

Name	Location	Type	Description
id	path	string	The process group id.
	body	FunnelEntity	The funnel configuration details.

Response

produces:

application/json

Status Code	Type	Description
200	FunnelEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Write - /process-groups/{uuid}

GET

Gets all funnels

Request

consumes:

*/*

Name	Location	Type	Description
id	path	string	The process group id.

Response

produces:

application/json

Status Code	Type	Description
200	FunnelsEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Read - /process-groups/{uuid}

POST

Creates an input port

Request

consumes:

application/json

Name	Location	Type	Description
id	path	string	The process group id.
	body	PortEntity	The input port configuration details.

Response

produces:

application/json

Status Code	Type	Description
200	PortEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Write - /process-groups/{uuid}

GET

Gets all input ports

Request

consumes:

*/*

Name	Location	Type	Description
id	path	string	The process group id.

Response

produces:

application/json

Status Code	Type	Description
200	InputPortsEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Read - /process-groups/{uuid}

POST

Creates a label

Request

consumes:

application/json

Name	Location	Type	Description
id	path	string	The process group id.
	body	LabelEntity	The label configuration details.

Response

produces:

application/json

Status Code	Type	Description
200	LabelEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Write - /process-groups/{uuid}

GET

Gets all labels

Request

consumes:

*/*

Name	Location	Type	Description
id	path	string	The process group id.

Response

produces:

application/json

Status Code	Type	Description
200	LabelsEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Read - /process-groups/{uuid}

GET

Gets a list of local modifications to the Process Group since it was last synchronized with the Flow Registry

Request

consumes:

*/*

Name	Location	Type	Description
id	path	string	The process group id.

Response

produces:

application/json

Status Code	Type	Description
200	FlowComparisonEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Read - /process-groups/{uuid}

Read - /{component-type}/{uuid} - For all encapsulated components

POST

Creates an output port

Request

consumes:

application/json

Name	Location	Type	Description
id	path	string	The process group id.
	body	PortEntity	The output port configuration.

Response

produces:

application/json

Status Code	Type	Description
200	PortEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Write - /process-groups/{uuid}

GET

Gets all output ports

Request

consumes:

*/*

Name	Location	Type	Description
id	path	string	The process group id.

Response

produces:

application/json

Status Code	Type	Description
200	OutputPortsEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Read - /process-groups/{uuid}

POST

Creates a process group

Request

consumes:

application/json

Name	Location	Type	Description
id	path	string	The process group id.
	body	ProcessGroupEntity	The process group configuration details.
parameterContextHandlingStrategy	query	string	Handling Strategy controls whether to keep or replace Parameter Contexts

Response

produces:

application/json

Status Code	Type	Description
200	ProcessGroupEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Write - /process-groups/{uuid}

GET

Gets all process groups

Request

consumes:

*/*

Name	Location	Type	Description
id	path	string	The process group id.

Response

produces:

application/json

Status Code	Type	Description
200	ProcessGroupsEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Read - /process-groups/{uuid}

POST

Imports a specified process group

Request

consumes:

application/json

Name	Location	Type	Description
id	path	string	The process group id.

Response

produces:

application/json

Status Code	Type	Description
200	ProcessGroupEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Write - /process-groups/{uuid}

POST

Uploads a versioned flow definition and creates a process group

Request

consumes:

multipart/form-data

Name	Location	Type	Description
id	path	string	The process group id.
groupName	formData	string	The process group name.
positionX	formData	number	The process group X position.
positionY	formData	number	The process group Y position.
clientId	formData	string	The client id.
disconnectedNodeAcknowledged	formData	boolean	Acknowledges that this node is disconnected to allow for mutable requests to proceed.
file	formData	file	The binary content of the versioned flow definition file being uploaded.

Response

produces:

application/json

Status Code	Type	Description
200	ProcessGroupEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Write - /process-groups/{uuid}

POST

Creates a new processor

Request

consumes:

application/json

Name	Location	Type	Description
id	path	string	The process group id.
	body	ProcessorEntity	The processor configuration details.

Response

produces:

application/json

Status Code	Type	Description
200	ProcessorEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Write - /process-groups/{uuid}

Read - any referenced Controller Services - /controller-services/{uuid}

Write - if the Processor is restricted - /restricted-components

GET

Gets all processors

Request

consumes:

*/*

Name	Location	Type	Description
id	path	string	The process group id.
includeDescendantGroups	query	boolean	Whether or not to include processors from descendant process groups

Response

produces:

application/json

Status Code	Type	Description
200	ProcessorsEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Read - /process-groups/{uuid}

POST

Creates a new process group

Request

consumes:

application/json

Name	Location	Type	Description
id	path	string	The process group id.
	body	RemoteProcessGroupEntity	The remote process group configuration details.

Response

produces:

application/json

Status Code	Type	Description
200	RemoteProcessGroupEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Write - /process-groups/{uuid}

GET

Gets all remote process groups

Request

consumes:

*/*

Name	Location	Type	Description
id	path	string	The process group id.

Response

produces:

application/json

Status Code	Type	Description
200	RemoteProcessGroupsEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Read - /process-groups/{uuid}

POST

Initiate the Replace Request of a Process Group with the given ID

This will initiate the action of replacing a process group with the given process group. 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 ProcessGroupReplaceRequestEntity, and the process of replacing 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 /process-groups/replace-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /process-groups/replace-requests/{requestId}. Note: This endpoint is subject to change as NiFi and it's REST API evolve.

Request

consumes:

application/json

Name	Location	Type	Description
id	path	string	The process group id.
	body	ProcessGroupImportEntity	The process group replace request entity

Response

produces:

application/json

Status Code	Type	Description
200	ProcessGroupReplaceRequestEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Read - /process-groups/{uuid}

Write - /process-groups/{uuid}

Read - /{component-type}/{uuid} - For all encapsulated components

Write - /{component-type}/{uuid} - For all encapsulated components

Write - if the template contains any restricted components - /restricted-components

Read - /parameter-contexts/{uuid} - For any Parameter Context that is referenced by a Property that is changed, added, or removed

POST

Copies a snippet and discards it.

Request

consumes:

application/json

Name	Location	Type	Description
id	path	string	The process group id.
	body	CopySnippetRequestEntity	The copy snippet request.

Response

produces:

application/json

Status Code	Type	Description
200	FlowEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Write - /process-groups/{uuid}

Read - /{component-type}/{uuid} - For each component in the snippet and their descendant components

Write - if the snippet contains any restricted Processors - /restricted-components

POST

Instantiates a template

Request

consumes:

application/json

Name	Location	Type	Description
id	path	string	The process group id.
	body	InstantiateTemplateRequestEntity	The instantiate template request.

Response

produces:

application/json

Status Code	Type	Description
200	FlowEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Write - /process-groups/{uuid}

Read - /templates/{uuid}

Write - if the template contains any restricted components - /restricted-components

POST

Creates a template and discards the specified snippet.

Request

consumes:

application/json

Name	Location	Type	Description
id	path	string	The process group id.
	body	CreateTemplateRequestEntity	The create template request.

Response

produces:

application/json

Status Code	Type	Description
200	TemplateEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Write - /process-groups/{uuid}

Read - /{component-type}/{uuid} - For each component in the snippet and their descendant components

POST

Imports a template

Request

consumes:

application/xml

Name	Location	Type	Description
id	path	string	The process group id.

Response

produces:

application/xml

Status Code	Type	Description
200	TemplateEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Write - /process-groups/{uuid}

POST

Uploads a template

Request

consumes:

multipart/form-data

Name	Location	Type	Description
id	path	string	The process group id.
disconnectedNodeAcknowledged	formData	boolean	Acknowledges that this node is disconnected to allow for mutable requests to proceed.
template	formData	file	The binary content of the template file being uploaded.

Response

produces:

application/xml

Status Code	Type	Description
200	TemplateEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Write - /process-groups/{uuid}

GET

Gets a process group's variable registry

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

Request

consumes:

*/*

Name	Location	Type	Description
id	path	string	The process group id.
includeAncestorGroups	query	boolean	Whether or not to include ancestor groups

Response

produces:

application/json

Status Code	Type	Description
200	VariableRegistryEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Read - /process-groups/{uuid}

PUT

Updates the contents of a Process Group's variable Registry

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

Request

consumes:

application/json

Name	Location	Type	Description
id	path	string	The process group id.
	body	VariableRegistryEntity	The variable registry configuration details.

Response

produces:

application/json

Status Code	Type	Description
200	VariableRegistryEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Write - /process-groups/{uuid}

POST

Submits a request to update a process group's variable registry

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

Request

consumes:

application/json

Name	Location	Type	Description
id	path	string	The process group id.
	body	VariableRegistryEntity	The variable registry configuration details.

Response

produces:

application/json

Status Code	Type	Description
200	VariableRegistryUpdateRequestEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Write - /process-groups/{uuid}

POST

Submits a query to retrieve the run status details of all processors that are in the given list of Processor IDs

Request

consumes:

application/json

Name	Location	Type	Description
	body	RunStatusDetailsRequestEntity	The request for the processors that should be included in the results

Response

produces:

application/json

Status Code	Type	Description
200	ProcessorsRunStatusDetailsEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Read - /processors/{uuid} for each processor whose run status information is requested

GET

Gets a processor

Request

consumes:

*/*

Name	Location	Type	Description
id	path	string	The processor id.

Response

produces:

application/json

Status Code	Type	Description
200	ProcessorEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Read - /processors/{uuid}

PUT

Updates a processor

Request

consumes:

application/json

Name	Location	Type	Description
id	path	string	The processor id.
	body	ProcessorEntity	The processor configuration details.

Response

produces:

application/json

Status Code	Type	Description
200	ProcessorEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Write - /processors/{uuid}

Read - any referenced Controller Services if this request changes the reference - /controller-services/{uuid}

DELETE

Deletes a processor

Request

consumes:

*/*

Name	Location	Type	Description
version	query	string	The revision is used to verify the client is working with the latest version of the flow.
clientId	query	string	If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.
disconnectedNodeAcknowledged	query	boolean	Acknowledges that this node is disconnected to allow for mutable requests to proceed.
id	path	string	The processor id.

Response

produces:

application/json

Status Code	Type	Description
200	ProcessorEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Write - /processors/{uuid}

Write - Parent Process Group - /process-groups/{uuid}

Read - any referenced Controller Services - /controller-services/{uuid}

POST

Performs analysis of the component's configuration, providing information about which attributes are referenced.

Request

consumes:

application/json

Name	Location	Type	Description
id	path	string	The processor id.
	body	ConfigurationAnalysisEntity	The processor configuration analysis request.

Response

produces:

application/json

Status Code	Type	Description
200	ConfigurationAnalysisEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Read - /processors/{uuid}

POST

Performs verification of the Processor's configuration

This will initiate the process of verifying a given Processor configuration. This may be a long-running task. As a result, this endpoint will immediately return a ProcessorConfigVerificationRequestEntity, and the process of performing the verification will occur asynchronously in the background. The client may then periodically poll the status of the request by issuing a GET request to /processors/{processorId}/verification-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /processors/{processorId}/verification-requests/{requestId}.

Request

consumes:

application/json

Name	Location	Type	Description
id	path	string	The processor id.
	body	VerifyConfigRequestEntity	The processor configuration verification request.

Response

produces:

application/json

Status Code	Type	Description
200	VerifyConfigRequestEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Read - /processors/{uuid}

GET

Returns the Verification Request with the given ID

Returns the Verification Request with the given ID. Once an Verification Request has been created, 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.

Request

consumes:

*/*

Name	Location	Type	Description
id	path	string	The ID of the Processor
requestId	path	string	The ID of the Verification Request

Response

produces:

application/json

Status Code	Type	Description
200	VerifyConfigRequestEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Only the user that submitted the request can get it

DELETE

Deletes the Verification Request with the given ID

Deletes the Verification Request with the given ID. After a request is created, it is expected that the client will properly clean up the request by DELETE'ing it, once the Verification process has completed. If the request is deleted before the request completes, then the Verification request will finish the step that it is currently performing and then will cancel any subsequent steps.

Request

consumes:

*/*

Name	Location	Type	Description
id	path	string	The ID of the Processor
requestId	path	string	The ID of the Verification Request

Response

produces:

application/json

Status Code	Type	Description
200	VerifyConfigRequestEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Only the user that submitted the request can remove it

GET

Gets the descriptor for a processor property

Request

consumes:

*/*

Name	Location	Type	Description
clientId	query	string	If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.
id	path	string	The processor id.
propertyName	query	string	The property name.
sensitive	query	boolean	Property Descriptor requested sensitive status

Response

produces:

application/json

Status Code	Type	Description
200	PropertyDescriptorEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Read - /processors/{uuid}

GET

Gets diagnostics information about a processor

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

Request

consumes:

*/*

Name	Location	Type	Description
id	path	string	The processor id.

Response

produces:

application/json

Status Code	Type	Description
200	ProcessorEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Read - /processors/{uuid}

PUT

Updates run status of a processor

Request

consumes:

application/json

Name	Location	Type	Description
id	path	string	The processor id.
	body	ProcessorRunStatusEntity	The processor run status.

Response

produces:

application/json

Status Code	Type	Description
200	ProcessorEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Write - /processors/{uuid} or /operation/processors/{uuid}

GET

Gets the state for a processor

Request

consumes:

*/*

Name	Location	Type	Description
id	path	string	The processor id.

Response

produces:

application/json

Status Code	Type	Description
200	ComponentStateEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Write - /processors/{uuid}

POST

Clears the state for a processor

Request

consumes:

*/*

Name	Location	Type	Description
id	path	string	The processor id.

Response

produces:

application/json

Status Code	Type	Description
200	ComponentStateEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Write - /processors/{uuid}

DELETE

Terminates a processor, essentially "deleting" its threads and any active tasks

Request

consumes:

*/*

Name	Location	Type	Description
id	path	string	The processor id.

Response

produces:

application/json

Status Code	Type	Description
200	ProcessorEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Write - /processors/{uuid} or /operation/processors/{uuid}

POST

Submits a provenance query

Provenance queries may be long running so this endpoint submits a request. The response will include the current state of the query. If the request is not completed the URI in the response can be used at a later time to get the updated state of the query. Once the query has completed the provenance request should be deleted by the client who originally submitted it.

Request

consumes:

application/json

Name	Location	Type	Description
	body	ProvenanceEntity	The provenance query details.

Response

produces:

application/json

Status Code	Type	Description
200	ProvenanceEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Read - /provenance

Read - /data/{component-type}/{uuid}

POST

Replays content from a provenance event

Request

consumes:

application/json

Name	Location	Type	Description
	body	ReplayLastEventRequestEntity	The replay request.

Response

produces:

application/json

Status Code	Type	Description
200	ReplayLastEventResponseEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Read Component Provenance Data - /provenance-data/{component-type}/{uuid}

Read Component Data - /data/{component-type}/{uuid}

Write Component Data - /data/{component-type}/{uuid}

POST

Replays content from a provenance event

Request

consumes:

application/json

Name	Location	Type	Description
	body	SubmitReplayRequestEntity	The replay request.

Response

produces:

application/json

Status Code	Type	Description
200	ProvenanceEventEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Read Component Provenance Data - /provenance-data/{component-type}/{uuid}

Read Component Data - /data/{component-type}/{uuid}

Write Component Data - /data/{component-type}/{uuid}

GET

Gets a provenance event

Request

consumes:

*/*

Name	Location	Type	Description
clusterNodeId	query	string	The id of the node where this event exists if clustered.
id	path	string	The provenance event id.

Response

produces:

application/json

Status Code	Type	Description
200	ProvenanceEventEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Read Component Provenance Data - /provenance-data/{component-type}/{uuid}

GET

Gets the input content for a provenance event

Request

consumes:

*/*

Name	Location	Type	Description
clusterNodeId	query	string	The id of the node where the content exists if clustered.
id	path	string	The provenance event id.

Response

produces:

*/*

Status Code	Type	Description
200	StreamingOutput	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Read Component Provenance Data - /provenance-data/{component-type}/{uuid}

Read Component Data - /data/{component-type}/{uuid}

GET

Gets the output content for a provenance event

Request

consumes:

*/*

Name	Location	Type	Description
clusterNodeId	query	string	The id of the node where the content exists if clustered.
id	path	string	The provenance event id.

Response

produces:

*/*

Status Code	Type	Description
200	StreamingOutput	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Read Component Provenance Data - /provenance-data/{component-type}/{uuid}

Read Component Data - /data/{component-type}/{uuid}

POST

Submits a lineage query

Lineage queries may be long running so this endpoint submits a request. The response will include the current state of the query. If the request is not completed the URI in the response can be used at a later time to get the updated state of the query. Once the query has completed the lineage request should be deleted by the client who originally submitted it.

Request

consumes:

application/json

Name	Location	Type	Description
	body	LineageEntity	The lineage query details.

Response

produces:

application/json

Status Code	Type	Description
200	LineageEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Read - /provenance

Read - /data/{component-type}/{uuid}

GET

Gets a lineage query

Request

consumes:

*/*

Name	Location	Type	Description
clusterNodeId	query	string	The id of the node where this query exists if clustered.
id	path	string	The id of the lineage query.

Response

produces:

application/json

Status Code	Type	Description
200	LineageEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Read - /provenance

Read - /data/{component-type}/{uuid}

DELETE

Deletes a lineage query

Request

consumes:

*/*

Name	Location	Type	Description
clusterNodeId	query	string	The id of the node where this query exists if clustered.
id	path	string	The id of the lineage query.

Response

produces:

application/json

Status Code	Type	Description
200	LineageEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Read - /provenance

GET

Gets the searchable attributes for provenance events

Request

consumes:

*/*

Response

produces:

application/json

Status Code	Type	Description
200	ProvenanceOptionsEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Read - /provenance

GET

Gets a provenance query

Request

consumes:

*/*

Name	Location	Type	Description
clusterNodeId	query	string	The id of the node where this query exists if clustered.
summarize	query	boolean	Whether or not incremental results are returned. If false, provenance events are only returned once the query completes. This property is true by default.
incrementalResults	query	boolean	Whether or not to summarize provenance events returned. This property is false by default.
id	path	string	The id of the provenance query.

Response

produces:

application/json

Status Code	Type	Description
200	ProvenanceEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Read - /provenance

Read - /data/{component-type}/{uuid}

DELETE

Deletes a provenance query

Request

consumes:

*/*

Name	Location	Type	Description
clusterNodeId	query	string	The id of the node where this query exists if clustered.
id	path	string	The id of the provenance query.

Response

produces:

application/json

Status Code	Type	Description
200	ProvenanceEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Read - /provenance

PUT

Updates run status of all remote process groups in a process group (recursively)

Request

consumes:

application/json

Name	Location	Type	Description
id	path	string	The process group id.
	body	RemotePortRunStatusEntity	The remote process groups run status.

Response

produces:

application/json

Status Code	Type	Description
200	RemoteProcessGroupEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Write - /remote-process-groups/{uuid} or /operation/remote-process-groups/{uuid}

GET

Gets a remote process group

Request

consumes:

*/*

Name	Location	Type	Description
id	path	string	The remote process group id.

Response

produces:

application/json

Status Code	Type	Description
200	RemoteProcessGroupEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Read - /remote-process-groups/{uuid}

PUT

Updates a remote process group

Request

consumes:

application/json

Name	Location	Type	Description
id	path	string	The remote process group id.
	body	RemoteProcessGroupEntity	The remote process group.

Response

produces:

application/json

Status Code	Type	Description
200	RemoteProcessGroupEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Write - /remote-process-groups/{uuid}

DELETE

Deletes a remote process group

Request

consumes:

*/*

Name	Location	Type	Description
version	query	string	The revision is used to verify the client is working with the latest version of the flow.
clientId	query	string	If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.
disconnectedNodeAcknowledged	query	boolean	Acknowledges that this node is disconnected to allow for mutable requests to proceed.
id	path	string	The remote process group id.

Response

produces:

application/json

Status Code	Type	Description
200	RemoteProcessGroupEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Write - /remote-process-groups/{uuid}

Write - Parent Process Group - /process-groups/{uuid}

PUT

Updates a remote port

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

Request

consumes:

application/json

Name	Location	Type	Description
id	path	string	The remote process group id.
port-id	path	string	The remote process group port id.
	body	RemoteProcessGroupPortEntity	The remote process group port.

Response

produces:

application/json

Status Code	Type	Description
200	RemoteProcessGroupPortEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Write - /remote-process-groups/{uuid}

PUT

Updates run status of a remote port

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

Request

consumes:

application/json

Name	Location	Type	Description
id	path	string	The remote process group id.
port-id	path	string	The remote process group port id.
	body	RemotePortRunStatusEntity	The remote process group port.

Response

produces:

application/json

Status Code	Type	Description
200	RemoteProcessGroupPortEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Write - /remote-process-groups/{uuid} or /operation/remote-process-groups/{uuid}

PUT

Updates a remote port

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

Request

consumes:

application/json

Name	Location	Type	Description
id	path	string	The remote process group id.
port-id	path	string	The remote process group port id.
	body	RemoteProcessGroupPortEntity	The remote process group port.

Response

produces:

application/json

Status Code	Type	Description
200	RemoteProcessGroupPortEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Write - /remote-process-groups/{uuid}

PUT

Updates run status of a remote port

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

Request

consumes:

application/json

Name	Location	Type	Description
id	path	string	The remote process group id.
port-id	path	string	The remote process group port id.
	body	RemotePortRunStatusEntity	The remote process group port.

Response

produces:

application/json

Status Code	Type	Description
200	RemoteProcessGroupPortEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Write - /remote-process-groups/{uuid} or /operation/remote-process-groups/{uuid}

PUT

Updates run status of a remote process group

Request

consumes:

application/json

Name	Location	Type	Description
id	path	string	The remote process group id.
	body	RemotePortRunStatusEntity	The remote process group run status.

Response

produces:

application/json

Status Code	Type	Description
200	RemoteProcessGroupEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Write - /remote-process-groups/{uuid} or /operation/remote-process-groups/{uuid}

GET

Gets the state for a RemoteProcessGroup

Request

consumes:

*/*

Name	Location	Type	Description
id	path	string	The processor id.

Response

produces:

application/json

Status Code	Type	Description
200	ComponentStateEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Write - /remote-process-groups/{uuid}

GET

Gets a reporting task

Request

consumes:

*/*

Name	Location	Type	Description
id	path	string	The reporting task id.

Response

produces:

application/json

Status Code	Type	Description
200	ReportingTaskEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Read - /reporting-tasks/{uuid}

PUT

Updates a reporting task

Request

consumes:

application/json

Name	Location	Type	Description
id	path	string	The reporting task id.
	body	ReportingTaskEntity	The reporting task configuration details.

Response

produces:

application/json

Status Code	Type	Description
200	ReportingTaskEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Write - /reporting-tasks/{uuid}

Read - any referenced Controller Services if this request changes the reference - /controller-services/{uuid}

DELETE

Deletes a reporting task

Request

consumes:

*/*

Name	Location	Type	Description
version	query	string	The revision is used to verify the client is working with the latest version of the flow.
clientId	query	string	If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.
disconnectedNodeAcknowledged	query	boolean	Acknowledges that this node is disconnected to allow for mutable requests to proceed.
id	path	string	The reporting task id.

Response

produces:

application/json

Status Code	Type	Description
200	ReportingTaskEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Write - /reporting-tasks/{uuid}

Write - /controller

Read - any referenced Controller Services - /controller-services/{uuid}

POST

Performs analysis of the component's configuration, providing information about which attributes are referenced.

Request

consumes:

application/json

Name	Location	Type	Description
id	path	string	The reporting task id.
	body	ConfigurationAnalysisEntity	The configuration analysis request.

Response

produces:

application/json

Status Code	Type	Description
200	ConfigurationAnalysisEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Read - /reporting-tasks/{uuid}

POST

Performs verification of the Reporting Task's configuration

This will initiate the process of verifying a given Reporting Task configuration. This may be a long-running task. As a result, this endpoint will immediately return a ReportingTaskConfigVerificationRequestEntity, and the process of performing the verification will occur asynchronously in the background. The client may then periodically poll the status of the request by issuing a GET request to /reporting-tasks/{taskId}/verification-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /reporting-tasks/{serviceId}/verification-requests/{requestId}.

Request

consumes:

application/json

Name	Location	Type	Description
id	path	string	The reporting task id.
	body	VerifyConfigRequestEntity	The reporting task configuration verification request.

Response

produces:

application/json

Status Code	Type	Description
200	VerifyConfigRequestEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Read - /reporting-tasks/{uuid}

GET

Returns the Verification Request with the given ID

Returns the Verification Request with the given ID. Once an Verification Request has been created, 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.

Request

consumes:

*/*

Name	Location	Type	Description
id	path	string	The ID of the Reporting Task
requestId	path	string	The ID of the Verification Request

Response

produces:

application/json

Status Code	Type	Description
200	VerifyConfigRequestEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Only the user that submitted the request can get it

DELETE

Deletes the Verification Request with the given ID

Deletes the Verification Request with the given ID. After a request is created, it is expected that the client will properly clean up the request by DELETE'ing it, once the Verification process has completed. If the request is deleted before the request completes, then the Verification request will finish the step that it is currently performing and then will cancel any subsequent steps.

Request

consumes:

*/*

Name	Location	Type	Description
id	path	string	The ID of the Reporting Task
requestId	path	string	The ID of the Verification Request

Response

produces:

application/json

Status Code	Type	Description
200	VerifyConfigRequestEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Only the user that submitted the request can remove it

GET

Gets a reporting task property descriptor

Request

consumes:

*/*

Name	Location	Type	Description
id	path	string	The reporting task id.
propertyName	query	string	The property name.
sensitive	query	boolean	Property Descriptor requested sensitive status

Response

produces:

application/json

Status Code	Type	Description
200	PropertyDescriptorEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Read - /reporting-tasks/{uuid}

PUT

Updates run status of a reporting task

Request

consumes:

application/json

Name	Location	Type	Description
id	path	string	The reporting task id.
	body	ReportingTaskRunStatusEntity	The reporting task run status.

Response

produces:

application/json

Status Code	Type	Description
200	ReportingTaskEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Write - /reporting-tasks/{uuid} or or /operation/reporting-tasks/{uuid}

GET

Gets the state for a reporting task

Request

consumes:

*/*

Name	Location	Type	Description
id	path	string	The reporting task id.

Response

produces:

application/json

Status Code	Type	Description
200	ComponentStateEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Write - /reporting-tasks/{uuid}

POST

Clears the state for a reporting task

Request

consumes:

*/*

Name	Location	Type	Description
id	path	string	The reporting task id.

Response

produces:

application/json

Status Code	Type	Description
200	ComponentStateEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Write - /reporting-tasks/{uuid}

GET

Gets the available resources that support access/authorization policies

Request

consumes:

*/*

Response

produces:

application/json

Status Code	Type	Description
200	ResourcesEntity	successful operation
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.

Authorization

Read - /resources

GET

Returns the details about this NiFi necessary to communicate via site to site

Request

consumes:

*/*

Response

produces:

application/json

Status Code	Type	Description
200	ControllerEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Read - /site-to-site

GET

Returns the available Peers and its status of this NiFi

Request

consumes:

*/*

Response

produces:

application/json, application/xml

Status Code	Type	Description
200	PeersEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Read - /site-to-site

POST

Creates a snippet. The snippet will be automatically discarded if not used in a subsequent request after 1 minute.

Request

consumes:

application/json

Name	Location	Type	Description
	body	SnippetEntity	The snippet configuration details.

Response

produces:

application/json

Status Code	Type	Description
200	SnippetEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Read or Write - /{component-type}/{uuid} - For every component (all Read or all Write) in the Snippet and their descendant components

PUT

Move's the components in this Snippet into a new Process Group and discards the snippet

Request

consumes:

application/json

Name	Location	Type	Description
id	path	string	The snippet id.
	body	SnippetEntity	The snippet configuration details.

Response

produces:

application/json

Status Code	Type	Description
200	SnippetEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Write Process Group - /process-groups/{uuid}

Write - /{component-type}/{uuid} - For each component in the Snippet and their descendant components

DELETE

Deletes the components in a snippet and discards the snippet

Request

consumes:

*/*

Name	Location	Type	Description
disconnectedNodeAcknowledged	query	boolean	Acknowledges that this node is disconnected to allow for mutable requests to proceed.
id	path	string	The snippet id.

Response

produces:

application/json

Status Code	Type	Description
200	SnippetEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Write - /{component-type}/{uuid} - For each component in the Snippet and their descendant components

Write - Parent Process Group - /process-groups/{uuid}

GET

Gets the diagnostics for the system NiFi is running on

Request

consumes:

*/*

Name	Location	Type	Description
nodewise	query	boolean	Whether or not to include the breakdown per node. Optional, defaults to false
clusterNodeId	query	string	The id of the node where to get the status.

Response

produces:

application/json

Status Code	Type	Description
200	SystemDiagnosticsEntity	successful operation
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.

Authorization

Read - /system

GET

Retrieve available JMX metrics

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

Request

consumes:

application/json

Name	Location	Type	Description
beanNameFilter	query	string	Regular Expression Pattern to be applied against the ObjectName

Response

produces:

application/json

Status Code	Type	Description
200	JmxMetricsResultsEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Read - /system

DELETE

Deletes a template

Request

consumes:

*/*

Name	Location	Type	Description
disconnectedNodeAcknowledged	query	boolean	Acknowledges that this node is disconnected to allow for mutable requests to proceed.
id	path	string	The template id.

Response

produces:

application/json

Status Code	Type	Description
200	TemplateEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Authorization

Write - /templates/{uuid}

Write - Parent Process Group - /process-groups/{uuid}

GET

Exports a template

Request

consumes:

*/*

Name	Location	Type	Description
id	path	string	The template id.

Response

produces:

application/xml

Status Code	Type	Description
200		successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string