Unidentified Containers - CrowdStrike/falconpy GitHub Wiki

CrowdStrike Falcon CrowdStrike Subreddit

Using the Unidentified Containers service collection

Uber class support Service class support Documentation Version Page Updated

Table of Contents

Operation ID Description
ReadUnidentifiedContainersByDateRangeCount
PEP 8 read_count_by_date_range
Returns the count of Unidentified Containers over the last 7 days
ReadUnidentifiedContainersCount
PEP 8 read_count
Returns the total count of Unidentified Containers over a time period
SearchAndReadUnidentifiedContainers
PEP 8 search_and_read
Search Unidentified Containers by the provided search criteria

Passing credentials

WARNING

client_id and client_secret are keyword arguments that contain your CrowdStrike API credentials. Please note that all examples below do not hard code these values. (These values are ingested as strings.)

CrowdStrike does not recommend hard coding API credentials or customer identifiers within source code.

ReadUnidentifiedContainersByDateRangeCount

Returns the count of Unidentified Containers over the last 7 days

PEP8 method name

read_count_by_date_range

Endpoint

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

Required Scope

falcon-container-image:read

Content-Type

  • Produces: application/json

Keyword Arguments

Name Service Uber Type Data type Description
filter
Service Class Support
Uber Class Support
 query string Filter Unidentified Containers using a query in Falcon Query Language (FQL). Supported filters: assessed_images_count,cid,cloud_account_id,cloud_name,cloud_region,cluster_id,cluster_name,containers_impacted_count,detections_count,image_assessment_detections_count,last_seen,namespace,node_name,severity,unassessed_images_count,visible_to_k8s
parameters
Service Class Support
Uber Class Support
 query dictionary Full query string parameters payload in JSON format.

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)

Back to Table of Contents

ReadUnidentifiedContainersCount

Returns the total count of Unidentified Containers over a time period

PEP8 method name

read_count

Endpoint

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

Required Scope

falcon-container-image:read

Content-Type

  • Produces: application/json

Keyword Arguments

Name Service Uber Type Data type Description
filter
Service Class Support
Uber Class Support
 query string Filter Unidentified Containers using a query in Falcon Query Language (FQL). Supported filters: assessed_images_count,cid,cloud_account_id,cloud_name,cloud_region,cluster_id,cluster_name,containers_impacted_count,detections_count,image_assessment_detections_count,last_seen,namespace,node_name,severity,unassessed_images_count,visible_to_k8s
parameters
Service Class Support
Uber Class Support
 query dictionary Full query string parameters payload in JSON format.

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)

Back to Table of Contents

SearchAndReadUnidentifiedContainers

Search Unidentified Containers by the provided search criteria

PEP8 method name

search_and_read

Endpoint

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

Required Scope

falcon-container-image:read

Content-Type

  • Produces: application/json

Keyword Arguments

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

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)

Back to Table of Contents

⚠️ **GitHub.com Fallback** ⚠️