Skip to main content

Elasticsearch Feed

This Integration is part of the Elasticsearch Feed Pack.#

Supported versions

Supported Cortex XSOAR versions: 5.5.0 and later.

Overview#


Fetch indicators stored in an Elasticsearch database.

  1. The Cortex XSOAR Feed contains system indicators saved in an Elasticsearch index.
  2. The Cortex XSOAR MT Shared Feed contains indicators shared by a tenant account in a multi-tenant environment.
  3. The Generic Feed contains a feed in a format specified by the user.

Supports version 6 and later. This integration was integrated and tested with versions 6.6.2, 7.3, 8.4.1 of Elasticsearch.

Configure Elasticsearch Feed on Cortex XSOAR#

  1. Navigate to Settings > Integrations > Servers & Services.

  2. Search for Elasticsearch Feed.

  3. Click Add instance to create and configure a new integration instance.

    ParameterDescriptionRequired
    Server URLTrue
    Name (see ?->Authentication)Provide Username + Passoword instead of API key + API IDFalse
    PasswordFalse
    Client typeFor Elasticsearch version 7 and below, select 'Elasticsearch'. For Elasticsearch server version 8, select 'Elasticsearch_v8'. In some hosted ElasticSearch environments, the standard ElasticSearch client is not supported. If you encounter any related client issues, please consider using the OpenSearch client type.False
    Trust any certificate (not secure)False
    Use system proxy settingsFalse
    Feed TypeThe Cortex XSOAR Feed contains system indicators saved in an Elasticsearch index. The Cortex XSOAR MT Shared Feed contains indicators shared by a tenant account in a multi-tenant environment. Generic Feed contains a feed in a format specified by the userFalse
    Fetch indicatorsFalse
    First Fetch TimeDetermine how far to look back for fetched indicators (<number> <time unit>, e.g., 12 hours, 7 days).False
    Fetch LimitThe maximal number of indicators that could be fetched in a fetch cycle.False
    Indicator ReputationIndicators from this integration instance will be marked with this reputationFalse
    Source ReliabilityReliability of the source providing the intelligence dataTrue
    Traffic Light Protocol ColorThe Traffic Light Protocol (TLP) designation to apply to indicators fetched from the feedFalse
    Feed Fetch IntervalFalse
    TagsSupports CSV values.False
    Bypass exclusion listWhen selected, the exclusion list is ignored for indicators from this feed. This means that if an indicator from this feed is on the exclusion list, the indicator might still be added to the system.False
    Indicator Value FieldSource field that contains the indicator value in the index. Relevant for generic feed type only.False
    Indicator Type FieldSource field that contains the indicator type in the index. Relevant for generic feed type only.False
    Indicator TypeDefault indicator type used in case no "Indicator Type Field" was provided. Relevant for generic feed type only.False
    Index from Which To Fetch IndicatorsA comma-separated list of indexes. If empty, searches all indexes.False
    Time Field TypeFalse
    Index Time FieldUsed for sorting and limiting data. If empty, results are not sorted. Relevant for generic feed type only.False
    QueryElasticsearch query to execute when fetching indicators from ElasticsearchFalse
  4. Click Test to validate the URLs, token, and connection.

Commands#

You can execute these commands from the Cortex XSOAR CLI, as part of an automation, or in a playbook. After you successfully execute a command, a DBot message appears in the War Room with the command details.

es-get-indicators#


Gets indicators available in the configured Elasticsearch database.

Base Command#

es-get-indicators

Input#

Argument NameDescriptionRequired
limitThe maximum number of indicators to fetch. Default is 50.Required

Context Output#

There is no context output for this command.