Using the Downloads API service collection

Documentation Version

Operation ID

Description

DownloadFile
PEP 8	download

Gets pre-signed URL for the file.

EnumerateFile
PEP 8	enumerate

Enumerates a list of files available for CID.

FetchFilesDownloadInfo
PEP 8	fetch_download_info

Get files info and pre-signed download URLs

FetchFilesDownloadInfoV2
PEP 8	fetch_download_info_v2

Get cloud security tools info and pre-signed download URLs

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.

Deprecated operation

This operation has been deprecated in favor of the FetchFilesDownloadInfo operation. Developers should move code over to this new operation as soon as time permits.

PEP8 method name

download

Endpoint

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

Required Scope

Content-Type

Consumes: application/json
Produces: application/json

Keyword Arguments

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

Usage

Service class example (PEP8 syntax)

from falconpy import Downloads

# Do not hardcode API credentials!
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

# Do not hardcode API credentials!
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

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

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

Back to Table of Contents

EnumerateFile

Enumerates a list of files available for CID

Deprecated operation

This operation has been deprecated in favor of the FetchFilesDownloadInfo operation. Developers should move code over to this new operation as soon as time permits.

PEP8 method name

enumerate

Endpoint

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

Required Scope

Content-Type

Consumes: application/json
Produces: application/json

Keyword Arguments

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

Usage

Service class example (PEP8 syntax)

from falconpy import Downloads

# Do not hardcode API credentials!
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

# Do not hardcode API credentials!
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

# Do not hardcode API credentials!
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)

Back to Table of Contents

FetchFilesDownloadInfo

Get files info and pre-signed download URLs

PEP8 method name

fetch_download_info

Endpoint

Method	Route
	`/csdownloads/combined/files-download/v1`

Required Scope

Content-Type

Produces: application/json

Keyword Arguments

Name	Type	Data type	Description
filter	query	string	Search files using various filters using query in Falcon Query Language (FQL). Supported filters: arch,category,file_name,file_version,os
parameters	query	dictionary	Full query string parameters payload in JSON format.
sort	query	string	The fields to sort records on. Supported columns: arch category file_name file_version os

Usage

Service class example (PEP8 syntax)

from falconpy import Downloads

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

response = falcon.fetch_download_info(filter="string",
                                      sort="string"
                                      )
print(response)

Service class example (Operation ID syntax)

from falconpy import Downloads

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

response = falcon.FetchFilesDownloadInfo(filter="string",
                                         sort="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("FetchFilesDownloadInfo",
                          filter="string",
                          sort="string"
                          )
print(response)

Back to Table of Contents

FetchFilesDownloadInfoV2

Get cloud security tools info and pre-signed download URLs

PEP8 method name

fetch_download_info_v2

Endpoint

Method	Route
	`/csdownloads/combined/files-download/v2`

Required Scope

Content-Type

Produces: application/json

Keyword Arguments

Name	Type	Data type	Description
filter	query	string	Search files using various filters. Supported filters: arch,category,file_name,file_version,os
limit	query	integer	The upper-bound on the number of records to retrieve. Maximum limit: 100.
offset	query	integer	The offset from where to begin. Maximum offset = 1000 - limit.
parameters	query	dictionary	Full query string parameters payload in JSON format.
sort	query	string	The fields to sort records on. Supported columns: arch category file_name file_version os

Usage

Service class example (PEP8 syntax)

from falconpy import Downloads

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

response = falcon.fetch_download_info_v2(filter="string",
                                         limit=integer,
                                         offset=integer,
                                         sort="string"
                                         )
print(response)

Service class example (Operation ID syntax)

from falconpy import Downloads

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

response = falcon.FetchFilesDownloadInfoV2(filter="string",
                                           limit=integer,
                                           offset=integer,
                                           sort="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("FetchFilesDownloadInfoV2",
                          filter="string",
                          limit=integer,
                          offset=integer,
                          sort="string"
                          )
print(response)

Back to Table of Contents

The CrowdStrike Falcon Wiki for Python