ThreatFox Feed

ThreatFox is a free platform from abuse.ch with the goal of sharing indicators of compromise (IOCs) associated with malware. Use the ThreatFox Feed integration to fetch indicators from the feed.

Data Enrichment & Threat Intelligence · ThreatFox Feed · Feed

Details

ID	`ThreatFox Feed`
Provider	AbuseCh
Category	Data Enrichment & Threat Intelligence
From Version	6.10.0
Docker Image	`demisto/python3:3.12.13.10399583`
Supported Modules	Agentix XSIAM

README

ThreatFox is a platform from abuse.ch and Spamhaus dedicated to sharing indicators of compromise (IOCs) associated with malware, with the infosec community, AV vendors and cyber threat intelligence providers.
For more information visit: https://threatfox.abuse.ch/

Create an Auth Key for abuse.ch

Note: If you already have a profile, you can skip steps 1 and 2.

Sign up for an abuse.ch account. You can do this easily by using an existing account that you may already have on X, LinkedIn, Google or Github. Just log in with the authentication provider of your choice here: https://auth.abuse.ch/
Once you are authenticated on abuse.ch, ensure that you connect at least one additional authentication provider. This will ensure that you have access to abuse.ch platforms, even if one of the authentication providers you use shuts down (yes, it happened with Twitter!)
Ensure that you hit the “Save profile” button. In the “Optional” section, you can now generate an “Auth-Key”. This is your personal Auth-Key that you can now use in the integration.

Configure ThreatFox Feed in Cortex

Parameter	Description	Required
Server URL		True
Auth Key	Auth Key for authentication with abuse.ch	True
Use system proxy settings		False
Trust any certificate (not secure)		False
Fetch indicators		False
Source Reliability	Reliability of the source providing the intelligence data.	True
Indicator Reputation	Indicators from this integration instance will be marked with this reputation.	False
Traffic Light Protocol Color	The Traffic Light Protocol (TLP) designation to apply to indicators fetched from the feed.	False
Indicator Expiration Method	The method to be used to expire indicators from this feed. Default: indicatorType	False
Bypass exclusion list	When 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
Feed Fetch Interval (in days)		False
Return IOCs with Ports	If selected, IP indicators will include a tag with the port value	False
Confidence Threshold		False
Create relationship	If selected, indicators will be created with relationships	False

Commands

You can execute these commands from the 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.

threatfox-get-indicators

Retrieves indicators from the ThreatFox API.

Base Command

threatfox-get-indicators

Input

Argument Name	Description	Required
search_term	Indicator value to search for	Optional
id	Indicator ID to search for.	Optional
hash	Hash to search for.	Optional
tag	Tag to search by. For available tag options, please refer to the API documentation- https://threatfox.abuse.ch/api/.	Optional
malware	Malware to search by. For available malware options, please refer to the API documentation- https://threatfox.abuse.ch/api/.	Optional
limit	Maximum indicators to search for. Available only when searching by ‘malware’ or ‘tag’. Default is 50. Max is 1000.	Optional

Context Output

There is no context output for this command.

Create an API Key

Sign up for an abuse.ch account by using an existing account that you may already have on X, LinkedIn, Google or Github. Just log in with the authentication provider of your choice here: https://auth.abuse.ch/
Once you’ve logged in to abuse.ch, add at least one more way to log in. This helps ensure you can always access abuse.ch platforms, even if one of your login methods stops working.
Click the Save profile button. In the Optional section, you can now create an Auth-Key. This is your personal authentication key that you can use to query any abuse.ch APIs.

If you already have a profile, you only need to follow step 3. There’s nothing further to do for your authentication set up.

Configuration parameters

feed — Fetch indicators
url — Server URL (required)
credentials —
feedReputation — Indicator Reputation
feedReliability — Source Reliability (required)
confidence_threshold — Confidence Threshold
tlp_color — Traffic Light Protocol Color
feedExpirationPolicy —
feedExpirationInterval —
feedFetchInterval — Feed Fetch Interval
with_ports — Return IOCs with Ports
create_relationship — Create relationship
feedBypassExclusionList — Bypass exclusion list
proxy — Use system proxy settings
insecure — Trust any certificate (not secure)
feedTags — Tags

Commands (1)

threatfox-get-indicators
Retrieves indicators from the ThreatFox API. Choose one field to search by.

Source

FeedThreatFox.py FeedThreatFox_test.py FeedThreatFox.yml FeedThreatFox_description.md

Download History Raw

category: Data Enrichment & Threat Intelligence
provider: AbuseCh
sectionorder:
- Connect
- Collect
commonfields:
  id: ThreatFox Feed
  version: -1
configuration:
- display: Fetch indicators
  name: feed
  defaultvalue: 'true'
  type: 8
  required: false
  section: Collect
- defaultvalue: https://threatfox-api.abuse.ch/
  display: Server URL
  name: url
  required: true
  type: 0
  section: Connect
- displaypassword: Auth Key
  hiddenusername: true
  name: credentials
  type: 9
  section: Connect
  required: false
  additionalinfo: Starting June 30th 2025 this parameter is mandatory.
- display: Indicator Reputation
  name: feedReputation
  defaultvalue: Bad
  type: 18
  required: false
  section: Collect
  options:
  - None
  - Good
  - Suspicious
  - Bad
  additionalinfo: Indicators from this integration instance will be marked with this reputation.
- additionalinfo: Reliability of the source providing the intelligence data.
  defaultvalue: C - Fairly reliable
  display: Source Reliability
  name: feedReliability
  type: 15
  section: Collect
  options:
  - A - Completely reliable
  - B - Usually reliable
  - C - Fairly reliable
  - D - Not usually reliable
  - E - Unreliable
  - F - Reliability cannot be judged
  required: true
- display: Confidence Threshold
  name: confidence_threshold
  required: false
  defaultvalue: '75'
  section: Collect
  type: 0
  advanced: true
  additionalinfo: If the indicator's confidence is below this number, it will be dropped.
- additionalinfo: The Traffic Light Protocol (TLP) designation to apply to indicators fetched from the feed.
  display: Traffic Light Protocol Color
  name: tlp_color
  options:
  - RED
  - AMBER
  - GREEN
  - WHITE
  type: 15
  defaultvalue: WHITE
  required: false
  section: Collect
  advanced: true
- display: ""
  name: feedExpirationPolicy
  defaultvalue: indicatorType
  type: 17
  required: false
  section: Collect
  options:
  - never
  - interval
  - indicatorType
  - suddenDeath
- display: ""
  name: feedExpirationInterval
  defaultvalue: "20160"
  type: 1
  required: false
  section: Collect
- display: Feed Fetch Interval
  name: feedFetchInterval
  required: false
  defaultvalue: 1440
  section: Collect
  advanced: true
  type: 19
  additionalinfo: Must be whole day. Min is 1. Max is 7.
- display: Return IOCs with Ports
  name: with_ports
  required: false
  defaultvalue: 'false'
  section: Collect
  advanced: true
  type: 8
  additionalinfo: If selected, IP indicators will include a tag with the port value.
- display: Create relationship
  name: create_relationship
  required: false
  defaultvalue: 'false'
  section: Collect
  advanced: true
  type: 8
  additionalinfo: If selected, indicators will be created with relationships.
- display: Bypass exclusion list
  name: feedBypassExclusionList
  defaultvalue: 'false'
  type: 8
  required: false
  section: Collect
  additionalinfo: When 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.
- display: Use system proxy settings
  name: proxy
  type: 8
  required: false
  section: Connect
- display: Trust any certificate (not secure)
  name: insecure
  type: 8
  required: false
  section: Connect
- name: feedTags
  display: Tags
  type: 0
  section: Collect
  additionalinfo: Supports CSV values.
description: ThreatFox is a free platform from abuse.ch with the goal of sharing indicators of compromise (IOCs) associated with malware. Use the ThreatFox Feed integration to fetch indicators from the feed.
display: ThreatFox Feed
name: ThreatFox Feed
script:
  commands:
  - arguments:
    - description: Indicator value to search by.
      name: search_term
      required: false
    - description: Indicator ID to search by.
      name: id
      required: false
    - description: Hash to search by.
      name: hash
      required: false
    - description: Tag to search by. For available tag options, please refer to the API documentation- https://threatfox.abuse.ch/api/.
      name: tag
      required: false
    - description: Malware to search by. For available malware options, please refer to the API documentation- https://threatfox.abuse.ch/api/.
      name: malware
      required: false
    - description: Maximum indicators to search for. Available only when searching by 'malware' or 'tag'. Max is 1000.
      name: limit
      required: false
      defaultValue: '50'
    description: Retrieves indicators from the ThreatFox API. Choose one field to search by.
    name: threatfox-get-indicators
  feed: true
  runonce: false
  script: ''
  type: python
  subtype: python3
  dockerimage: demisto/python3:3.12.13.10399583
fromversion: 6.10.0
tests:
- No tests (auto formatted)