HTTP

Current version v0.0.6

See the changelog of this Sink here.

Overview

Onum supports integration with HTTP protocols. Select HTTP from the list of Sink types and click Configuration to start.

Configuration

Now you need to specify how and where to send the data, and how to establish a connection with HTTP.

Metadata

Enter the basic information for the new Data Sink.

Parameters	Description
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 Sink. Hit the Enter key after you define each tag.

---

Metrics

Decide whether or not to include this Data sink info in the metrics and graphs of the Home area.

Configuration

Now, when you add this Data Sink to your Pipeline, you can configure it to establish the connection.

Output Configuration

Parameter	Description
HTTP method*	The method used to connect to the server.
URL*	The server URL.
Message	This is the field containing the message you wish to send on.
Content Type	The Content-Type: xxx/xxx lets the server know the expected format of the incoming message or request (application/json by default): Application/Json: the message body is formatted as JSON. Application/XML: the message body is formatted as XML. Text/Plain: the message body contains plain text. Text/HTML: the message body contains HTML.
HTTP Headers	Write the key-value pair contained in the HTTP header if it does not appear above, e.g. {"content-type":"json"}.

Bulk Configuration

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.

POST /api/bulk/users HTTP/1.1
Content-Type: application/json

[
  {"id": 1, "name": "Alice"},
  {"id": 2, "name": "Bob"},
  {"id": 3, "name": "Charlie"}
]

Parameter	Description
Bulk allow*	true to set a bulk amount or false to ignore.
Delimiter	Optionally add a delimiter if you wish to to separate the individual records in the bulk data file. Choose between: Newline character (\n) to ensure each record appears on its own line. This is the default. Json list: use a comma (,) to separate individual JSON objects.
Manual Delimiter	If you wish to use a different delimiter than provided in the list, enter it here.
Maximum number of buffers per server URL	Multiple buffers can be assigned to a single URL to prevent excessive memory usage. The limit is 50 by default, but add a custom limit if required.
Event amount	If you have selected true, 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 Configuration

• Authentication type* - which method to use (none, basic, bearer, or API key).

• Username

• Password

• Token

• API Key

TLS Configuration

• Allow TLS Configuration*- true to activate or false to ignore.

• Certificate - this is the predefined TLS certificate.

• Private Key - the private key of the corresponding certificate.

• CA Chain- the path containing the CA certificates.

• Minimum TLS version- choose the TLS version to use.

Proxy Configuration

If your organization uses proxy servers, establish the connection here.

• Proxy Scheme

• Username

• Password

• URL

Rate Limit

Parameter	Description
Maximum requests	Set a limit on the number of requests per second to launch on the server.

---

Select Save and see your Sink appear in the list of Datasinks.