Skip to content

Quarantine

Jump to bottom
jshcodes edited this page Aug 30, 2021 · 16 revisions

CrowdStrike Falcon Twitter URL

Using the Quarantine service collection

Uber class support Service class support

Table of Contents

Operation ID Description
ActionUpdateCount
PEP8 action_update_count
Returns count of potentially affected quarantined files for each action.
GetAggregateFiles
PEP8 get_aggregate_files
Get quarantine file aggregates as specified via json in request body.
GetQuarantineFiles
PEP8 get_quarantine_files
Get quarantine file metadata for specified ids.
UpdateQuarantinedDetectsByIds
PEP8 update_quarantined_detects_by_id
Apply action by quarantine file ids
QueryQuarantineFiles
PEP8 query_quarantine_files
Get quarantine file ids that match the provided filter criteria.
UpdateQfByQuery
PEP8 update_quarantined_detects_by_query
Apply quarantine file actions by query.

ActionUpdateCount

Returns count of potentially affected quarantined files for each action.

PEP8 method name

action_update_count

Content-Type

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

Parameters

Required Name Type Datatype Description
✅ filter query string FQL specifying filter parameters.

Usage

Service class example (PEP8 syntax)
from falconpy.quarantine import Quarantine

falcon = Quarantine(client_id="API_CLIENT_ID_HERE",
                    client_secret="API_CLIENT_SECRET_HERE"
                    )

response = falcon.action_update_count(filter="string")
print(response)
Service class example (Operation ID syntax)
from falconpy.quarantine import Quarantine

falcon = Quarantine(client_id="API_CLIENT_ID_HERE",
                    client_secret="API_CLIENT_SECRET_HERE"
                    )

response = falcon.ActionUpdateCount(filter="string")
print(response)
Uber class example
from falconpy.api_complete import APIHarness

falcon = APIHarness(client_id="API_CLIENT_ID_HERE",
                    client_secret="API_CLIENT_SECRET_HERE"
                    )

PARAMS = {
    "filter": "string"
}

response = falcon.command("ActionUpdateCount", parameters=PARAMS)
print(response)

GetAggregateFiles

Get quarantine file aggregates as specified via json in request body.

PEP8 method name

get_aggregate_files

Content-Type

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

Parameters

Required Name Type Datatype Description
✅ body body string

Usage

Service class example (PEP8 syntax)
from falconpy.quarantine import Quarantine

falcon = Quarantine(client_id="API_CLIENT_ID_HERE",
                    client_secret="API_CLIENT_SECRET_HERE"
                    )

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

response = falcon.get_aggregate_files(body=BODY)
print(response)
Service class example (Operation ID syntax)
from falconpy.quarantine import Quarantine

falcon = Quarantine(client_id="API_CLIENT_ID_HERE",
                    client_secret="API_CLIENT_SECRET_HERE"
                    )

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

response = falcon.GetAggregateFiles(body=BODY)
print(response)
Uber class example
from falconpy.api_complete import APIHarness

falcon = APIHarness(client_id="API_CLIENT_ID_HERE",
                    client_secret="API_CLIENT_SECRET_HERE"
                    )

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

response = falcon.command("GetAggregateFiles", body=BODY)
print(response)

GetQuarantineFiles

Get quarantine file metadata for specified ids.

PEP8 method name

get_quarantine_files

Content-Type

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

Parameters

Required Name Type Datatype Description
✅ body body string

Usage

Service class example (PEP8 syntax)
from falconpy.quarantine import Quarantine

falcon = Quarantine(client_id="API_CLIENT_ID_HERE",
                    client_secret="API_CLIENT_SECRET_HERE"
                    )

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

response = falcon.get_quarantine_files(body=BODY)
print(response)
Service class example (Operation ID syntax)
from falconpy.quarantine import Quarantine

falcon = Quarantine(client_id="API_CLIENT_ID_HERE",
                    client_secret="API_CLIENT_SECRET_HERE"
                    )

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

response = falcon.GetQuarantineFiles(body=BODY)
print(response)
Uber class example
from falconpy.api_complete import APIHarness

falcon = APIHarness(client_id="API_CLIENT_ID_HERE",
                    client_secret="API_CLIENT_SECRET_HERE"
                    )

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

response = falcon.command("GetQuarantineFiles", body=BODY)
print(response)

UpdateQuarantinedDetectsByIds

Apply action by quarantine file ids

PEP8 method name

update_quarantined_detects_by_id

Content-Type

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

Parameters

Required Name Type Datatype Description
✅ body body string

Usage

Service class example (PEP8 syntax)
from falconpy.quarantine import Quarantine

falcon = Quarantine(client_id="API_CLIENT_ID_HERE",
                    client_secret="API_CLIENT_SECRET_HERE"
                    )

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

response = falcon.update_quarantined_detects_by_id(body=BODY)
print(response)
Service class example (Operation ID syntax)
from falconpy.quarantine import Quarantine

falcon = Quarantine(client_id="API_CLIENT_ID_HERE",
                    client_secret="API_CLIENT_SECRET_HERE"
                    )

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

response = falcon.UpdateQuarantinedDetectsByIds(body=BODY)
print(response)
Uber class example
from falconpy.api_complete import APIHarness

falcon = APIHarness(client_id="API_CLIENT_ID_HERE",
                    client_secret="API_CLIENT_SECRET_HERE"
                    )

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

response = falcon.command("UpdateQuarantinedDetectsByIds", body=BODY)
print(response)

QueryQuarantineFiles

Get quarantine file ids that match the provided filter criteria.

PEP8 method name

query_quarantine_files

Content-Type

  • Produces: application/json

Parameters

Required Name Type Datatype Description
offset query string Starting index of overall result set from which to return ids.
limit query integer Number of ids to return.
sort query string Possible order by fields: hostname, username, date_updated, date_created, paths.path, state, paths.state. Ex: 'date_created
filter query string FQL query specifying the filter parameters. Special value '*' means to not filter on anything. Filter term criteria: status, adversary_id, device.device_id, device.country, device.hostname, behaviors.behavior_id, behaviors.ioc_type, behaviors.ioc_value, behaviors.username, behaviors.tree_root_hash. Filter range criteria:, max_severity, max_confidence, first_behavior, last_behavior.
q query string Match phrase_prefix query criteria; included fields: _all (all filter string fields), sha256, state, paths.path, paths.state, hostname, username, date_updated, date_created.

Usage

Service class example (PEP8 syntax)
from falconpy.quarantine import Quarantine

falcon = Quarantine(client_id="API_CLIENT_ID_HERE",
                    client_secret="API_CLIENT_SECRET_HERE"
                    )

response = falcon.query_quarantine_files(offset="string",
                                         limit=integer,
                                         sort="string",
                                         filter="string",
                                         q="string"
                                         )
print(response)
Service class example (Operation ID syntax)
from falconpy.quarantine import Quarantine

falcon = Quarantine(client_id="API_CLIENT_ID_HERE",
                    client_secret="API_CLIENT_SECRET_HERE"
                    )

response = falcon.QueryQuarantineFiles(offset="string",
                                       limit=integer,
                                       sort="string",
                                       filter="string",
                                       q="string"
                                       )
print(response)
Uber class example
from falconpy.api_complete import APIHarness

falcon = APIHarness(client_id="API_CLIENT_ID_HERE",
                    client_secret="API_CLIENT_SECRET_HERE"
                    )

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

response = falcon.command("QueryQuarantineFiles", parameters=PARAMS)
print(response)

UpdateQfByQuery

Apply quarantine file actions by query.

PEP8 method name

update_quarantined_detects_by_query

Content-Type

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

Parameters

Required Name Type Datatype Description
✅ body body string

Usage

Service class example (PEP8 syntax)
from falconpy.quarantine import Quarantine

falcon = Quarantine(client_id="API_CLIENT_ID_HERE",
                    client_secret="API_CLIENT_SECRET_HERE"
                    )

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

response = falcon.update_quarantined_detects_by_query(body=BODY)
print(response)
Service class example (Operation ID syntax)
from falconpy.quarantine import Quarantine

falcon = Quarantine(client_id="API_CLIENT_ID_HERE",
                    client_secret="API_CLIENT_SECRET_HERE"
                    )

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

response = falcon.UpdateQfByQuery(body=BODY)
print(response)
Uber class example
from falconpy.api_complete import APIHarness

falcon = APIHarness(client_id="API_CLIENT_ID_HERE",
                    client_secret="API_CLIENT_SECRET_HERE"
                    )

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

response = falcon.command("UpdateQfByQuery", body=BODY)
print(response)

CrowdStrike Falcon

Clone this wiki locally