Using the Unidentified Containers service collection

Table of Contents

ReadUnidentifiedContainersByDateRangeCount

Returns the count of Unidentified Containers over the last 7 days

PEP8 method name

read_count_by_date_range

Endpoint

Method	Route
	/container-security/aggregates/unidentified-containers/count-by-date/v1

Content-Type

• Produces: application/json

Keyword Arguments

Name	Service	Uber	Type	Data type	Description
filter			query	string	Filter Unidentified Containers using a query in Falcon Query Language (FQL). Supported filters: assessed_images_count,cid,cluster_name,containers_impacted_count,detections_count,image_assessment_detections_count,last_seen,namespace,node_name,severity,unassessed_images_count,visible_to_k8s

Usage

Service class example (PEP8 syntax)

from falconpy import UnidentifiedContainers

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

response = falcon.read_count_by_date_range(filter="string")

print(response)

Service class example (Operation ID syntax)

from falconpy import UnidentifiedContainers

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

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

print(response)

ReadUnidentifiedContainersCount

Returns the total count of Unidentified Containers over a time period

PEP8 method name

read_count

Endpoint

Method	Route
	/container-security/aggregates/unidentified-containers/count/v1

Content-Type

• Produces: application/json

Keyword Arguments

Name	Service	Uber	Type	Data type	Description
filter			query	string	Filter Unidentified Containers using a query in Falcon Query Language (FQL). Supported filters: assessed_images_count,cid,cluster_name,containers_impacted_count,detections_count,image_assessment_detections_count,last_seen,namespace,node_name,severity,unassessed_images_count,visible_to_k8s

Usage

Service class example (PEP8 syntax)

from falconpy import UnidentifiedContainers

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

response = falcon.read_count(filter="string")

print(response)

Service class example (Operation ID syntax)

from falconpy import UnidentifiedContainers

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

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

print(response)

SearchAndReadUnidentifiedContainers

Search Unidentified Containers by the provided search criteria

PEP8 method name

search_and_read

Endpoint

Method	Route
	/container-security/combined/unidentified-containers/v1

Content-Type

• Produces: application/json

Keyword Arguments

Name	Service	Uber	Type	Data type	Description
filter			query	string	Search Unidentified Containers using a query in Falcon Query Language (FQL). Supported filters: assessed_images_count,cid,cluster_name,containers_impacted_count,detections_count,image_assessment_detections_count,last_seen,namespace,node_name,severity,unassessed_images_count,visible_to_k8s
limit			query	integer	The upper-bound on the number of records to retrieve.
offset			query	integer	The offset from where to begin.
sort			query	string	The fields to sort the records on.

Usage

Service class example (PEP8 syntax)

from falconpy import UnidentifiedContainers

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

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

Service class example (Operation ID syntax)

from falconpy import UnidentifiedContainers

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

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