InvokeHTTP

InvokeHTTP 2.0.0

Bundle: org.apache.nifi | nifi-standard-nar
Description: An HTTP client processor which can interact with a configurable HTTP Endpoint. The destination URL and HTTP Method are configurable. When the HTTP Method is PUT, POST or PATCH, the FlowFile contents are included as the body of the request and FlowFile attributes are converted to HTTP headers, optionally, based on configuration properties.
Tags: client, http, https, rest
Input Requirement: ALLOWED
Supports Sensitive Dynamic Properties: true

Properties

Connection Timeout
Maximum time to wait for initial socket connection to the HTTP URL.

Display Name

Connection Timeout

Description

Maximum time to wait for initial socket connection to the HTTP URL.

API Name

Connection Timeout

Default Value

5 secs

Expression Language Scope

Not Supported

Sensitive

false

Required

true
HTTP Method
HTTP request method (GET, POST, PUT, PATCH, DELETE, HEAD, OPTIONS). Arbitrary methods are also supported. Methods other than POST, PUT and PATCH will be sent without a message body.

Display Name

HTTP Method

Description

HTTP request method (GET, POST, PUT, PATCH, DELETE, HEAD, OPTIONS). Arbitrary methods are also supported. Methods other than POST, PUT and PATCH will be sent without a message body.

API Name

HTTP Method

Default Value

GET

Expression Language Scope

Environment variables and FlowFile Attributes

Sensitive

false

Required

true
HTTP URL
HTTP remote URL including a scheme of http or https, as well as a hostname or IP address with optional port and path elements. Any encoding of the URL must be done by the user.

Display Name

HTTP URL

Description

HTTP remote URL including a scheme of http or https, as well as a hostname or IP address with optional port and path elements. Any encoding of the URL must be done by the user.

API Name

HTTP URL

Expression Language Scope

Environment variables and FlowFile Attributes

Sensitive

false

Required

true
HTTP/2 Disabled
Disable negotiation of HTTP/2 protocol. HTTP/2 requires TLS. HTTP/1.1 protocol supported is required when HTTP/2 is disabled.
Display Name

HTTP/2 Disabled

Description

Disable negotiation of HTTP/2 protocol. HTTP/2 requires TLS. HTTP/1.1 protocol supported is required when HTTP/2 is disabled.

API Name

HTTP/2 Disabled

Default Value

False

Allowable Values
- True
- False
Expression Language Scope

Not Supported

Sensitive

false

Required

true
Proxy Configuration Service
Specifies the Proxy Configuration Controller Service to proxy network requests. Supported proxies: HTTP + AuthN, SOCKS In case of SOCKS, it is not guaranteed that the selected SOCKS Version will be used by the processor.

Display Name

Proxy Configuration Service

Description

Specifies the Proxy Configuration Controller Service to proxy network requests. Supported proxies: HTTP + AuthN, SOCKS In case of SOCKS, it is not guaranteed that the selected SOCKS Version will be used by the processor.

API Name

proxy-configuration-service

Service Interface

org.apache.nifi.proxy.ProxyConfigurationService

Service Implementations

org.apache.nifi.proxy.StandardProxyConfigurationService

Expression Language Scope

Not Supported

Sensitive

false

Required

false
Request Body Enabled
Enable sending HTTP request body for PATCH, POST, or PUT methods.
Display Name

Request Body Enabled

Description

Enable sending HTTP request body for PATCH, POST, or PUT methods.

API Name

Request Body Enabled

Default Value

true

Allowable Values
- true
- false
Expression Language Scope

Not Supported

Sensitive

false

Required

false

Dependencies
- HTTP Method is set to any of [POST, PATCH, PUT]
Request Chunked Transfer-Encoding Enabled
Enable sending HTTP requests with the Transfer-Encoding Header set to chunked, and disable sending the Content-Length Header. Transfer-Encoding applies to the body in HTTP/1.1 requests as described in RFC 7230 Section 3.3.1
Display Name

Request Chunked Transfer-Encoding Enabled

Description

Enable sending HTTP requests with the Transfer-Encoding Header set to chunked, and disable sending the Content-Length Header. Transfer-Encoding applies to the body in HTTP/1.1 requests as described in RFC 7230 Section 3.3.1

API Name

Request Chunked Transfer-Encoding Enabled

Default Value

false

Allowable Values
- true
- false
Expression Language Scope

Not Supported

Sensitive

false

Required

true

Dependencies
- HTTP Method is set to any of [POST, PATCH, PUT]
Request Content-Encoding
HTTP Content-Encoding applied to request body during transmission. The receiving server must support the selected encoding to avoid request failures.
Display Name

Request Content-Encoding

Description

HTTP Content-Encoding applied to request body during transmission. The receiving server must support the selected encoding to avoid request failures.

API Name

Request Content-Encoding

Default Value

DISABLED

Allowable Values
- DISABLED
- GZIP
Expression Language Scope

Not Supported

Sensitive

false

Required

true

Dependencies
- HTTP Method is set to any of [POST, PATCH, PUT]
Request Content-Type
HTTP Content-Type Header applied to when sending an HTTP request body for PATCH, POST, or PUT methods. The Content-Type defaults to application/octet-stream when not configured.
Display Name

Request Content-Type

Description

HTTP Content-Type Header applied to when sending an HTTP request body for PATCH, POST, or PUT methods. The Content-Type defaults to application/octet-stream when not configured.

API Name

Request Content-Type

Default Value

${mime.type}

Expression Language Scope

Environment variables and FlowFile Attributes

Sensitive

false

Required

true

Dependencies
- HTTP Method is set to any of [POST, PATCH, PUT]
Request Date Header Enabled
Enable sending HTTP Date Header on HTTP requests as described in RFC 7231 Section 7.1.1.2.
Display Name

Request Date Header Enabled

Description

Enable sending HTTP Date Header on HTTP requests as described in RFC 7231 Section 7.1.1.2.

API Name

Request Date Header Enabled

Default Value

True

Allowable Values
- True
- False
Expression Language Scope

Not Supported

Sensitive

false

Required

true
Request Digest Authentication Enabled
Enable Digest Authentication on HTTP requests with Username and Password credentials as described in RFC 7616.
Display Name

Request Digest Authentication Enabled

Description

Enable Digest Authentication on HTTP requests with Username and Password credentials as described in RFC 7616.

API Name

Request Digest Authentication Enabled

Default Value

false

Allowable Values
- true
- false
Expression Language Scope

Not Supported

Sensitive

false

Required

false

Dependencies
- Request Username is set to any value specified
Request Failure Penalization Enabled
Enable penalization of request FlowFiles when receiving HTTP response with a status code between 400 and 499.
Display Name

Request Failure Penalization Enabled

Description

Enable penalization of request FlowFiles when receiving HTTP response with a status code between 400 and 499.

API Name

Request Failure Penalization Enabled

Default Value

false

Allowable Values
- true
- false
Expression Language Scope

Not Supported

Sensitive

false

Required

false
Request Header Attributes Pattern
Regular expression that defines which FlowFile attributes to send as HTTP headers in the request. If not defined, no attributes are sent as headers. Dynamic properties will be always be sent as headers. The dynamic property name will be the header key and the dynamic property value, interpreted as Expression Language, will be the header value. Attributes and their values are limited to ASCII characters due to the requirement of the HTTP protocol.

Display Name

Request Header Attributes Pattern

Description

Regular expression that defines which FlowFile attributes to send as HTTP headers in the request. If not defined, no attributes are sent as headers. Dynamic properties will be always be sent as headers. The dynamic property name will be the header key and the dynamic property value, interpreted as Expression Language, will be the header value. Attributes and their values are limited to ASCII characters due to the requirement of the HTTP protocol.

API Name

Request Header Attributes Pattern

Expression Language Scope

Not Supported

Sensitive

false

Required

false
Request Multipart Form-Data Filename Enabled
Enable sending the FlowFile filename attribute as the filename parameter in the Content-Disposition Header for multipart/form-data HTTP requests.
Display Name

Request Multipart Form-Data Filename Enabled

Description

Enable sending the FlowFile filename attribute as the filename parameter in the Content-Disposition Header for multipart/form-data HTTP requests.

API Name

Request Multipart Form-Data Filename Enabled

Default Value

true

Allowable Values
- true
- false
Expression Language Scope

Not Supported

Sensitive

false

Required

false

Dependencies
- Request Multipart Form-Data Name is set to any value specified
Request Multipart Form-Data Name
Enable sending HTTP request body formatted using multipart/form-data and using the form name configured.
Display Name

Request Multipart Form-Data Name

Description

Enable sending HTTP request body formatted using multipart/form-data and using the form name configured.

API Name

Request Multipart Form-Data Name

Expression Language Scope

Environment variables and FlowFile Attributes

Sensitive

false

Required

false

Dependencies
- Request Body Enabled is set to any of [true]
Request OAuth2 Access Token Provider
Enables managed retrieval of OAuth2 Bearer Token applied to HTTP requests using the Authorization Header.

Display Name

Request OAuth2 Access Token Provider

Description

Enables managed retrieval of OAuth2 Bearer Token applied to HTTP requests using the Authorization Header.

API Name

Request OAuth2 Access Token Provider

Service Interface

org.apache.nifi.oauth2.OAuth2AccessTokenProvider

Service Implementations

org.apache.nifi.oauth2.StandardOauth2AccessTokenProvider

Expression Language Scope

Not Supported

Sensitive

false

Required

false
Request Password
The password provided for authentication of HTTP requests. Encoded using Base64 for HTTP Basic Authentication as described in RFC 7617.

Display Name

Request Password

Description

The password provided for authentication of HTTP requests. Encoded using Base64 for HTTP Basic Authentication as described in RFC 7617.

API Name

Request Password

Expression Language Scope

Not Supported

Sensitive

true

Required

false
Request User-Agent
HTTP User-Agent Header applied to requests. RFC 7231 Section 5.5.3 describes recommend formatting.

Display Name

Request User-Agent

Description

HTTP User-Agent Header applied to requests. RFC 7231 Section 5.5.3 describes recommend formatting.

API Name

Request User-Agent

Expression Language Scope

Environment variables and FlowFile Attributes

Sensitive

false

Required

false
Request Username
The username provided for authentication of HTTP requests. Encoded using Base64 for HTTP Basic Authentication as described in RFC 7617.

Display Name

Request Username

Description

The username provided for authentication of HTTP requests. Encoded using Base64 for HTTP Basic Authentication as described in RFC 7617.

API Name

Request Username

Expression Language Scope

Not Supported

Sensitive

false

Required

false
Response Body Attribute Name
FlowFile attribute name used to write an HTTP response body for FlowFiles transferred to the Original relationship.

Display Name

Response Body Attribute Name

Description

FlowFile attribute name used to write an HTTP response body for FlowFiles transferred to the Original relationship.

API Name

Response Body Attribute Name

Expression Language Scope

Environment variables and FlowFile Attributes

Sensitive

false

Required

false
Response Body Attribute Size
Maximum size in bytes applied when writing an HTTP response body to a FlowFile attribute. Attributes exceeding the maximum will be truncated.
Display Name

Response Body Attribute Size

Description

Maximum size in bytes applied when writing an HTTP response body to a FlowFile attribute. Attributes exceeding the maximum will be truncated.

API Name

Response Body Attribute Size

Default Value

256

Expression Language Scope

Not Supported

Sensitive

false

Required

false

Dependencies
- Response Body Attribute Name is set to any value specified
Response Body Ignored
Disable writing HTTP response FlowFiles to Response relationship
Display Name

Response Body Ignored

Description

Disable writing HTTP response FlowFiles to Response relationship

API Name

Response Body Ignored

Default Value

false

Allowable Values
- true
- false
Expression Language Scope

Not Supported

Sensitive

false

Required

true
Response Cache Enabled
Enable HTTP response caching described in RFC 7234. Caching responses considers ETag and other headers.
Display Name

Response Cache Enabled

Description

Enable HTTP response caching described in RFC 7234. Caching responses considers ETag and other headers.

API Name

Response Cache Enabled

Default Value

false

Allowable Values
- true
- false
Expression Language Scope

Not Supported

Sensitive

false

Required

true
Response Cache Size
Maximum size of HTTP response cache in bytes. Caching responses considers ETag and other headers.
Display Name

Response Cache Size

Description

Maximum size of HTTP response cache in bytes. Caching responses considers ETag and other headers.

API Name

Response Cache Size

Default Value

10MB

Expression Language Scope

Not Supported

Sensitive

false

Required

true

Dependencies
- Response Cache Enabled is set to any of [true]
Response Cookie Strategy
Strategy for accepting and persisting HTTP cookies. Accepting cookies enables persistence across multiple requests.
Display Name

Response Cookie Strategy

Description

Strategy for accepting and persisting HTTP cookies. Accepting cookies enables persistence across multiple requests.

API Name

Response Cookie Strategy

Default Value

DISABLED

Allowable Values
- DISABLED
- ACCEPT_ALL
Expression Language Scope

Not Supported

Sensitive

false

Required

true
Response FlowFile Naming Strategy
Determines the strategy used for setting the filename attribute of FlowFiles transferred to the Response relationship.
Display Name

Response FlowFile Naming Strategy

Description

Determines the strategy used for setting the filename attribute of FlowFiles transferred to the Response relationship.

API Name

Response FlowFile Naming Strategy

Default Value

RANDOM

Allowable Values
- RANDOM
- URL_PATH
Expression Language Scope

Not Supported

Sensitive

false

Required

true
Response Generation Required
Enable generation and transfer of a FlowFile to the Response relationship regardless of HTTP response received.
Display Name

Response Generation Required

Description

Enable generation and transfer of a FlowFile to the Response relationship regardless of HTTP response received.

API Name

Response Generation Required

Default Value

false

Allowable Values
- true
- false
Expression Language Scope

Not Supported

Sensitive

false

Required

false
Response Header Request Attributes Enabled
Enable adding HTTP response headers as attributes to FlowFiles transferred to the Original relationship.
Display Name

Response Header Request Attributes Enabled

Description

Enable adding HTTP response headers as attributes to FlowFiles transferred to the Original relationship.

API Name

Response Header Request Attributes Enabled

Default Value

false

Allowable Values
- true
- false
Expression Language Scope

Not Supported

Sensitive

false

Required

false
Response Redirects Enabled
Enable following HTTP redirects sent with HTTP 300 series responses as described in RFC 7231 Section 6.4.
Display Name

Response Redirects Enabled

Description

Enable following HTTP redirects sent with HTTP 300 series responses as described in RFC 7231 Section 6.4.

API Name

Response Redirects Enabled

Default Value

True

Allowable Values
- True
- False
Expression Language Scope

Not Supported

Sensitive

false

Required

true
Socket Idle Connections
Maximum number of idle connections to the HTTP URL.

Display Name

Socket Idle Connections

Description

Maximum number of idle connections to the HTTP URL.

API Name

Socket Idle Connections

Default Value

5

Expression Language Scope

Not Supported

Sensitive

false

Required

true
Socket Idle Timeout
Maximum time to wait before closing idle connections to the HTTP URL.

Display Name

Socket Idle Timeout

Description

Maximum time to wait before closing idle connections to the HTTP URL.

API Name

Socket Idle Timeout

Default Value

5 mins

Expression Language Scope

Not Supported

Sensitive

false

Required

true
Socket Read Timeout
Maximum time to wait for receiving responses from a socket connection to the HTTP URL.

Display Name

Socket Read Timeout

Description

Maximum time to wait for receiving responses from a socket connection to the HTTP URL.

API Name

Socket Read Timeout

Default Value

15 secs

Expression Language Scope

Not Supported

Sensitive

false

Required

true
Socket Write Timeout
Maximum time to wait for write operations while sending requests from a socket connection to the HTTP URL.

Display Name

Socket Write Timeout

Description

Maximum time to wait for write operations while sending requests from a socket connection to the HTTP URL.

API Name

Socket Write Timeout

Default Value

15 secs

Expression Language Scope

Not Supported

Sensitive

false

Required

true
SSL Context Service
SSL Context Service provides trusted certificates and client certificates for TLS communication.

Display Name

SSL Context Service

Description

SSL Context Service provides trusted certificates and client certificates for TLS communication.

API Name

SSL Context Service

Service Interface

org.apache.nifi.ssl.SSLContextService

Service Implementations

org.apache.nifi.ssl.StandardRestrictedSSLContextService

org.apache.nifi.ssl.StandardSSLContextService

Expression Language Scope

Not Supported

Sensitive

false

Required

false

Dynamic Properties

Header Name
Send request header with a key matching the Dynamic Property Key and a value created by evaluating the Attribute Expression Language set in the value of the Dynamic Property.

Name

Header Name

Description

Send request header with a key matching the Dynamic Property Key and a value created by evaluating the Attribute Expression Language set in the value of the Dynamic Property.

Value

Attribute Expression Language

Expression Language Scope

FLOWFILE_ATTRIBUTES
post:form:<NAME>
When the HTTP Method is POST, dynamic properties with the property name in the form of post:form:<NAME>, where the <NAME> will be the form data name, will be used to fill out the multipart form parts. If send message body is false, the flowfile will not be sent, but any other form data will be.

Name

post:form:<NAME>

Description

When the HTTP Method is POST, dynamic properties with the property name in the form of post:form:<NAME>, where the <NAME> will be the form data name, will be used to fill out the multipart form parts. If send message body is false, the flowfile will not be sent, but any other form data will be.

Value

Attribute Expression Language

Expression Language Scope

FLOWFILE_ATTRIBUTES

Relationships

Name	Description
No Retry	Request FlowFiles transferred when receiving HTTP responses with a status code between 400 an 499.
Original	Request FlowFiles transferred when receiving HTTP responses with a status code between 200 and 299.
Failure	Request FlowFiles transferred when receiving socket communication errors.
Retry	Request FlowFiles transferred when receiving HTTP responses with a status code between 500 and 599.
Response	Response FlowFiles transferred when receiving HTTP responses with a status code between 200 and 299.

Writes Attributes

Name	Description
invokehttp.status.code	The status code that is returned
invokehttp.status.message	The status message that is returned
invokehttp.response.body	In the instance where the status code received is not a success (2xx) then the response body will be put to the 'invokehttp.response.body' attribute of the request FlowFile.
invokehttp.request.url	The original request URL
invokehttp.request.duration	Duration (in milliseconds) of the HTTP call to the external endpoint
invokehttp.response.url	The URL that was ultimately requested after any redirects were followed
invokehttp.tx.id	The transaction ID that is returned after reading the response
invokehttp.remote.dn	The DN of the remote server
invokehttp.java.exception.class	The Java exception class raised when the processor fails
invokehttp.java.exception.message	The Java exception message raised when the processor fails
user-defined	If the 'Put Response Body In Attribute' property is set then whatever it is set to will become the attribute key and the value would be the body of the HTTP response.