HTTP
Most recent version: v1.0.1
Last updated
Was this helpful?
Most recent version: v1.0.1
Last updated
Was this helpful?
Onum supports integration with HTTP protocols.
Select HTTP from the list of Data sink types and click Configuration to start.
Now you need to specify how and where to send the data, and how to establish a connection with HTTP.
Enter the basic information for the new Data sink.
Name*
Enter a name for the new Data sink.
Description
Optionally, enter a description for the Data sink.
Tags
Add tags to easily identify your Data sink. Hit the Enter key after you define each tag
HTTP method*
The method used to connect to the server.
URL*
The URL to send HTTP requests.
Message
This is the field containing the message you wish to send on.
Content type
Set the request content type. Choose between:
text/plain - The message body contains plain text.
application/json - The message body is formatted as JSON. This is the default option.
application/xml - The message body is formatted as XML.
text/html - The message body contains HTML.
application/x-ndjson - The message body is formatted as NDJSON.
Support special characters
Set this to true to allow special characters in HTTP requests. Mostly used with application/x-ndjson content type.
HTTP headers
Map of header key-value pairs to be included in the request.
HTTP bulk configuration refers to setting up an API or system to handle multiple requests or large amounts of data efficiently in a single operation. Instead of sending multiple individual HTTP requests, use the bulk settings to send a single request containing multiple actions.
For example, this sends three user records in one request instead of three separate requests.
Bulk allow*
true to set a bulk amount or false to ignore.
Delimiter
Optionally, choose a delimiter to separate the individual records in the bulk data file. Choose between:
Manual delimeter - Each record will appear on its own line. This is the default option. Enter the required delimeter in the Manual delimiter field that appears. The default value is \n
Json list - Use a comma (,) to separate individual JSON objects.
Maximum number of buffers per server URL
Multiple buffers can be assigned to a single URL to prevent excessive memory usage. The default and maximim value is 50.
Event amount
Enter the bulk amount to allow through.
Event time limit
If the bulk amount is not reached, enter the seconds to wait before sending through the accumulated events.
Authentication type*
Choose the required authentication type:
None - Choose this if no authentication is required.
Basic - Enter the required Username and Password.
Bearer - If you're using a bearer Token, select it from the list.
API key - If you're using API credentials, enter your API key name and choose the required API key value.
OAuth2 - Choose if you want to set OAuth2 authentication. Set the following:
OAuth URL* - OAuth server URL.
OAuth method* - OAuth method used when sending requests to the server.
Send body as - Select how to send the request body to the server From URL encoded or JSON).
OAuth request body - Body that will be sent to auth server.
OAuth token path* - Path to token in response body from auth server.
Query key / Value pairs - Set of query keys and values. Use this also in case you are sending the request with From URL encoded content type.
Header key / Value pairs - Set of header keys and values.
Activate the TLS Configuration toggle to enable TLS and configure these parameters:
Minimum TLS version*
Choose the TLS version to use.
Certificate
Predefined TLS certificate.
Private key
Private key of the corresponding certificate.
Skip TLS validations
Activate to skip all TLS validations.
CA Chain
Path containing the CA certificates.
If your organization uses proxy servers, establish the connection here:
Proxy scheme
Choose the field to set in the proxy scheme (HTTP or HTTPS)
Username
Username used in the proxy.
Password
Password used in the proxy.
URL
Proxy server and port.
Maximum requests
Set a limit on the number of requests per second to launch on the server. The maximum value is 100.
Select Save and see your Data sink appear in the list.
Decide whether or not to include this Data sink info in the metrics and graphs of the area.
When it comes to using this Data sink in a , you must configure the following output parameters. To do it, simply click the Data sink on the canvas and select Configuration.
