Intelligence Feeds - CrowdStrike/falconpy GitHub Wiki

CrowdStrike Falcon CrowdStrike Subreddit

Using the Intelligence Feeds service collection

Uber class support Service class support Documentation Version Page Updated

Table of Contents

Operation ID Description
DownloadFeedArchive
PEP 8 download_feed
Download feed file contents as a zip archive.
ListFeedTypes
PEP 8 list_feeds
List the accessible feeds for a given customer.
QueryFeedArchives
PEP 8 query_feeds
Query the accessible feeds for a customer.

Passing credentials

WARNING

client_id and client_secret are keyword arguments that contain your CrowdStrike API credentials. Please note that all examples below do not hard code these values. (These values are ingested as strings.)

CrowdStrike does not recommend hard coding API credentials or customer identifiers within source code.

DownloadFeedArchive

Download feed file contents as a zip archive.

PEP8 method name

download_feed

Endpoint

Method Route
GET /indicator-feed/entities/feed-download/v1

Required Scope

indicator-graph:read

Content-Type

  • Produces: application/json

Keyword Arguments

Name Service Uber Type Data type Description
feed_item_id
Service Class Support
Uber Class Support
 query string Feed object reference ID.
parameters
Service Class Support
Uber Class Support
 query dictionary Full query parameters payload as a dictionary, not required when using other keywords.
stream
Service Class Support
Uber Class Support
 query boolean Enable streaming download of the returned file.

Usage

Service class example (PEP8 syntax)
from falconpy import IntelligenceFeeds

# Do not hardcode API credentials!
falcon = IntelligenceFeeds(client_id=CLIENT_ID_HERE,
                           client_secret=CLIENT_SECRET
                           )

response = falcon.device_enroll(feed_item_id="string", stream=boolean)

print(response)
Service class example (Operation ID syntax)
from falconpy import IntelligenceFeeds

# Do not hardcode API credentials!
falcon = IntelligenceFeeds(client_id=CLIENT_ID_HERE,
                           client_secret=CLIENT_SECRET
                           )

response = falcon.DownloadFeedArchive(feed_item_id="string", stream=boolean)

print(response)
Uber class example
from falconpy import APIHarnessV2

# Do not hardcode API credentials!
falcon = APIHarnessV2(client_id=CLIENT_ID,
                      client_secret=CLIENT_SECRET
                      )

response = falcon.command("DownloadFeedArchive", feed_item_id="string", stream=boolean)

print(response)

ListFeedTypes

List the accessible feeds for a given customer.

PEP8 method name

list_feeds

Endpoint

Method Route
GET /indicator-feed/entities/feed/v1

Required Scope

indicator-graph:read

Content-Type

  • Produces: application/json

Keyword Arguments

No keywords or arguments accepted.

Usage

Service class example (PEP8 syntax)
from falconpy import IntelligenceFeeds

# Do not hardcode API credentials!
falcon = IntelligenceFeeds(client_id=CLIENT_ID_HERE,
                           client_secret=CLIENT_SECRET
                           )

response = falcon.list_feeds()

print(response)
Service class example (Operation ID syntax)
from falconpy import IntelligenceFeeds

# Do not hardcode API credentials!
falcon = IntelligenceFeeds(client_id=CLIENT_ID_HERE,
                           client_secret=CLIENT_SECRET
                           )

response = falcon.ListFeedTypes()

print(response)
Uber class example
from falconpy import APIHarnessV2

# Do not hardcode API credentials!
falcon = APIHarnessV2(client_id=CLIENT_ID,
                      client_secret=CLIENT_SECRET
                      )

response = falcon.command("ListFeedTypes")

print(response)

QueryFeedArchives

Query the accessible feeds for a customer.

PEP8 method name

query_feeds

Endpoint

Method Route
GET /indicator-feed/queries/feed/v1

Required Scope

indicator-graph:read

Content-Type

  • Produces: application/json

Keyword Arguments

Name Service Uber Type Data type Description
feed_name
Service Class Support
Uber Class Support
 query string Feed name.
feed_interval
Service Class Support
Uber Class Support
 query string Feed interval.
Allowed values: dump, daily, hourly, minutely.
since
Service Class Support
Uber Class Support
 query string Valid timestamp in RFC3399 format.
Restrictions:
  • Minutely: now()-2h
  • Hourly: now()-2d
  • Daily: now()-5d
  • Dump: now()-7d
parameters
Service Class Support
Uber Class Support
 query dictionary Full query parameters payload as a dictionary, not required when using other keywords.

Usage

Service class example (PEP8 syntax)
from falconpy import IntelligenceFeeds

# Do not hardcode API credentials!
falcon = IntelligenceFeeds(client_id=CLIENT_ID_HERE,
                           client_secret=CLIENT_SECRET
                           )

response = falcon.query_feeds(feed_name="string", feed_interval="string", since="string")

print(response)
Service class example (Operation ID syntax)
from falconpy import IntelligenceFeeds

# Do not hardcode API credentials!
falcon = IntelligenceFeeds(client_id=CLIENT_ID_HERE,
                           client_secret=CLIENT_SECRET
                           )

response = falcon.QueryFeedArchives(feed_name="string", feed_interval="string", since="string")

print(response)
Uber class example
from falconpy import APIHarnessV2

# Do not hardcode API credentials!
falcon = APIHarnessV2(client_id=CLIENT_ID,
                      client_secret=CLIENT_SECRET
                      )

response = falcon.command("QueryFeedArchives",
                          feed_name="string",
                          feed_interval="string",
                          since="string"
                          )

print(response)

⚠️ **GitHub.com Fallback** ⚠️