Deprecation notice:

No planned alternatives to be offered. Use custom processors instead.

Please consider using one the following alternatives: No alternative components suggested.


Starts a gRPC server and listens on the given port to transform the incoming messages into FlowFiles. The message format is defined by the standard gRPC protobuf IDL provided by NiFi. gRPC isn't intended to carry large payloads, so this processor should be used only when FlowFile sizes are on the order of megabytes. The default maximum message size is 4MB.


ingest, grpc, rpc, listen


In the list below, the names of required properties appear in bold. Any other properties (not in bold) are considered optional. The table also indicates any default values.

Display NameAPI NameDefault ValueAllowable ValuesDescription
Local gRPC Service PortLocal gRPC service portThe local port that the gRPC service will listen on.
Use TLSUse TLSfalse
  • true
  • false
Whether or not to use TLS to receive the contents of the gRPC messages.
SSL Context ServiceSSL Context ServiceController Service API:
Implementation: StandardRestrictedSSLContextService
The SSL Context Service used to provide server certificate information for TLS (https) connections. Keystore must be configured on the service. If truststore is also configured, it will turn on and require client certificate authentication (Mutual TLS).

This Property is only considered if the [Use TLS] Property has a value of "true".
Authorized DN PatternAuthorized DN Pattern.*A Regular Expression to apply against the Distinguished Name of incoming connections. If the Pattern does not match the DN, the connection will be refused. The property will only be used if client certificate authentication (Mutual TLS) has been configured on SSL Context Service, otherwise it will be ignored.

This Property is only considered if the [Use TLS] Property has a value of "true".
Flow Control WindowFlow Control Window1MBThe initial HTTP/2 flow control window for both new streams and overall connection. Flow-control schemes ensure that streams on the same connection do not destructively interfere with each other. The default is 1MB.
Maximum Message SizeMax Message Size4MBThe maximum size of FlowFiles that this processor will allow to be received. The default is 4MB. If FlowFiles exceed this size, you should consider using another transport mechanism as gRPC isn't designed for heavy payloads.


SuccessThe FlowFile was received successfully.

Reads Attributes:

None specified.

Writes Attributes:

listengrpc.remote.user.dnThe DN of the user who sent the FlowFile to this NiFi
listengrpc.remote.hostThe IP of the client who sent the FlowFile to this NiFi

State management:

This component does not store state.


This component is not restricted.

Input requirement:

This component does not allow an incoming relationship.

System Resource Considerations:

None specified.