DELETE Request

This node can be used to issue HTTP DELETE requests. DELETE requests are used to delete resources on a server. Usually you don't send any data with the request and you also don't get anything back, except for maybe a status message. Although sending additional data with a DELETE request generally has no defined semantics, some HTTP service implementations may still use this. Hence, a request body can be attached in this node as well.

The node allows you to either send a request to a fixed URL (which is specified in the dialog) or to a list of URLs provided by an optional input table. Every URL will result in one request which in turn will result in one row in the output table. You can define custom request headers in the dialog.

The sent data is usually taken from a column of the input table but you can also provide a constant value in the dialog instead.

By default the output table will contain a column with the received data, its content type, and the HTTP status code. The node tries to automatically convert the received data into a KNIME data type based on its content type. In case no automatic conversion is possible, binary cells will be created.
You can extract additional response headers into column by defining them in the dialog.

The node supports several authentication methods, e.g. BASIC and DIGEST. Other authentication methods may be provided by additional extensions.

The node supports the Credential port as input (see dynamic input ports). If the port is added, it must supply a Credential that can be embedded into the HTTP Authorization header, and all request done by the node will use the Credential from the port, regardless of other node settings. The OAuth2 Authenticator , nodes provide such a Credential for example.

Options

Request URL
Select a constant URL or a column from the input table that contains the URLs that you want to request.
URL
The URL for the GET request.
URL column
Column containing the URLs for the requests.
Authentication type
The type of the used authentication.
  • None: No authentication is required.
  • Basic auth: Authentication with username and password.
  • Bearer token: Authentication with a bearer token.
  • Digest auth: Authentication with username and password using digest authentication.
  • NTLM: Authentication with username and password using NTLM authentication.
  • Kerberos: Kerberos ticket based authentication
Credentials type
The type of credentials used for authentication.
  • Manual: Use manual credential input.
  • Variable: Use a credentials flow variable.
Credentials variable
The flow variable containing the credentials which are used for authentication.
Credentials
The credentials used for the authentication.
Credentials variable
The flow variable containing the credentials which are used for bearer authorization.
Credentials
The bearer token used for authorization.
Domain
The Windows domain used for NTLM authentication.
Concurrency
Number of concurrent requests.
Enable delay
Enable delay between consecutive requests to avoid overloading the web service.
Delay (ms)
Delay between two consecutive requests in milliseconds.
Request headers
Define custom request headers. Each header consists of a key, value, and kind specification.
  • Header key: The HTTP header key, e.g. Accept or X-Custom-Key. Note that some header keys such as Origin are silently ignored by default for security reasons. You can configure KNIME AP to allow any header key by setting the sun.net.http.allowRestrictedHeaders system property in the knime.ini configuration file to true.
  • Type: The type of the value specified.
    • Constant: Use a constant value.
    • Flow variable: Use the value of a flow variable.
    • Column: Use the value of a column in the current row.
    • Username: Use the name of a stored credential.
    • Password: Use the password of a stored credential.
  • Value: The value for the header which can be a constant value or a reference to a flow variable, a column, a credential name, or a credential password (see the kind option).
Missing header value handling
How to handle missing header input values.
  • Fail: The node fails if any of the specified headers are missing in the response.
  • Skip: The node skips the row if any of the specified headers are missing in the response.
Data / Body content
The body of the request.
  • Custom: Use constant body.
  • Column: Use column's content as body.
Custom body content
The custom body content used for the request body.
Body column
The column containing the body content for the request.
Handling of invalid URLs
Specifies how invalid URLs are handled. For REST client nodes, all URLs conforming to RFC 1738 and using the HTTP or HTTPS protocol are considered valid.
  • Insert missing value: The node inserts a missing value in the output table for the corresponding request.
  • Fail node: The node execution fails.
  • Remove row: The node removes the row for the corresponding request.
Fail on connection problems (e.g. timeout, certificate errors, …)
This option describes what should happen if there was a problem establishing the connection to the server. The node either fails in execution or outputs a missing value in the row of the output table.
  • Insert missing value: The node inserts a missing value in the output table for the corresponding request.
  • Fail node: The node execution fails.
Client-side errors (HTTP 4XX)
This option describes what should happen if a response with a 4XX status code is received. These status codes usually describe client-side errors such as malformed requests.
  • Insert missing value: The node inserts a missing value in the output table for the corresponding request.
  • Fail node: The node execution fails.
Rate-limiting error handling (HTTP 429)
Decide how to proceed when receiving rate limiting errors (HTTP 429).
  • Fail node: The node execution fails.
  • Fixed delay: Pauses execution for a fixed delay before retrying the request.
Rate limiting cooldown (s)
The cooldown delay in seconds to wait when receiving rate limiting errors (HTTP 429).
Server-side errors (HTTP 5XX)
This option describes what should happen if a response with a 5XX status code is received. These status codes usually describe errors on the server side.
  • Insert missing value: The node inserts a missing value in the output table for the corresponding request.
  • Fail node: The node execution fails.
Retry on server errors
Enable automatic retries for server-side errors (HTTP 5XX).
Number of retries
Number of additional attempts that will be made after the initial request has failed.
Retry delay (s)
The base delay to be applied between retry attempts in seconds. The actual delay increases exponentially with each retry attempt.
Extracted request headers
Extracts the defined headers in the first response into columns.
  • Custom: Extract only the custom defined headers into output columns.
  • All: Extract all response headers into output columns.
Response headers
Define which response headers to extract into output columns.
  • Header key: The name of the header to extract.
  • Column name: The name of the output column.
  • Header type: The KNIME data type the header should be converted into.
Body column name
Name of the response body column in the output table.
Output additional column with error cause
If enabled, each output row corresponding to a request will contain an additional cell that, in case the request has failed, will provide a description of the error cause.
Follow redirects
If checked, the node will follow redirects (HTTP status code 3xx).
Connect timeout (s)
The connection timeout is the timeout in making the initial connection. In case of HTTPS, this includes completing the SSL handshake. This timeout is set in seconds.
Read timeout (s)
The read timeout is the time to wait until the first byte of data is read. Increasing this timeout makes sense if you have a slow connection or you expect the server will take a long time to prepare your response. This timeout is set in seconds.
Send large data in chunks
Specifies whether HTTP Chunked Transfer Encoding is allowed to be used by the node. If enabled, messages with a large body size are being sent to the server in a series of chunks.
Proxy mode
Specifies how the proxy should be configured.
  • Use KNIME-wide proxy settings: Uses the same proxy as the KNIME platform. In the KNIME Analytics Platform, this can be changed under File > Preferences > General > Network Connections.
  • Use node-specific proxy settings: This option enables the configuration fields in the "Proxy" section.
  • Direct connection: This option disables the proxy for this POST node. This will bypass KNIME-wide proxies as well.
Proxy protocol
This option describes the proxy protocol to use. HTTP, HTTPS and SOCKS can be selected.
Proxy host
Specifies the proxy host address.
Proxy port
Specifies the port that should be used at the proxy host.
Use proxy authentication
Enable if the proxy requires authentication.
Credentials type
The type of credentials used for proxy authentication.
  • Manual: Use manual credential input.
  • Variable: Use a credentials flow variable.
Credentials variable
The flow variable containing the credentials which are used for proxy authentication.
Credentials
The user name and password for proxy authentication.
Exclude hosts from proxy
Enable to specify hosts that will be ignored by the proxy. Requests to excluded hosts will use a direct connection.
Selected hosts
List of hosts that should be ignored by the proxy.
  • Excluded host: Host that should be ignored by the proxy.
Ignore hostname mismatches
If checked, the node trusts the server's SSL certificate even if it was generated for a different host.
Trust all certificates
If checked, the node trusts all certificates regardless of their origin or expiration date.

Input Ports

Icon
Optional data table containing the variable parameters of the requests.
Icon
A Credential, that can be embedded into the HTTP Authorization header. If this port is added, then all request done by the node will always use the Credential from the port, regardless of other node settings. The OAuth2 Authenticator nodes provide such a Credential for example.

Output Ports

Icon
Data table containing columns from the responses.

Views

This node has no views

Workflows

Links

Developers

You want to see the source code for this node? Click the following button and we’ll use our super-powers to find it for you.