Falconx Sandbox

Using the FalconX Sandbox service collection

Uber class support

API Function	Description
GetArtifacts	Download IOC packs, PCAP files, and other analysis artifacts.
GetSummaryReports	Get a short summary version of a sandbox report.
GetReports	Get a full sandbox report.
DeleteReport	Delete report based on the report ID. Operation can be checked for success by polling for the report ID on the report-summaries endpoint.
GetSubmissions	Check the status of a sandbox analysis. Time required for analysis varies but is usually less than 15 minutes.
Submit	Submit an uploaded file or a URL for sandbox analysis. Time required for analysis varies but is usually less than 15 minutes.
QueryReports	Find sandbox reports by providing an FQL filter and paging details. Returns a set of report IDs that match your criteria.
QuerySubmissions	Find submission IDs for uploaded files by providing an FQL filter and paging details. Returns a set of submission IDs that match your criteria.
GetSampleV2	Retrieves the file associated with the given ID (SHA256)
UploadSampleV2	Upload a file for sandbox analysis. After uploading, use `/falconx/entities/submissions/v1` to start analyzing the file.
DeleteSampleV2	Removes a sample, including file, meta and submissions from the collection
QuerySampleV1	Retrieves a list with sha256 of samples that exist and customer has rights to access them, maximum number of accepted items is 200

GetArtifacts

Download IOC packs, PCAP files, and other analysis artifacts.

Parameters

Required	Name	Type	Datatype	Description
✅	id	query	string	ID of an artifact, such as an IOC pack, PCAP file, or actor image. Find an artifact ID in a report or summary.
	name	query	string	The name given to your downloaded file.
	Accept-Encoding	header	string	Format used to compress your downloaded file. Currently, you must provide the value `gzip`, the only valid format.

Usage

Service class example

from falconpy import falconx_sandbox as FalconX

falcon = FalconX.FalconX_Sandbox(creds={
     'client_id': falcon_client_id,
     'client_secret': falcon_client_secret
})

PARAMS = {
    'id': 'string',
    'name': 'string'
}

HEADERS = {
    'Accept-Encoding': 'string'
}

response = falcon.GetArtifacts(parameters=PARAMS, headers=HEADERS)
print(response)

Uber class example

from falconpy import api_complete as FalconSDK

falcon = FalconSDK.APIHarness(creds={
      'client_id': falcon_client_id,
      'client_secret': falcon_client_secret
   }
)

PARAMS = {
    'id': 'string',
    'name': 'string'
}

HEADERS = {
    'Accept-Encoding': 'string'
}

response = falcon.command('GetArtifacts', parameters=PARAMS, headers=HEADERS)
print(response)
falcon.deauthenticate()

GetSummaryReports

Get a short summary version of a sandbox report.

Content-Type

Produces: application/json

Parameters

Required	Name	Type	Datatype	Description
✅	ids	query	array (string)	ID of a summary. Find a summary ID from the response when submitting a malware sample or search with `/falconx/queries/reports/v1`.

Usage

Service class example

from falconpy import falconx_sandbox as FalconX

falcon = FalconX.FalconX_Sandbox(creds={
     'client_id': falcon_client_id,
     'client_secret': falcon_client_secret
})

IDS = 'ID1,ID2,ID3'

response = falcon.GetSummaryReports(ids=IDS)
print(response)

Uber class example

from falconpy import api_complete as FalconSDK

falcon = FalconSDK.APIHarness(creds={
      'client_id': falcon_client_id,
      'client_secret': falcon_client_secret
   }
)

IDS = 'ID1,ID2,ID3'

response = falcon.command('GetSummaryReports', ids=IDS)
print(response)
falcon.deauthenticate()

GetReports

Get a full sandbox report.

Content-Type

Produces: application/json

Parameters

Required	Name	Type	Datatype	Description
✅	ids	query	array (string)	ID of a report. Find a report ID from the response when submitting a malware sample or search with `/falconx/queries/reports/v1`.

Usage

Service class example

from falconpy import falconx_sandbox as FalconX

falcon = FalconX.FalconX_Sandbox(creds={
     'client_id': falcon_client_id,
     'client_secret': falcon_client_secret
})

IDS = 'ID1,ID2,ID3'

response = falcon.GetReports(ids=IDS)
print(response)

Uber class example

from falconpy import api_complete as FalconSDK

falcon = FalconSDK.APIHarness(creds={
      'client_id': falcon_client_id,
      'client_secret': falcon_client_secret
   }
)

IDS = 'ID1,ID2,ID3'

response = falcon.command('GetReports', ids=IDS)
print(response)
falcon.deauthenticate()

DeleteReport

Delete report based on the report ID. Operation can be checked for success by polling for the report ID on the report-summaries endpoint.

Content-Type

Produces: application/json

Parameters

Required	Name	Type	Datatype	Description
✅	ids	query	string	ID of a report.

Usage

Service class example

from falconpy import falconx_sandbox as FalconX

falcon = FalconX.FalconX_Sandbox(creds={
     'client_id': falcon_client_id,
     'client_secret': falcon_client_secret
})

IDS = 'ID1,ID2,ID3'

response = falcon.DeleteReport(ids=IDS)
print(response)

Uber class example

from falconpy import api_complete as FalconSDK

falcon = FalconSDK.APIHarness(creds={
      'client_id': falcon_client_id,
      'client_secret': falcon_client_secret
   }
)

IDS = 'ID1,ID2,ID3'

response = falcon.command('DeleteReport', ids=IDS)
print(response)
falcon.deauthenticate()

GetSubmissions

Check the status of a sandbox analysis. Time required for analysis varies but is usually less than 15 minutes.

Content-Type

Produces: application/json

Parameters

Required	Name	Type	Datatype	Description
✅	ids	query	array (string)	ID of a submitted malware sample. Find a submission ID from the response when submitting a malware sample or search with `/falconx/queries/submissions/v1`.

Usage

Service class example

from falconpy import falconx_sandbox as FalconX

falcon = FalconX.FalconX_Sandbox(creds={
     'client_id': falcon_client_id,
     'client_secret': falcon_client_secret
})

IDS = 'ID1,ID2,ID3'

response = falcon.GetSubmissions(ids=IDS)
print(response)

Uber class example

from falconpy import api_complete as FalconSDK

falcon = FalconSDK.APIHarness(creds={
      'client_id': falcon_client_id,
      'client_secret': falcon_client_secret
   }
)

IDS = 'ID1,ID2,ID3'

response = falcon.command('GetSubmissions', ids=IDS)
print(response)
falcon.deauthenticate()

Submit

Submit an uploaded file or a URL for sandbox analysis. Time required for analysis varies but is usually less than 15 minutes.

Content-Type

Produces: application/json

Parameters

Required	Name	Type	Datatype	Description
✅	body	body	string	Submit either a URL or a sample SHA256 for sandbox analysis. The sample file must have been previously uploaded through `/samples/entities/samples/v2`. You must specify a JSON object that includes the `falconx.SubmissionParametersV1` key/value pairs shown below. `environment_id`: Specifies the sandbox environment used for analysis. Values: - `300`: Linux Ubuntu 16.04, 64-bit - `200`: Android (static analysis) - `160`: Windows 10, 64-bit - `110`: Windows 7, 64-bit - `100`: Windows 7, 32-bit `sha256` ID of the sample, which is a SHA256 hash value. Find a sample ID from the response when uploading a malware sample or search with `/falconx/queries/submissions/v1`.The `url` parameter must be unset if `sha256` is used. `url` A web page or file URL. It can be HTTP(S) or FTP. The `sha256` parameter must be unset if `url` is used. `action_script` (optional): Runtime script for sandbox analysis. Values: - `default` - `default_maxantievasion` - `default_randomfiles` - `default_randomtheme` - `default_openie` `command_line` (optional): Command line script passed to the submitted file at runtime. Max length: 2048 characters `document_password` (optional): Auto-filled for Adobe or Office files that prompt for a password. Max length: 32 characters `enable_tor` (optional): If `true`, sandbox analysis routes network traffic via TOR. Default: `false`. `submit_name` (optional): Name of the malware sample that's used for file type detection and analysis `system_date` (optional): Set a custom date in the format `yyyy-MM-dd` for the sandbox environment `system_time` (optional): Set a custom time in the format `HH:mm` for the sandbox environment.

Usage

Service class example

from falconpy import falconx_sandbox as FalconX

falcon = FalconX.FalconX_Sandbox(creds={
     'client_id': falcon_client_id,
     'client_secret': falcon_client_secret
})

BODY = {
    'Body Payload': 'See body description above'
}

response = falcon.Submit(body=BODY)
print(response)

Uber class example

from falconpy import api_complete as FalconSDK

falcon = FalconSDK.APIHarness(creds={
      'client_id': falcon_client_id,
      'client_secret': falcon_client_secret
   }
)

BODY = {
    'Body Payload': 'See body description above'
}

response = falcon.command('Submit', body=BODY)
print(response)
falcon.deauthenticate()

QueryReports

Find sandbox reports by providing an FQL filter and paging details. Returns a set of report IDs that match your criteria.

Content-Type

Produces: application/json

Parameters

Name	Type	Datatype	Description
filter	query	string	Optional filter and sort criteria in the form of an FQL query. For more information about FQL queries, see our FQL documentation in Falcon.
offset	query	string	The offset to start retrieving reports from.
limit	query	integer	Maximum number of report IDs to return. Max: 5000.
sort	query	string	Sort order: `asc` or `desc`.

Usage

Service class example

from falconpy import falconx_sandbox as FalconX

falcon = FalconX.FalconX_Sandbox(creds={
     'client_id': falcon_client_id,
     'client_secret': falcon_client_secret
})

PARAMS = {
    'filter': 'string',
    'offset': 'string',
    'limit': integer,
    'sort': 'string'
}

response = falcon.QueryReports(parameters=PARAMS)
print(response)

Uber class example

from falconpy import api_complete as FalconSDK

falcon = FalconSDK.APIHarness(creds={
      'client_id': falcon_client_id,
      'client_secret': falcon_client_secret
   }
)

PARAMS = {
    'filter': 'string',
    'offset': 'string',
    'limit': integer,
    'sort': 'string'
}

response = falcon.command('QueryReports', parameters=PARAMS)
print(response)
falcon.deauthenticate()

QuerySubmissions

Find submission IDs for uploaded files by providing an FQL filter and paging details. Returns a set of submission IDs that match your criteria.

Content-Type

Produces: application/json

Parameters

Name	Type	Datatype	Description
filter	query	string	Optional filter and sort criteria in the form of an FQL query. For more information about FQL queries, see our FQL documentation in Falcon.
offset	query	string	The offset to start retrieving submissions from.
limit	query	integer	Maximum number of submission IDs to return. Max: 5000.
sort	query	string	Sort order: `asc` or `desc`.

Usage

Service class example

from falconpy import falconx_sandbox as FalconX

falcon = FalconX.FalconX_Sandbox(creds={
     'client_id': falcon_client_id,
     'client_secret': falcon_client_secret
})

PARAMS = {
    'filter': 'string',
    'offset': 'string',
    'limit': integer,
    'sort': 'string'
}

response = falcon.QuerySubmissions(parameters=PARAMS)
print(response)

Uber class example

from falconpy import api_complete as FalconSDK

falcon = FalconSDK.APIHarness(creds={
      'client_id': falcon_client_id,
      'client_secret': falcon_client_secret
   }
)

PARAMS = {
    'filter': 'string',
    'offset': 'string',
    'limit': integer,
    'sort': 'string'
}

response = falcon.command('QuerySubmissions', parameters=PARAMS)
print(response)
falcon.deauthenticate()

GetSampleV2

Retrieves the file associated with the given ID (SHA256)

Content-Type

Produces: application/octet-stream

Parameters

Required	Name	Type	Datatype	Description
	X-CS-USERUUID	header	string	User UUID
✅	ids	query	string	The file SHA256.
	password_protected	query	string	Flag whether the sample should be zipped and password protected with pass='infected'

Usage

Service class example

from falconpy import falconx_sandbox as FalconX

falcon = FalconX.FalconX_Sandbox(creds={
     'client_id': falcon_client_id,
     'client_secret': falcon_client_secret
})

PARAMS = {
    'password_protected': 'string'
}

HEADERS = {
    'X-CS-USERUUID': 'string'
}

IDS = 'ID1,ID2,ID3'

response = falcon.GetSampleV2(parameters=PARAMS, headers=HEADERS, ids=IDS)
print(response)

Uber class example

from falconpy import api_complete as FalconSDK

falcon = FalconSDK.APIHarness(creds={
      'client_id': falcon_client_id,
      'client_secret': falcon_client_secret
   }
)

PARAMS = {
    'password_protected': 'string'
}

HEADERS = {
    'X-CS-USERUUID': 'string'
}

IDS = 'ID1,ID2,ID3'

response = falcon.command('GetSampleV2', parameters=PARAMS, headers=HEADERS, ids=IDS)
print(response)
falcon.deauthenticate()

UploadSampleV2

Upload a file for sandbox analysis. After uploading, use /falconx/entities/submissions/v1 to start analyzing the file.

Content-Type

Consumes: application/octet-stream
Produces: application/json

Parameters

Required	Name	Type	Datatype	Description
	X-CS-USERUUID	header	string	User UUID
✅	body	body	string	Content of the uploaded sample in binary format. For example, use `--data-binary @$FILE_PATH` when using cURL. Max file size: 100 MB. Accepted file formats: - Portable executables: `.exe`, `.scr`, `.pif`, `.dll`, `.com`, `.cpl`, etc. - Office documents: `.doc`, `.docx`, `.ppt`, `.pps`, `.pptx`, `.ppsx`, `.xls`, `.xlsx`, `.rtf`, `.pub` - PDF - APK - Executable JAR - Windows script component: `.sct` - Windows shortcut: `.lnk` - Windows help: `.chm` - HTML application: `.hta` - Windows script file: `.wsf` - Javascript: `.js` - Visual Basic: `.vbs`, `.vbe` - Shockwave Flash: `.swf` - Perl: `.pl` - Powershell: `.ps1`, `.psd1`, `.psm1` - Scalable vector graphics: `.svg` - Python: `.py` - Linux ELF executables - Email files: MIME RFC 822 `.eml`, Outlook `.msg`.
✅	upfile	formData	file	The binary file.
✅	file_name	query	string	Name of the file.
	comment	query	string	A descriptive comment to identify the file for other users.
	is_confidential	query	boolean	Defines visibility of this file in Falcon MalQuery, either via the API or the Falcon console. - `true`: File is only shown to users within your customer account - `false`: File can be seen by other CrowdStrike customers Default: `true`.

Usage

Service class example

from falconpy import falconx_sandbox as FalconX

falcon = FalconX.FalconX_Sandbox(creds={
     'client_id': falcon_client_id,
     'client_secret': falcon_client_secret
})

PARAMS = {
    'file_name': 'string',
    'comment': 'string',
    'is_confidential': boolean
}

BODY = {
    'Body Payload': 'See body description above'
}

FILENAME = 'testfile.jpg'
PAYLOAD = open(FILENAME, 'rb').read()

HEADERS = {
    'X-CS-USERUUID': 'string'
}

response = falcon.UploadSampleV2(parameters=PARAMS, body=BODY, data=PAYLOAD, file_name=FILENAME, content_type='application/octet-stream', headers=HEADERS)
print(response)

Uber class example

from falconpy import api_complete as FalconSDK

falcon = FalconSDK.APIHarness(creds={
      'client_id': falcon_client_id,
      'client_secret': falcon_client_secret
   }
)

PARAMS = {
    'file_name': 'string',
    'comment': 'string',
    'is_confidential': boolean
}

BODY = {
    'Body Payload': 'See body description above'
}

FILENAME = 'testfile.jpg'
PAYLOAD = open(FILENAME, 'rb').read()

HEADERS = {
    'X-CS-USERUUID': 'string'
}

response = falcon.command('UploadSampleV2', parameters=PARAMS, body=BODY, data=PAYLOAD, file_name=FILENAME, content_type='application/octet-stream', headers=HEADERS)
print(response)
falcon.deauthenticate()

DeleteSampleV2

Removes a sample, including file, meta and submissions from the collection

Content-Type

Produces: application/json

Parameters

Required	Name	Type	Datatype	Description
	X-CS-USERUUID	header	string	User UUID
✅	ids	query	string	The file SHA256.

Usage

Service class example

from falconpy import falconx_sandbox as FalconX

falcon = FalconX.FalconX_Sandbox(creds={
     'client_id': falcon_client_id,
     'client_secret': falcon_client_secret
})

HEADERS = {
    'X-CS-USERUUID': 'string'
}

IDS = 'ID1,ID2,ID3'

response = falcon.DeleteSampleV2(headers=HEADERS, ids=IDS)
print(response)

Uber class example

from falconpy import api_complete as FalconSDK

falcon = FalconSDK.APIHarness(creds={
      'client_id': falcon_client_id,
      'client_secret': falcon_client_secret
   }
)

HEADERS = {
    'X-CS-USERUUID': 'string'
}

IDS = 'ID1,ID2,ID3'

response = falcon.command('DeleteSampleV2', headers=HEADERS, ids=IDS)
print(response)
falcon.deauthenticate()

QuerySampleV1

Retrieves a list with sha256 of samples that exist and customer has rights to access them, maximum number of accepted items is 200

Content-Type

Consumes: application/json
Produces: application/json

Parameters

Required	Name	Type	Datatype	Description
	X-CS-USERUUID	header	string	User UUID
✅	body	body	string	Pass a list of sha256s to check if the exist. It will be returned the list of existing hashes.

Usage

Service class example

from falconpy import falconx_sandbox as FalconX

falcon = FalconX.FalconX_Sandbox(creds={
     'client_id': falcon_client_id,
     'client_secret': falcon_client_secret
})

BODY = {
    'Body Payload': 'See body description above'
}

HEADERS = {
    'X-CS-USERUUID': 'string'
}

response = falcon.QuerySampleV1(body=BODY, headers=HEADERS)
print(response)

Uber class example

from falconpy import api_complete as FalconSDK

falcon = FalconSDK.APIHarness(creds={
      'client_id': falcon_client_id,
      'client_secret': falcon_client_secret
   }
)

BODY = {
    'Body Payload': 'See body description above'
}

HEADERS = {
    'X-CS-USERUUID': 'string'
}

response = falcon.command('QuerySampleV1', body=BODY, headers=HEADERS)
print(response)
falcon.deauthenticate()

Home
Discussions Board
Glossary of Terms
Installation, Upgrades and Removal
Samples Collection
Using FalconPy
API Operations
Service Collections
Documentation Support
- Report broken link
- Report documentation error
CrowdStrike SDKs
- Crimson Falcon - Ruby
- FalconPy - Python 3
- FalconJS - Javascript
- goFalcon - Go
- PSFalcon - Powershell
- Rusty Falcon - Rust

CrowdStrike Falcon

Falconx Sandbox

Using the FalconX Sandbox service collection

Table of Contents

GetArtifacts

Parameters

Usage

Service class example

Uber class example

GetSummaryReports

Content-Type

Parameters

Usage

Service class example

Uber class example

GetReports

Content-Type

Parameters

Usage

Service class example

Uber class example

DeleteReport

Content-Type

Parameters

Usage

Service class example

Uber class example

GetSubmissions

Content-Type

Parameters

Usage

Service class example

Uber class example

Submit

Content-Type

Parameters

Usage

Service class example

Uber class example

QueryReports

Content-Type

Parameters

Usage

Service class example

Uber class example

QuerySubmissions

Content-Type

Parameters

Usage

Service class example

Uber class example

GetSampleV2

Content-Type

Parameters

Usage

Service class example

Uber class example

UploadSampleV2

Content-Type

Parameters

Usage

Service class example

Uber class example

DeleteSampleV2

Content-Type

Parameters

Usage

Service class example

Uber class example

QuerySampleV1

Content-Type

Parameters

Usage

Service class example

Uber class example

Clone this wiki locally