HTTP Pull

Most recent version: v0.0.1

See the changelog of this Listener type here.

Note that this Listener is only available in certain Tenants. Get in touch with us if you don't see it and want to access it.

Overview

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

Configuration

Now you need to specify how and where to collect the data and how to establish an HTTP connection.

Metadata

Enter the basic information for the new Listener.

Parameter	Description
Name*	Enter a name for the new Listener.
Description	Optionally, enter a description for the Listener.
Tags	Add tags to easily identify your Listener. Hit the Enter key after you define each tag.

Configuration

Cloud Listeners

Note that you won't see the Socket and TLS configuration sections in the creation form if you're defining this Listener in a Cloud instance, as these are already provided by Onum. Learn more about Cloud Listeners in this article.

Secrets

Parameter	Description
Name	Enter a name for the Secret you will select in the drop-down.
Value	Select the Secret containing the connection credentials if you have added them previously, or select New Secret to add it. Add as many as required.

Config as YAML

Toggle ON to configure the HTTP as a YAML.

Temporal Window

Toggle ON to add a temporal window for events.

Parameter	Description
Duration*	Add the duration in milliseconds that the window will remain open for.
Offset*	Enter a delay time.
Time Zone*	This value is usually automatically set to your current time zone. If not, select it here.
Format*	Choose between Epoch or RCF3339 for the timestamp format.

Authentication

If your connection requires authentication, enter the credentials here.

Parameter	Description
Authentication Type*	Choose the authentication type and enter the details.

Authentication credentials

The options provided will vary depending on the type chosen to authenticate your API. This is the type you have selected in the API end, so it can recognize the request.

Choose between the options below.

Basic

• Username* - the user sending the request.

• Password* - choose the basic auth password from your list of secrets or create a new one.

API Key

Enter the following:

• API Key - API keys are usually stored in developer portals, cloud dashboards, or authentication settings. Choose the existing Secret or create a new one if you haven't stored this key within Onum.

Note that the HTTP Listener expects the API Key to be included in the URL, as a query parameter. For example:

curl --location 'http://customer.in.prod.onum.com:2250/test?My-Token=1234567890qwerty' \
--header 'Content-Type: application/json' \
--data '{"message": "hello, how are you doing? :)"}'

• Auth injection:

  • In* - Enter the incoming format of the API: Header or Query.

  • Name* - A label assigned to the API key for identification. You can find it depending on where the API key was created.

  • Prefix - Enter a connection prefix if required.

  • Suffix - Enter a connection suffix if required.

Token

Token Retrieve Based Authentication

• Request -

  • Method* - Choose between GET or POST

  • URL*- Enter the URL to send the request to.

• Headers - Add as many headers as required.

  • Name

  • Value

• Query Params - Add as many query parameters as required.

  • Name

  • Value

• Token Path* - Enter your Token Path for used to retrieve an authentication token.

• Auth injection:

  • In* - Enter the incoming format of the API: Header or Query.

  • Name* - A label assigned to the API key for identification. You can find it depending on where the API key was created.

  • Prefix - Enter a connection prefix if required.

  • Suffix - Enter a connection suffix if required.

Enumeration Phase

Identify the available endpoints, methods, parameters, and resources exposed by the API.

Parameter	Description
Pagination Type*	Select on from the drop-down. Pagination type is the method used to split and deliver large datasets in smaller, manageable parts (pages), and how those pages can be navigated during discovery.

Collection Phase

The collection phase involves gathering actual data from an API after the enumeration phase has mapped out endpoints, parameters, and authentication methods.

Parameter	Description
Pagination Type*	Choose how the API organizes and delivers large sets of data across multiple pages—and how that affects the process of systematically collecting or extracting all available records.

Output

Parameter	Description
Select*	If your connection does not require authentication, leave as None. Otherwise, choose the authentication type and enter the details.
Filter
Map
Output Mode*	Choose between Element or Collection.

Click Create labels to move on to the next step and define the required Labels if needed.