Skip to main content

CrowdClient is a Python library for interacting with CrowdStrike Falcon's REST API.

Project description

CrowdClient

CrowdClient is a Python library for interacting with CrowdStrike Falcon's REST API.

Installation

pip install crowdclient

Usage

General Use

from CrowdClient.crowdclient import CrowdClient

# Instantiate your client
falcon_client = CrowdClient(<client_id>, <client_secret>)

# Authenticate to retrieve and store an authentication token for subsequent requests
falcon_client.authenticate()

# Get current detections (defaults to new detections only of all severities sorted newest -> oldest)
# Returns a list of all ID's matching above criteria
detections = falcon_client.get_detections()

# Get the number of hosts in your environment exhibiting activity related to a specified indicator
host_count = falcon_client.indicator_host_count('8.8.8.8', 'ipv4')

Real-Time Response

from CrowdClient.crowdclient import RTRClient

# Instantiate your client and authenticate
rtr_client = RTRClient(<client_id>, <client_secret>, verify_cert=False)
rtr_client.authenticate()

# Initiate a batch session for multiple hosts
batch_id = rtr_client.batch_init(['hostid1', 'hostid2', 'hostid3'])

# Issue an RTR Admin command using the established session - Exclude a host if you'd like
rtr_client.batch_admin_cmd(batch_id, command='ls', command_string='ls C:\Users\', optional_hosts=['hostid3'])

# View the script ID's available for the user to use with the 'runscript' command
script_ids = rtr_client.get_scripts()

# Get the details for said scripts
script_details = rtr_client.script_details(script_ids)

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

CrowdClient-0.3.6.tar.gz (10.1 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page