Configuration Assessment

Using the Configuration Assessment service collection

Table of Contents

Operation ID	Description
getCombinedAssessmentsQuery PEP8 query_combined_assessments	Search for assessments in your environment by providing an FQL filter and paging details. Returns a set of HostFinding entities which match the filter criteria
getRuleDetails PEP8 get_rule_details	Get rules details for provided one or more rule IDs

getCombinedAssessmentsQuery

Search for assessments in your environment by providing an FQL filter and paging details. Returns a set of HostFinding entities which match the filter criteria

PEP8 method name

query_combined_assessments

Endpoint

Method	Route
	/configuration-assessment/combined/assessments/v1

Content-Type

• Produces: application/json

Keyword Arguments

Name	Service	Uber	Type	Data type	Description
after			query	string	A pagination token used with the limit parameter to manage pagination of results. On your first request, don't provide an after token. On subsequent requests, provide the after token from the previous response to continue from that place in the results.
limit			query	integer	The number of items to return in this response (default: 100, max: 5000). Use with the after parameter to manage pagination of results.
sort			query	string	Sort assessment by their properties. Common sort options include: created_timestamp
filter			query	string	Filter items using a query in Falcon Query Language (FQL). Wildcards * are unsupported. Common filter options include: created_timestamp:>'2019-11-25T22:36:12Z' updated_timestamp:>'2019-11-25T22:36:12Z' aid:'8e7656b27d8c49a34a1af416424d6231'
facet			query	list of strings	Select various details blocks to be returned for each assessment entity. Supported values: host finding.rule finding.evaluation_logic
parameters			query	dictionary	Full query string parameters payload in JSON format. Not required if using other keywords.

Usage

Service class example (PEP8 syntax)

from falconpy import ConfigurationAssessment

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

response = falcon.query_combined_assessments(after="string",
                                             limit=integer,
                                             sort="string",
                                             filter="string",
                                             facet=["string", "string"]
                                             )
print(response)

Service class example (Operation ID syntax)

from falconpy import ConfigurationAssessment

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

response = falcon.getCombinedAssessmentsQuery(after="string",
                                              limit=integer,
                                              sort="string",
                                              filter="string",
                                              facet=["string", "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("getCombinedAssessmentsQuery",
                          after="string",
                          limit=integer,
                          sort="string",
                          filter="string",
                          facet=["string", "string"]
                          )
print(response)

getRuleDetails

Get rules details for provided one or more rule IDs

PEP8 method name

get_rule_details

Endpoint

Method	Route
	/configuration-assessment/entities/rule-details/v1

Content-Type

• Produces: application/json

Keyword Arguments

Name	Service	Uber	Type	Data type	Description
ids			query	string or list of strings	One or more rules IDs (max: 400)
parameters			query	dictionary	Full query string parameters payload in JSON format. Not required if using other keywords.

Usage

Service class example (PEP8 syntax)

from falconpy import ConfigurationAssessment

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

id_list = 'ID1,ID2,ID3'  # Can also pass a list here: ['ID1', 'ID2', 'ID3']

response = falcon.get_rule_details(ids=id_list)

print(response)

Service class example (Operation ID syntax)

from falconpy import ConfigurationAssessment

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

id_list = 'ID1,ID2,ID3'  # Can also pass a list here: ['ID1', 'ID2', 'ID3']

response = falcon.getRuleDetails(ids=id_list)

print(response)

Uber class example

from falconpy import APIHarnessV2

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

id_list = 'ID1,ID2,ID3'  # Can also pass a list here: ['ID1', 'ID2', 'ID3']

response = falcon.command("getRuleDetails", ids=id_list)

print(response)