Integration Actions

Select the action you wish to take and jump to the relevant section:

• Create Integration
• View Integrations
  • What are all the Integration fields?
• View Integration Configuration
• Integration Status
• Delete Integration

If you are new to integrations you should review Integrations Overview 

Create Integration

1. From your Samurai MDR application tenant select  Integrations from the main menu
2. Click Create integration
3. Select the product you wish to integrate with the Samurai platform
4. Click Next. Dependent on how we collect telemetry, the product may be integrated via a Cloud Collector or Local Collector. Follow the steps based on the Collector type:

Cloud Collector

1. If the integration is cloud-based it will be added to the Cloud Collector which shall be displayed - Select Next
2. Select Configuration Guide which will direct you to the Help Center article outlining how to configure your product and obtain required fields.
3. Once you have configured your product, complete the required fields
4. Select Finish

Local Collector

1. Your Local Collector(s) will be listed. Select the Local Collector that you will integrate the product with
2. Click Next (typically this is the syslog destination host when configuring your device).  If you do not have a Local Collector setup and deployed, follow the steps in our Samurai Local Collector article.
3. The Local Collector IP Address will be displayed, copy the IP address or take note of it
4. Click Configuration Guide which will direct you to the Help Center article outlining how to configure your product. 
5. Based on the product, Extended Data Collection may be displayed, if so jump to Extended Data Collection
6. Click Finish

You do not need to follow the steps above for a Local Collector integration, however we advise you follow the steps to determine if extended data collection is available for the product, and if you wish to enable it.  You may choose to follow our configuration guides to send logs directly to your Local Collector, the Samurai platform will auto detect the vendor and product for supported integrations. If we do not support the product, your integration will be displayed as 'unknown' under the Vendor and Product fields, however the Samurai platform will store the telemetry data. 

Extended Data Collection

For many products we are able to collect extended data enhancing our threat detection capabilities and accuracy, for example Packet Capture (PCAP) data. This option will be displayed during configuration of an integration. 

1. If extended data collection is available for the product, you can choose to enable or disable via the toggle. If you choose to disable, Select Finish
2. If you choose to enable extended data collection you must complete all the necessary fields. The parameters for each field are derived from following the associated product configuration guide. Once complete, Select Finish.

You can choose to follow the configuration guide at anytime during the process, however if your product is not configured, the Samurai platform will obviously not receive any telemetry.

All third-party product configuration guides can be found on the Samurai Help Center

View Integration

There are multiple methods of viewing your integrations. 

If you wish to view integrations associated with a specific collector:

1. From your Samurai MDR application tenant select Collectors
2. Select the relevant Collector
3. All integrations associated with the Collector will be displayed with associated information

You can also view  all integrations regardless of collector:

1. Select  Integrations in the main menu 
2. All of your Integrations will be listed 

A single product integration may be displayed multiple times based on telemetry data ingested. For example, if you enabled Extended Data Collection whilst creating an integration the individual product will be displayed multiple times with different Type fields associated - see below for further explanation.

What are all the Integration fields?

• Status: Color indication of integration status
• Status Description: description of the status
• Vendor: vendor name of the product 
• Product: product name
• Type: integration type used to gather or ingest telemetry.  Potential entries you could see here include:
  • Log: displayed when a telemetry source sends logs (typically via syslog). 
  • Local: displayed when we leverage an API from the local collector to gather telemetry
  • Cloud: displayed when we leverage an API from a Samurai XDR cloud collector to gather telemetry
• Name: integration name you provided during configuration
• IP Address: IP address of the host
• Collector: the collector name associated with the integration
• Description: an optional description you provided during integration configuration
• Last Event Seen: the last event seen from the telemetry source in the format [yyyy:mm:dd], [hh:mm:ss] with time represented in Universal Time Coordinated (UTC). 
• Created: date and time of integration creation in the format [yyyy:mm:dd], [hh:mm:ss] with time represented in Universal Time Coordinated (UTC). 

Select Columns to enable or disable visible fields

View Integration Configuration

There are multiple methods of viewing your integration configuration. If you wish to view integration configuration associated with a specific Collector:

1. From your Samurai MDR application select Collectors
2. Select the relevant collector for your list
3. All integrations associated with the collector will be displayed

You can also view all integration configuration regardless of collector:

1. Select Integrations in the main menu on the left of the screen
2. Find and Select  your integrated product
3. Configuration parameters will be displayed

View Integration Status

There are multiple methods of viewing your Integration status.

If you wish to view integration status associated with a specific Collector:

1. From the Samurai MDR application select Collectors
2. Select the relevant collector from your list
3. All integrations listed related to the collector will be displayed with status color and description (if enabled)

You can also view status of all integrations regardless of collector:

1. From your Samurai MDR application select  Integrations 
2. All integrations shall be displayed with a status color and description (if enabled)

Potential status displayed are included in the table below:

For more information about Integration status, please see the article on how to manage Integration Health.

Delete Integration

  If you delete an integration, it cannot be reversed! however events from the telemetry source will remain within Samurai.  However if the integration is auto-detected, it will reappear as type log if your telemetry source remains sending logs.

If you wish to delete an integration associated with a specific Collector:

1. From your Samurai MDR application select  Collectors
2. Select the relevant collector from your list
3. You will now see all integrations associated with the collector
4. Select your integrations
5. On the right hand side of the relevant integration, click on (more options) and select Delete Integration
6. The following warning will appear: 'Warning: This is a destructive action and cannot be reversed.'. To ensure you intended to delete the integration you will need to type in the highlighted 'Integration's Hostname' and select Delete Integration

You can also delete from the Integrations menu item:

1. Select Integrations in the main menu 
2. Find and select your integrated product
3. Select Delete Configuration by clicking on (more options)
4. See step 5 above!