| 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. |
| 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. |
| 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. |
| Status Code | Type | Description |
|---|---|---|
| 200 | AccessConfigurationEntity | successful operation |
| Name | Location | Type | Description |
|---|---|---|---|
| username | formData | string | |
| password | formData | string |
| 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. |
| 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. |
| 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. |
| 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 |
| Status Code | Type | Description |
|---|---|---|
| 200 | ClusterConnectionStatusEntity | 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. |
| 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. |
| Status Code | Type | Description |
|---|---|---|
| 200 | ClusterStatusHistoryEntity | 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. |
| 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 input port id. |
| Status Code | Type | Description |
|---|---|---|
| 200 | ClusterPortStatusEntity | 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. |
| 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 node id. |
| 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. |
| 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 or primary flag. |
| 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. |
| 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 node id. |
| 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. |
| 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 node id. |
| 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. |
| 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 node id. |
| Status Code | Type | Description |
|---|---|---|
| 200 | SystemDiagnosticsEntity | 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. |
| 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 output port id. |
| Status Code | Type | Description |
|---|---|---|
| 200 | ClusterPortStatusEntity | 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. |
| 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 process group id. |
| Status Code | Type | Description |
|---|---|---|
| 200 | ClusterProcessGroupStatusEntity | 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. |
| 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 process group id. |
| Status Code | Type | Description |
|---|---|---|
| 200 | ClusterStatusHistoryEntity | 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. |
| 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. |
| 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. |
| Name | Location | Type | Description |
|---|---|---|---|
| id | path | string | The processor id. |
| body | ProcessorEntity | The processor configuration details. The only configuration that will be honored at this endpoint is the processor annontation data. |
| 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. |
| 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 |
| Status Code | Type | Description |
|---|---|---|
| 200 | ClusterProcessorStatusEntity | 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. |
| 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 |
| Status Code | Type | Description |
|---|---|---|
| 200 | ClusterStatusHistoryEntity | 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. |
| 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 remote process group id. |
| Status Code | Type | Description |
|---|---|---|
| 200 | ClusterRemoteProcessGroupStatusEntity | 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. |
| 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 remote process group id. |
| Status Code | Type | Description |
|---|---|---|
| 200 | ClusterStatusHistoryEntity | 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. |
| Name | Location | Type | Description |
|---|---|---|---|
| q | query | string | Node address to search for. |
| 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. |
| 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. |
| Status Code | Type | Description |
|---|---|---|
| 200 | ClusterStatusEntity | 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. |
| 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. |
| 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. |
| 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. |
| 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. |
| Name | Location | Type | Description |
|---|---|---|---|
| version | formData | string | The revision is used to verify the client is working with the latest version of the flow. |
| clientId | formData | string | If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response. |
| 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. |
| 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. |
| Status Code | Type | Description |
|---|---|---|
| 200 | AuthorityEntity | 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. |
| 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. |
| 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. |
| 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. |
| 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. |
| 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. |
| 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. |
| 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. |
| Name | Location | Type | Description |
|---|---|---|---|
| body | ControllerConfigurationEntity | The controller configuration. |
| 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. |
| 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. |
| serviceType | query | string | If specified, will only return controller services of this type. |
| 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. |
| Name | Location | Type | Description |
|---|---|---|---|
| availability | path | string | Whether the controller service is available on the NCM or nodes. If the NiFi is standalone the availability should be NODE. |
| body | ControllerServiceEntity | The controller service configuration details. |
| 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. |
| 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. |
| availability | path | string | Whether the controller service is available on the NCM or nodes. If the NiFi is standalone the availability should be NODE. |
| 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. |
| 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. |
| availability | path | string | Whether the controller service is available on the NCM or nodes. If the NiFi is standalone the availability should be NODE. |
| id | path | string | The controller service id. |
| 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. |
| Name | Location | Type | Description |
|---|---|---|---|
| availability | path | string | Whether the controller service is available on the NCM or nodes. If the NiFi is standalone the availability should be NODE. |
| id | path | string | The controller service id. |
| body | ControllerServiceEntity | The controller service configuration details. |
| 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. |
| 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. |
| availability | path | string | Whether the controller service is available on the NCM or nodes. If the NiFi is standalone the availability should be NODE. |
| id | path | string | The controller service id. |
| 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. |
| 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. |
| availability | path | string | Whether the controller service is available on the NCM or nodes. If the NiFi is standalone the availability should be NODE. |
| id | path | string | The controller service id. |
| propertyName | query | string | The property name to return the descriptor for. |
| 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. |
| 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. |
| availability | path | string | Whether the controller service is available on the NCM or nodes. If the NiFi is standalone the availability should be NODE. |
| id | path | string | The controller service id. |
| 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. |
| Name | Location | Type | Description |
|---|---|---|---|
| version | formData | string | The revision is used to verify the client is working with the latest version of the flow. |
| clientId | formData | string | If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response. |
| availability | path | string | Whether the controller service is available on the NCM or nodes. If the NiFi is standalone the availability should be NODE. |
| id | path | string | The controller service id. |
| state | formData | string | The new state of the references for the controller service. |
| 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. |
| 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. |
| Status Code | Type | Description |
|---|---|---|
| 200 | Entity | 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. |
| Name | Location | Type | Description |
|---|---|---|---|
| clientId | formData | 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 |
| 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. |
| 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. |
| 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. |
| userName | query | string | Include actions performed by this user. |
| sourceId | query | string | Include actions on this component. |
| 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. |
| 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. |
| endDate | query | string | Purge actions before this date/time. |
| 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. |
| 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. |
| controllerServiceId | path | string | The controller service id. |
| 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. |
| 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. |
| processorId | path | string | The processor id. |
| 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. |
| 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. |
| reportingTaskId | path | string | The reporting task id. |
| 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. |
| 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 action id. |
| 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. |
| 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. |
| Status Code | Type | Description |
|---|---|---|
| 200 | IdentityEntity | successful operation |
| 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. |
| 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. |
| 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 |
| recursive | query | boolean | Whether the response should contain all encapsulated components or just the immediate children. |
| verbose | query | boolean | Whether to include any encapulated components or just details about the process group. |
| process-group-id | path | string | The id of the process group that is the parent of the requested resource(s). If the desired process group is the root group an alias 'root' may be used as the process-group-id. |
| 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. |
| Name | Location | Type | Description |
|---|---|---|---|
| body | ProcessGroupEntity | The process group to update. The only action that is supported at this endpoint is to set the running flag in order to start or stop all descendent schedulable components. This defines the schema of the expected input. | |
| process-group-id | path | string | The id of the process group that is the parent of the requested resource(s). If the desired process group is the root group an alias 'root' may be used as the process-group-id. |
| 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. |
| Name | Location | Type | Description |
|---|---|---|---|
| body | ConnectionEntity | The connection configuration details. | |
| process-group-id | path | string | The id of the process group that is the parent of the requested resource(s). If the desired process group is the root group an alias 'root' may be used as the process-group-id. |
| 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. |
| 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. |
| process-group-id | path | string | The id of the process group that is the parent of the requested resource(s). If the desired process group is the root group an alias 'root' may be used as the process-group-id. |
| 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. |
| 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. |
| connection-id | path | string | The connection id. |
| process-group-id | path | string | The id of the process group that is the parent of the requested resource(s). If the desired process group is the root group an alias 'root' may be used as the process-group-id. |
| 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. |
| 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. |
| connection-id | path | string | The connection id. |
| drop-request-id | path | string | The drop request id. |
| process-group-id | path | string | The id of the process group that is the parent of the requested resource(s). If the desired process group is the root group an alias 'root' may be used as the process-group-id. |
| 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. |
| 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. |
| connection-id | path | string | The connection id. |
| drop-request-id | path | string | The drop request id. |
| process-group-id | path | string | The id of the process group that is the parent of the requested resource(s). If the desired process group is the root group an alias 'root' may be used as the process-group-id. |
| 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. |
| 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. |
| process-group-id | path | string | The id of the process group that is the parent of the requested resource(s). If the desired process group is the root group an alias 'root' may be used as the process-group-id. |
| 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. |
| Name | Location | Type | Description |
|---|---|---|---|
| id | path | string | The connection id. |
| body | ConnectionEntity | The connection configuration details. | |
| process-group-id | path | string | The id of the process group that is the parent of the requested resource(s). If the desired process group is the root group an alias 'root' may be used as the process-group-id. |
| 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. |
| 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. |
| id | path | string | The connection id. |
| process-group-id | path | string | The id of the process group that is the parent of the requested resource(s). If the desired process group is the root group an alias 'root' may be used as the process-group-id. |
| 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. |
| 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. |
| process-group-id | path | string | The id of the process group that is the parent of the requested resource(s). If the desired process group is the root group an alias 'root' may be used as the process-group-id. |
| 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. |
| Name | Location | Type | Description |
|---|---|---|---|
| body | FunnelEntity | The funnel configuration details. | |
| process-group-id | path | string | The id of the process group that is the parent of the requested resource(s). If the desired process group is the root group an alias 'root' may be used as the process-group-id. |
| 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. |
| 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. |
| process-group-id | path | string | The id of the process group that is the parent of the requested resource(s). If the desired process group is the root group an alias 'root' may be used as the process-group-id. |
| 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. |
| 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 funnel id. |
| process-group-id | path | string | The id of the process group that is the parent of the requested resource(s). If the desired process group is the root group an alias 'root' may be used as the process-group-id. |
| 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. |
| Name | Location | Type | Description |
|---|---|---|---|
| id | path | string | The funnel id. |
| body | FunnelEntity | The funnel configuration details. | |
| process-group-id | path | string | The id of the process group that is the parent of the requested resource(s). If the desired process group is the root group an alias 'root' may be used as the process-group-id. |
| 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. |
| 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. |
| id | path | string | The funnel id. |
| process-group-id | path | string | The id of the process group that is the parent of the requested resource(s). If the desired process group is the root group an alias 'root' may be used as the process-group-id. |
| 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. |
| Name | Location | Type | Description |
|---|---|---|---|
| body | InputPortEntity | The input port configuration details. | |
| process-group-id | path | string | The id of the process group that is the parent of the requested resource(s). If the desired process group is the root group an alias 'root' may be used as the process-group-id. |
| Status Code | Type | Description |
|---|---|---|
| 200 | InputPortEntity | 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. |
| 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. |
| process-group-id | path | string | The id of the process group that is the parent of the requested resource(s). If the desired process group is the root group an alias 'root' may be used as the process-group-id. |
| 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. |
| 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 input port id. |
| process-group-id | path | string | The id of the process group that is the parent of the requested resource(s). If the desired process group is the root group an alias 'root' may be used as the process-group-id. |
| Status Code | Type | Description |
|---|---|---|
| 200 | InputPortEntity | 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. |
| Name | Location | Type | Description |
|---|---|---|---|
| id | path | string | The input port id. |
| body | InputPortEntity | The input port configuration details. | |
| process-group-id | path | string | The id of the process group that is the parent of the requested resource(s). If the desired process group is the root group an alias 'root' may be used as the process-group-id. |
| Status Code | Type | Description |
|---|---|---|
| 200 | InputPortEntity | 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. |
| 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. |
| id | path | string | The input port id. |
| process-group-id | path | string | The id of the process group that is the parent of the requested resource(s). If the desired process group is the root group an alias 'root' may be used as the process-group-id. |
| Status Code | Type | Description |
|---|---|---|
| 200 | InputPortEntity | 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. |
| Name | Location | Type | Description |
|---|---|---|---|
| body | LabelEntity | The label configuration details. | |
| process-group-id | path | string | The id of the process group that is the parent of the requested resource(s). If the desired process group is the root group an alias 'root' may be used as the process-group-id. |
| 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. |
| 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. |
| process-group-id | path | string | The id of the process group that is the parent of the requested resource(s). If the desired process group is the root group an alias 'root' may be used as the process-group-id. |
| 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. |
| 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 label id. |
| process-group-id | path | string | The id of the process group that is the parent of the requested resource(s). If the desired process group is the root group an alias 'root' may be used as the process-group-id. |
| 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. |
| Name | Location | Type | Description |
|---|---|---|---|
| id | path | string | The label id. |
| body | LabelEntity | The label configuraiton details. | |
| process-group-id | path | string | The id of the process group that is the parent of the requested resource(s). If the desired process group is the root group an alias 'root' may be used as the process-group-id. |
| 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. |
| 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. |
| id | path | string | The label id. |
| process-group-id | path | string | The id of the process group that is the parent of the requested resource(s). If the desired process group is the root group an alias 'root' may be used as the process-group-id. |
| 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. |
| Name | Location | Type | Description |
|---|---|---|---|
| body | OutputPortEntity | The output port configuration. | |
| process-group-id | path | string | The id of the process group that is the parent of the requested resource(s). If the desired process group is the root group an alias 'root' may be used as the process-group-id. |
| Status Code | Type | Description |
|---|---|---|
| 200 | OutputPortEntity | 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. |
| 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. |
| process-group-id | path | string | The id of the process group that is the parent of the requested resource(s). If the desired process group is the root group an alias 'root' may be used as the process-group-id. |
| 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. |
| 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 output port id. |
| process-group-id | path | string | The id of the process group that is the parent of the requested resource(s). If the desired process group is the root group an alias 'root' may be used as the process-group-id. |
| Status Code | Type | Description |
|---|---|---|
| 200 | OutputPortEntity | 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. |
| Name | Location | Type | Description |
|---|---|---|---|
| id | path | string | The output port id. |
| body | OutputPortEntity | The output port configuration details. | |
| process-group-id | path | string | The id of the process group that is the parent of the requested resource(s). If the desired process group is the root group an alias 'root' may be used as the process-group-id. |
| Status Code | Type | Description |
|---|---|---|
| 200 | OutputPortEntity | 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. |
| 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. |
| id | path | string | The output port id. |
| process-group-id | path | string | The id of the process group that is the parent of the requested resource(s). If the desired process group is the root group an alias 'root' may be used as the process-group-id. |
| Status Code | Type | Description |
|---|---|---|
| 200 | OutputPortEntity | 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. |
| Name | Location | Type | Description |
|---|---|---|---|
| body | ProcessGroupEntity | The process group configuration details. | |
| process-group-id | path | string | The id of the process group that is the parent of the requested resource(s). If the desired process group is the root group an alias 'root' may be used as the process-group-id. |
| 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. |
| 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. |
| verbose | query | boolean | Whether to include any encapulated components or just details about the process group. |
| process-group-id | path | string | The id of the process group that is the parent of the requested resource(s). If the desired process group is the root group an alias 'root' may be used as the process-group-id. |
| 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. |
| 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 process group id. |
| recursive | query | boolean | Whether the response should contain all encapsulated components or just the immediate children. |
| verbose | query | boolean | Whether to include any encapulated components or just details about the process group. |
| process-group-id | path | string | The id of the process group that is the parent of the requested resource(s). If the desired process group is the root group an alias 'root' may be used as the process-group-id. |
| 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. |
| Name | Location | Type | Description |
|---|---|---|---|
| id | path | string | The process group id. |
| body | ProcessGroupEntity | The process group configuration details. | |
| process-group-id | path | string | The id of the process group that is the parent of the requested resource(s). If the desired process group is the root group an alias 'root' may be used as the process-group-id. |
| 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. |
| 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. |
| id | path | string | The process group id. |
| process-group-id | path | string | The id of the process group that is the parent of the requested resource(s). If the desired process group is the root group an alias 'root' may be used as the process-group-id. |
| 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. |
| Name | Location | Type | Description |
|---|---|---|---|
| body | ProcessorEntity | The processor configuration details. | |
| process-group-id | path | string | The id of the process group that is the parent of the requested resource(s). If the desired process group is the root group an alias 'root' may be used as the process-group-id. |
| 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. |
| Name | Location | Type | Description |
|---|---|---|---|
| clientId | query | string | |
| process-group-id | path | string | The id of the process group that is the parent of the requested resource(s). If the desired process group is the root group an alias 'root' may be used as the process-group-id. |
| 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. |
| 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. |
| process-group-id | path | string | The id of the process group that is the parent of the requested resource(s). If the desired process group is the root group an alias 'root' may be used as the process-group-id. |
| 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. |
| Name | Location | Type | Description |
|---|---|---|---|
| id | path | string | The processor id. |
| body | ProcessorEntity | The processor configuration details. | |
| process-group-id | path | string | The id of the process group that is the parent of the requested resource(s). If the desired process group is the root group an alias 'root' may be used as the process-group-id. |
| 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. |
| 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. |
| id | path | string | The processor id. |
| process-group-id | path | string | The id of the process group that is the parent of the requested resource(s). If the desired process group is the root group an alias 'root' may be used as the process-group-id. |
| 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. |
| 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. |
| process-group-id | path | string | The id of the process group that is the parent of the requested resource(s). If the desired process group is the root group an alias 'root' may be used as the process-group-id. |
| 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. |
| 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. |
| process-group-id | path | string | The id of the process group that is the parent of the requested resource(s). If the desired process group is the root group an alias 'root' may be used as the process-group-id. |
| 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. |
| Name | Location | Type | Description |
|---|---|---|---|
| body | RemoteProcessGroupEntity | The remote process group configuration details. | |
| process-group-id | path | string | The id of the process group that is the parent of the requested resource(s). If the desired process group is the root group an alias 'root' may be used as the process-group-id. |
| 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. |
| 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. |
| verbose | query | boolean | Whether to include any encapulated ports or just details about the remote process group. |
| process-group-id | path | string | The id of the process group that is the parent of the requested resource(s). If the desired process group is the root group an alias 'root' may be used as the process-group-id. |
| 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. |
| 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. |
| verbose | query | boolean | Whether to include any encapulated ports or just details about the remote process group. |
| id | path | string | The remote process group id. |
| process-group-id | path | string | The id of the process group that is the parent of the requested resource(s). If the desired process group is the root group an alias 'root' may be used as the process-group-id. |
| 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. |
| Name | Location | Type | Description |
|---|---|---|---|
| id | path | string | |
| process-group-id | path | string | The id of the process group that is the parent of the requested resource(s). If the desired process group is the root group an alias 'root' may be used as the process-group-id. |
| 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. |
| 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. |
| id | path | string | The remote process group id. |
| process-group-id | path | string | The id of the process group that is the parent of the requested resource(s). If the desired process group is the root group an alias 'root' may be used as the process-group-id. |
| 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. |
| Name | Location | Type | Description |
|---|---|---|---|
| id | path | string | |
| port-id | path | string | |
| process-group-id | path | string | The id of the process group that is the parent of the requested resource(s). If the desired process group is the root group an alias 'root' may be used as the process-group-id. |
| 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. |
| Name | Location | Type | Description |
|---|---|---|---|
| id | path | string | |
| port-id | path | string | |
| process-group-id | path | string | The id of the process group that is the parent of the requested resource(s). If the desired process group is the root group an alias 'root' may be used as the process-group-id. |
| 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. |
| 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 remote process group id. |
| process-group-id | path | string | The id of the process group that is the parent of the requested resource(s). If the desired process group is the root group an alias 'root' may be used as the process-group-id. |
| 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. |
| Name | Location | Type | Description |
|---|---|---|---|
| version | formData | string | The revision is used to verify the client is working with the latest version of the flow. |
| clientId | formData | string | If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response. |
| snippetId | formData | string | The snippet id. |
| originX | formData | string | The x coordinate of the origin of the bounding box where the new components will be placed. |
| originY | formData | string | The y coordinate of the origin of the bounding box where the new components will be placed. |
| process-group-id | path | string | The id of the process group that is the parent of the requested resource(s). If the desired process group is the root group an alias 'root' may be used as the process-group-id. |
| Status Code | Type | Description |
|---|---|---|
| 200 | FlowSnippetEntity | 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. |
| Name | Location | Type | Description |
|---|---|---|---|
| clientId | query | string | |
| recursive | query | boolean | |
| process-group-id | path | string | The id of the process group that is the parent of the requested resource(s). If the desired process group is the root group an alias 'root' may be used as the process-group-id. |
| 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. |
| Name | Location | Type | Description |
|---|---|---|---|
| clientId | query | string | |
| process-group-id | path | string | The id of the process group that is the parent of the requested resource(s). If the desired process group is the root group an alias 'root' may be used as the process-group-id. |
| 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. |
| Name | Location | Type | Description |
|---|---|---|---|
| version | formData | string | The revision is used to verify the client is working with the latest version of the flow. |
| clientId | formData | string | If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response. |
| templateId | formData | string | The id of the template |
| originX | formData | string | The x coordinate of the origin of the bounding box where the new components will be placed. |
| originY | formData | string | The y coordinate of the origin of the bounding box where the new components will be placed. |
| process-group-id | path | string | The id of the process group that is the parent of the requested resource(s). If the desired process group is the root group an alias 'root' may be used as the process-group-id. |
| Status Code | Type | Description |
|---|---|---|
| 200 | FlowSnippetEntity | 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. |
| 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. |
| 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. |
| Name | Location | Type | Description |
|---|---|---|---|
| body | ProvenanceEntity | The provenance query details. |
| 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. |
| 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. |
| clusterNodeId | query | string | The id of the node where this event exists if clustered. |
| id | path | string | The provenence event id. |
| 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. |
| 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. |
| clusterNodeId | query | string | The id of the node where the content exists if clustered. |
| id | path | string | The provenance event id. |
| Status Code | Type | Description |
|---|---|---|
| 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. |
| 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. |
| clusterNodeId | query | string | The id of the node where the content exists if clustered. |
| id | path | string | The provenance event id. |
| Status Code | Type | Description |
|---|---|---|
| 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. |
| Name | Location | Type | Description |
|---|---|---|---|
| body | LineageEntity | The lineage query details. |
| 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. |
| 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. |
| clusterNodeId | query | string | The id of the node where this query exists if clustered. |
| id | path | string | The id of the lineage query. |
| 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. |
| 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. |
| clusterNodeId | query | string | The id of the node where this query exists if clustered. |
| id | path | string | The id of the lineage query. |
| 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. |
| Name | Location | Type | Description |
|---|---|---|---|
| clientId | formData | string | If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response. |
| clusterNodeId | formData | string | The id of the node where the content exists if clustered. |
| eventId | formData | string | The provenance event id. |
| 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. |
| 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. |
| 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. |
| 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. |
| clusterNodeId | query | string | The id of the node where this query exists if clustered. |
| id | path | string | The id of the provenance query. |
| 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. |
| 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. |
| clusterNodeId | query | string | The id of the node where this query exists if clustered. |
| id | path | string | The id of the provenance query. |
| 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. |
| 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. |
| 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. |
| Name | Location | Type | Description |
|---|---|---|---|
| availability | path | string | Whether the reporting task is available on the NCM or nodes. If the NiFi is standalone the availability should be NODE. |
| body | ReportingTaskEntity | The reporting task configuration details. |
| 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. |
| 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. |
| availability | path | string | Whether the reporting task is available on the NCM or nodes. If the NiFi is standalone the availability should be NODE. |
| 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. |
| 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. |
| availability | path | string | Whether the reporting task is available on the NCM or nodes. If the NiFi is standalone the availability should be NODE. |
| id | path | string | The reporting task id. |
| 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. |
| Name | Location | Type | Description |
|---|---|---|---|
| availability | path | string | Whether the reporting task is available on the NCM or nodes. If the NiFi is standalone the availability should be NODE. |
| id | path | string | The reporting task id. |
| body | ReportingTaskEntity | The reporting task configuration details. |
| 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. |
| 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. |
| availability | path | string | Whether the reporting task is available on the NCM or nodes. If the NiFi is standalone the availability should be NODE. |
| id | path | string | The reporting task id. |
| 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. |
| 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. |
| availability | path | string | Whether the reporting task is available on the NCM or nodes. If the NiFi is standalone the availability should be NODE. |
| id | path | string | The reporting task id. |
| propertyName | query | string | The property name. |
| 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. |
| Status Code | Type | Description |
|---|---|---|
| 200 | Entity | 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. |
| Name | Location | Type | Description |
|---|---|---|---|
| q | query | string |
| 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. |
| Name | Location | Type | Description |
|---|---|---|---|
| body | SnippetEntity | The snippet configuration details. |
| 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. |
| 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. |
| verbose | query | boolean | Whether to include configuration details for the components specified in the snippet. |
| id | path | string | The snippet id. |
| 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. |
| Name | Location | Type | Description |
|---|---|---|---|
| id | path | string | The snippet id. |
| body | SnippetEntity | The snippet configuration details. |
| 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. |
| 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. |
| id | path | string | The snippet id. |
| 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. |
| 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. |
| Status Code | Type | Description |
|---|---|---|
| 200 | Entity | 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. |
| Name | Location | Type | Description |
|---|---|---|---|
| clientId | formData | string | If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response. |
| name | formData | string | The template name. |
| description | formData | string | The template description. |
| snippetId | formData | string | The id of the snippet whose contents will comprise the template. |
| 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. |
| 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. |
| 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. |
| 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 template id. |
| Status Code | Type | Description |
|---|---|---|
| 200 | TemplateDTO | 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. |
| 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 template id. |
| 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. |
| Name | Location | Type | Description |
|---|---|---|---|
| group | path | string | The name of the user group. |
| body | UserGroupEntity | The user group configuration details. |
| Status Code | Type | Description |
|---|---|---|
| 200 | UserGroupEntity | 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. |
| Name | Location | Type | Description |
|---|---|---|---|
| group | path | string | The name of the user group. |
| 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. |
| Status Code | Type | Description |
|---|---|---|
| 200 | UserGroupEntity | 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. |
| Name | Location | Type | Description |
|---|---|---|---|
| group | path | string | The name of the user group. |
| userId | path | string | The id of the user to remove from the user group. |
| 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. |
| Status Code | Type | Description |
|---|---|---|
| 200 | UserGroupEntity | 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. |
| Status Code | Type | Description |
|---|---|---|
| 200 | successful operation |
| Name | Location | Type | Description |
|---|---|---|---|