HTTP call

General

Name

Enter a name for the unit. It must start with a letter, and cannot contain spaces. Only letters, numbers, and underscores are allowed.

Description

Enter a description for the unit.

Schema

The protocol of the request.

Host

Use the template to enter the target server address (can contain references to the input event fields).

Template format: text %%{variable} text

Path

Use the template to enter the path of the HTTP endpoint (can contain references to the input event fields). It should start with a slash.

Template format: text %%{variable} text

Accept self-signed certificate

If true, Self Signed Certificates are allowed and hostname verification is disabled.

Method

Select the required HTTP method.

Timeout

Connection request timeout (in seconds).

Max. retries

Enter the number of retries when the response status code is outside the success range of 200-299. If you do not want to perform retries, set the value to 0. This configuration applies for all errors that are not affected by a rule. To apply retries to specific rules, see the HTTP rules tab.

Delay between retries

If you define a maximum retry, a new field will show to configure the seconds to wait between retries.

Response field

Enter a name for the output event field containing the response body.

Response headers field

Enter a name for the output event field containing a map with all response headers.

Parameters

Click the plus icon to add field, name, value combinations for parameters. 

From field: Name and value taken from event.
From field and name: Name taken from settings and value from event.
From field and value: Name taken from event and value taken from event (if present) or from settings (default value).
From field, name and value: Name taken from config and value taken from event (if present) or from settings (default value).
Name and value: Name and value taken from settings (fixed parameter).

You can collapse and expand the parameters using the icon, reorder using the arrows, or delete using the X icon.

Headers

Click the plus icon to add field, name and value combinations for headers.

The possible combinations and outcomes are the same as for Parameters.

You can collapse and expand the headers using the icon, reorder using the arrows, or delete using the X icon.

HTTP Rules

HTTP Rules

Click the plus icon to add configuration rules for the http requests.

You can collapse and expand the pairs using the icon, reorder using the arrows, or delete using the X icon.

You can also drag and drop the fields to change the position.

Name

Enter a name for the rule.

From HTTP Code

Enter the initial value of the desired HTTP range. In case only one HTTP status code is desired, just type the same value in initial (from) and final (to) HTTP status codes.

To HTTP Code

Enter the final value of the desired HTTP range. In case only one HTTP status code is desired, just type the same value in initial (from) and final (to) HTTP status codes.

Port Name

Enter the name of the new port to redirect events matching the HTTP condition.

Retryable

Toggle this ON to enable retries when the response status code is outside the success range of 200-299. This toggle allows you to specifically enable whether each rule can retry or not.

in

All events enter through this port.

out

Outputs events enriched with the response field and unit configurations.

retries

Outputs retries enriches with error messages, the httpCode, remaining and current retries.

error

Signals when an error occurred. Input events are enriched with standard error fields.