Using the Real Time Response Audit service collection
Table of Contents
Operation ID | Description | ||||
---|---|---|---|---|---|
| Get all the RTR sessions created for a customer in a specified duration |
Passing credentials
WARNING
client_id
andclient_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.
RTRAuditSessions
Get all the RTR sessions created for a customer in a specified duration
PEP8 method name
audit_sessions
Endpoint
Method | Route |
---|---|
/real-time-response-audit/combined/sessions/v1 |
Required Scope
Content-Type
- Produces: application/json
Keyword Arguments
Name | Service | Uber | Type | Data type | Description |
---|---|---|---|---|---|
filter | query | string | Optional filter criteria in FQL format. | ||
sort | query | string | Sort order in FQL format. | ||
limit | query | string | Maximum number of sessions to be returned. | ||
offset | query | string | Offset value to be used for paginating results. | ||
parameters | query | dictionary | Full query string parameters payload in JSON format. | ||
with_command_info | query | boolean | Retrieve sessions with command info included; by default sessions are returned without command information which include cloud_request_ids and logs fields. |
Usage
Service class example (PEP8 syntax)
from falconpy import RealTimeResponseAudit
# Do not hardcode API credentials!
falcon = RealTimeResponseAudit(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.audit_sessions(filter="string",
sort="string",
limit="string",
offset="string",
with_command_info=boolean
)
print(response)
Service class example (Operation ID syntax)
from falconpy import RealTimeResponseAudit
# Do not hardcode API credentials!
falcon = RealTimeResponseAudit(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.RTRAuditSessions(filter="string",
sort="string",
limit="string",
offset="string",
with_command_info=boolean
)
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("RTRAuditSessions",
filter="string",
sort="string",
limit="string",
offset="string",
with_command_info=boolean
)
print(response)