Using the Downloads Api service collection

Table of Contents

DownloadFile

Gets pre-signed URL for the file.

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	Service	Uber	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

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
	/csdownloads/entities/files/enumerate/v1

Required Scope

Content-Type

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

Keyword Arguments

Name	Service	Uber	Type	Data type	Description
file_name			query	string	Apply filtering on file name
platform			query	string	Apply filtering on file platform
category			query	string	Apply filtering on file category
parameters			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.enumerate(file_name="string",
                            platform="string",
                            category="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(file_name="string",
                                platform="string",
                                category="string"
                                )
print(response)

Uber class example

from falconpy import APIHarnessV2

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

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