Endgame API Add-on for Splunk
Overview
Details
Endgame API Add-on for Splunk
OVERVIEW
Endgame Technology add-on (TA) enables Endgame customers to ingest alert data from the Streaming API. This TA also supports and is required for the Endgame App for Splunk.
Author - Endgame, Inc.
Version - 1.1.0
Build - 21
Creates Index - False
Splunk Enterprise version: 7.0.x, 7.1.x, 7.2.x, 7.3.x
Common Information Model: 4.13.0
OS: Platform independent
Prerequisites: None
External Data Sources
We are using Endgame API to collect information of alerts.
RELEASE NOTES
VERSION 1.1.0
- CIM Compliance
- Added support to collect data over encrypted network
- Resolved Splunk certification issues
INSTALLATION
Follow the below listed steps to install Add-on from bundle:
- Download the App package
- From the UI navigate to
Apps->Manage Apps - In the top right corner select "Install app from file"
- Select "Choose File" and select the App package
- Select "Upload" and follow the prompts.
UPGRADE
Pre-requisites
Please disable the input before upgrading TA in order to avoid data duplication. Please follow the post upgradation steps in order to avoid data duplication.
- Download the App package
- From the UI navigate to
Apps->Manage Apps - In the top right corner select "Install app from file"
- Select "Choose File" and select the App package
- Check Upgrade App
- Select "Upload" and follow the prompts.
Post upgradation steps
- After successfully upgrading the TA follow the below steps in order to avoid data duplication:
- Navigate to
$SPLUNK_HOME$/etc/apps/TA-Endgame/default.old - Move the file
alert.confto$SPLUNK_HOME$/etc/apps/TA-Endgame/local - By default, SSL Verification will be true. If you don't want to verify your SSL certificate, follow steps mentioned in Configuration steps or Add certificate by following steps mentioned in section Adding SSL Certificate
- Restart Splunk
CONFIGURATION
- After the installation you'll be asked to restart the Splunk. Click on Restart Now.
- After the restart, you need to configure the input for data collection. From the UI navigate to
Apps->Endgame API Add-on for Splunk. - Click on Create New Input. Enter the following details of your Endgame Instance and save it.
- Name: A unique name of your input.
- Interval: Data will be collected at provided time interval.
- Index: Splunk index to ingest data.
- Endgame API: Your Endgame API from which you want to collect data.
- Username: Username to access data of your endpoint.
- Password: Password to access data of your endpoint.
- By default, SSL Verification will be true. If you don't want to verify your SSL certificate, follow steps:
- Go to
$SPLUNK_HOME$/etc/apps/TA-Endgame/local. - Open
inputs.conffile and find stanza with name you have provided while creating input. - Add
verify_ssl=falsein that particular stanza. - Save the file and restart Splunk.
- Go to
- TA Endgame is configured and ready to be used.
ADDING SSL CERTIFICATE
If you have used SSL certificate for your domain, you need to add certificate into Splunk. Follow below listed steps to do the same:
- Go to
$SPLUNK_HOME$/etc/apps/TA-Endgame/bin/ta_endgame/requests/. - Open
cacert.pemfile and add your custom certificate details at the end of file. - Save the file and restart the Splunk.
Note: If your vendor has published the SSL certificate publicly, no need to add that manually.
SUPPORT
Support Offered: No
EULA
Link: https://d38o4gzaohghws.cloudfront.net/static/misc/eula.html
TROUBLESHOOTING
- No logs coming to Splunk : Recheck the credentials and run the following query to see whether logs are ingested or not:
index="*" sourcetype="endgameapi" - For logs please go to SPLUNK_HOME/var/log/splunk/TA-Endgame.log
Release Notes
Version 1.2.1
Version Requires Endgame Platform 3.17.x or greater
- Updated application to leverage indexed_to and indexed_from API parameters
- Added Accounts Configuration Tab
Version 1.1.0
Endgame Technology add-on (TA) enables Endgame customers to ingest alert data from the Streaming API. This TA also supports and is required for the Endgame App for Splunk.
Author - Endgame, Inc.
Version - 1.1.0
Build - 21
Creates Index - False
Splunk Enterprise version: 7.0.x, 7.1.x, 7.2.x, 7.3.x
Common Information Model: 4.13.0
OS: Platform independent
Prerequisites: None