Downloads - CrowdStrike/falconpy GitHub Wiki

CrowdStrike Falcon CrowdStrike Subreddit

Using the Downloads Api service collection

Uber class support Service class support Documentation Version Page Updated

Table of Contents

Operation ID Description
DownloadFile
PEP8 download
Gets pre-signed URL for the file.
EnumerateFile
PEP8 enumerate
Enumerates a list of files available for CID.

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.

DownloadFile

Gets pre-signed URL for the file.

PEP8 method name

download

Endpoint

Method Route
GET /csdownloads/entities/files/download/v1

Required Scope

infrastructure-as-code:read

Content-Type

  • Consumes: application/json
  • Produces: application/json

Keyword Arguments

Name Service Uber Type Data type Description
file_name Service Class Support Uber Class Support query string Name of the file to be downloaded
file_version Service Class Support Uber Class Support query string Version of the file to be downloaded
parameters Service Class Support Uber Class Support query dictionary Full query string parameters payload in JSON format.

Usage

Service class example (PEP8 syntax)
from falconpy import Downloads

falcon = Downloads(client_id=CLIENT_ID,
                   client_secret=CLIENT_SECRET
                   )

response = falcon.download(file_name="string", file_version="string")
print(response)
Service class example (Operation ID syntax)
from falconpy import Downloads

falcon = Downloads(client_id=CLIENT_ID,
                   client_secret=CLIENT_SECRET
                   )

response = falcon.DownloadFile(file_name="string", file_version="string")
print(response)
Uber class example
from falconpy import APIHarnessV2

falcon = APIHarnessV2(client_id=CLIENT_ID,
                      client_secret=CLIENT_SECRET
                      )

response = falcon.command("DownloadFile", file_name="string", file_version="string")
print(response)

EnumerateFile

Enumerates a list of files available for CID

PEP8 method name

enumerate

Endpoint

Method Route
GET /csdownloads/entities/files/enumerate/v1

Required Scope

infrastructure-as-code:read

Content-Type

  • Consumes: application/json
  • Produces: application/json

Keyword Arguments

Name Service Uber Type Data type Description
arch Service Class Support Uber Class Support query string Apply filtering on system architecture
category Service Class Support Uber Class Support query string Apply filtering on file category
file_name Service Class Support Uber Class Support query string Apply filtering on file name
file_version Service Class Support Uber Class Support query string Apply filtering on file version
os Service Class Support Uber Class Support query string Apply filtering on operating system
parameters Service Class Support Uber Class Support query dictionary Full query string parameters payload in JSON format.
platform Service Class Support Uber Class Support query string Apply filtering on file platform

Usage

Service class example (PEP8 syntax)
from falconpy import Downloads

falcon = Downloads(client_id=CLIENT_ID,
                   client_secret=CLIENT_SECRET
                   )

response = falcon.enumerate(arch="string",
                            category="string",
                            file_name="string",
                            file_version="string",
                            os="string",
                            platform="string"
                            )
print(response)
Service class example (Operation ID syntax)
from falconpy import Downloads

falcon = Downloads(client_id=CLIENT_ID,
                   client_secret=CLIENT_SECRET
                   )

response = falcon.EnumerateFile(arch="string",
                                category="string",
                                file_name="string",
                                file_version="string",
                                os="string",
                                platform="string"
                                )
print(response)
Uber class example
from falconpy import APIHarnessV2

falcon = APIHarnessV2(client_id=CLIENT_ID,
                      client_secret=CLIENT_SECRET
                      )

response = falcon.command("EnumerateFile",
                          arch="string",
                          category="string",
                          file_name="string",
                          file_version="string",
                          os="string",
                          platform="string"
                          )
print(response)

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