Operation ID | Description |
| Retrieve image assessment detections identified by the provided filter criteria. |
| Aggregate counts of detections by severity. |
| Aggregate counts of detections by detection type. |
| Aggregate count of detections. |
| Retrieve image assessment detections identified by the provided filter criteria. |
| Retrieve image assessment detection entities identified by the provided filter criteria. |
| Retrieve image assessment detection entities identified by the provided filter criteria. |
Retrieve image assessment detections identified by the provided filter criteria.
search_runtime_detections
Method | Route |
| /container-security/combined/runtime-detections/v2 |
- Produces: application/json
Name | Service | Uber | Type | Data type | Description |
filter |
|
| query | string | Filter container runtime detections using a query in Falcon Query Language (FQL). Supported filters: action_taken, aid, cid, cloud, cluster_name, command_line, computer_name, container_id, detect_timestamp, detection_description, detection_id, file_name, file_path, host_id, host_type, image_id, name, namespace, pod_name, severity, tactic |
limit |
|
| query | integer | The upper-bound on the number of records to retrieve. |
offset |
|
| query | integer | The offset from where to begin. |
parameters |
| | query | dictionary | Full query string parameters payload in JSON format. Not required if using other keywords. |
sort |
|
| query | string | The fields to sort the records on. Supported fields: containers_impacted, detection_name, detection_severity, detection_type, images_impacted, last_detected |
from falconpy import ContainerDetections
# Do not hardcode API credentials!
falcon = ContainerDetections(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.search_runtime_detections(filter="string",
limit=integer,
offset=integer,
sort="string"
)
print(response)
from falconpy import ContainerDetections
# Do not hardcode API credentials!
falcon = ContainerDetections(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.GetRuntimeDetectionsCombinedV2(filter="string",
limit=integer,
offset=integer,
sort="string"
)
print(response)
from falconpy import APIHarnessV2
# Do not hardcode API credentials!
falcon = APIHarnessV2(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.command("GetRuntimeDetectionsCombinedV2",
filter="string",
limit=integer,
offset=integer,
sort="string"
)
print(response)
Aggregate counts of detections by severity
read_detection_counts_by_severity
Method | Route |
| /container-security/aggregates/detections/count-by-severity/v1 |
- Produces: application/json
Name | Service | Uber | Type | Data type | Description |
filter |
|
| query | string | Filter images using a query in Falcon Query Language (FQL). Supported filters: cid,container_id,detection_type,id,image_digest,image_id,image_registry,image_repository,image_tag,name,severity |
parameters |
| | query | dictionary | Full query string parameters payload in JSON format. Not required if using other keywords. |
from falconpy import ContainerDetections
# Do not hardcode API credentials!
falcon = ContainerDetections(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.read_detection_counts_by_severity(filter="string")
print(response)
from falconpy import ContainerDetections
# Do not hardcode API credentials!
falcon = ContainerDetections(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.ReadDetectionsCountBySeverity(filter="string")
print(response)
from falconpy import APIHarnessV2
# Do not hardcode API credentials!
falcon = APIHarnessV2(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.command("ReadDetectionsCountBySeverity", filter="string")
print(response)
Aggregate counts of detections by detection type
read_detections_count_by_type
Method | Route |
| /container-security/aggregates/detections/count-by-type/v1 |
- Produces: application/json
Name | Service | Uber | Type | Data type | Description |
filter |
|
| query | string | Filter images using a query in Falcon Query Language (FQL). Supported filters: cid,container_id,detection_type,id,image_digest,image_id,image_registry,image_repository,image_tag,name,severity |
parameters |
| | query | dictionary | Full query string parameters payload in JSON format. Not required if using other keywords. |
from falconpy import ContainerDetections
# Do not hardcode API credentials!
falcon = ContainerDetections(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.read_detections_count_by_type(filter="string")
print(response)
from falconpy import ContainerDetections
# Do not hardcode API credentials!
falcon = ContainerDetections(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.ReadDetectionsCountByType(filter="string")
print(response)
from falconpy import APIHarnessV2
# Do not hardcode API credentials!
falcon = APIHarnessV2(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.command("ReadDetectionsCountByType", filter="string")
print(response)
Aggregate count of detections
read_detections_count
Method | Route |
| /container-security/aggregates/detections/count/v1 |
- Produces: application/json
Name | Service | Uber | Type | Data type | Description |
filter |
|
| query | string | Filter images using a query in Falcon Query Language (FQL). Supported filters: cid,container_id,detection_type,id,image_digest,image_id,image_registry,image_repository,image_tag,name,severity |
parameters |
| | query | dictionary | Full query string parameters payload in JSON format. Not required if using other keywords. |
from falconpy import ContainerDetections
# Do not hardcode API credentials!
falcon = ContainerDetections(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.read_detections_count(filter="string")
print(response)
from falconpy import ContainerDetections
# Do not hardcode API credentials!
falcon = ContainerDetections(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.ReadDetectionsCount(filter="string")
print(response)
from falconpy import APIHarnessV2
# Do not hardcode API credentials!
falcon = APIHarnessV2(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.command("ReadDetectionsCount", filter="string")
print(response)
Retrieve image assessment detections identified by the provided filter criteria
read_combined_detections
Method | Route |
| /container-security/combined/detections/v1 |
- Produces: application/json
Name | Service | Uber | Type | Data type | Description |
filter |
|
| query | string | Filter images using a query in Falcon Query Language (FQL). Supported filters: cid,container_id,detection_type,id,image_digest,image_id,image_registry,image_repository,image_tag,name,severity |
limit |
|
| query | integer | The upper-bound on the number of records to retrieve. |
offset |
|
| query | integer | The offset from where to begin. |
parameters |
| | query | dictionary | Full query string parameters payload in JSON format. Not required if using other keywords. |
sort |
|
| query | string | The fields to sort the records on. Supported columns: [containers_impacted detection_name detection_severity detection_type images_impacted last_detected] |
from falconpy import ContainerDetections
# Do not hardcode API credentials!
falcon = ContainerDetections(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.read_combined_detections(filter="string",
limit=integer,
offset=integer,
sort="string"
)
print(response)
from falconpy import ContainerDetections
# Do not hardcode API credentials!
falcon = ContainerDetections(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.ReadCombinedDetections(filter="string",
limit=integer,
offset=integer,
sort="string"
)
print(response)
from falconpy import APIHarnessV2
# Do not hardcode API credentials!
falcon = APIHarnessV2(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.command("ReadCombinedDetections",
filter="string",
limit=integer,
offset=integer,
sort="string"
)
print(response)
Retrieve image assessment detection entities identified by the provided filter criteria
read_detections
Method | Route |
| /container-security/entities/detections/v1 |
- Produces: application/json
Name | Service | Uber | Type | Data type | Description |
filter |
|
| query | string | Filter images using a query in Falcon Query Language (FQL). Supported filters: cid,detection_type,image_registry,image_repository,image_tag |
limit |
|
| query | integer | The upper-bound on the number of records to retrieve. |
offset |
|
| query | integer | The offset from where to begin. |
parameters |
| | query | dictionary | Full query string parameters payload in JSON format. Not required if using other keywords. |
from falconpy import ContainerDetections
# Do not hardcode API credentials!
falcon = ContainerDetections(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.read_detections(filter="string",
limit=integer,
offset=integer
)
print(response)
from falconpy import ContainerDetections
# Do not hardcode API credentials!
falcon = ContainerDetections(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.ReadDetections(filter="string",
limit=integer,
offset=integer
)
print(response)
from falconpy import APIHarnessV2
# Do not hardcode API credentials!
falcon = APIHarnessV2(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.command("ReadDetections",
filter="string",
limit=integer,
offset=integer
)
print(response)
Retrieve image assessment detection entities identified by the provided filter criteria
search_detections
Method | Route |
| /container-security/queries/detections/v1 |
- Produces: application/json
Name | Service | Uber | Type | Data type | Description |
filter |
|
| query | string | Filter images using a query in Falcon Query Language (FQL). Supported filters: cid,container_id,detection_type,id,image_digest,image_id,image_registry,image_repository,image_tag,name,severity |
limit |
|
| query | integer | The upper-bound on the number of records to retrieve. |
offset |
|
| query | integer | The offset from where to begin. |
parameters |
| | query | dictionary | Full query string parameters payload in JSON format. Not required if using other keywords. |
from falconpy import ContainerDetections
# Do not hardcode API credentials!
falcon = ContainerDetections(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.search_detections(filter="string",
limit=integer,
offset=integer
)
print(response)
from falconpy import ContainerDetections
# Do not hardcode API credentials!
falcon = ContainerDetections(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.SearchDetections(filter="string",
limit=integer,
offset=integer
)
print(response)
from falconpy import APIHarnessV2
# Do not hardcode API credentials!
falcon = APIHarnessV2(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.command("SearchDetections",
filter="string",
limit=integer,
offset=integer
)
print(response)