| Name | crowdstrike-falconpy JSON |
| Version |
1.4.6
JSON |
| download |
| home_page | None |
| Summary | The CrowdStrike Falcon SDK for Python |
| upload_time | 2024-11-01 20:57:33 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.7 |
| license | This is free and unencumbered software released into the public domain.
Anyone is free to copy, modify, publish, use, compile, sell, or
distribute this software, either in source code form or as a compiled
binary, for any purpose, commercial or non-commercial, and by any
means.
In jurisdictions that recognize copyright laws, the author or authors
of this software dedicate any and all copyright interest in the
software to the public domain. We make this dedication for the benefit
of the public at large and to the detriment of our heirs and
successors. We intend this dedication to be an overt act of
relinquishment in perpetuity of all present and future rights to this
software under copyright law.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.
For more information, please refer to <https://unlicense.org> |
| keywords |
api
crowdstrike
crowdstrike-falcon
devsecops
falcon
oauth2
sdk
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
[](https://reddit.com/r/crowdstrike)<br/>
# FalconPy - The CrowdStrike Falcon SDK for Python
[](https://pypi.org/project/crowdstrike-falconpy/)
[](https://pypi.org/project/crowdstrike-falconpy/#history)
[](https://github.com/CrowdStrike/falconpy/releases)
[](https://github.com/CrowdStrike/falconpy/graphs/code-frequency)
[](https://github.com/CrowdStrike/falconpy/commits/main)
The FalconPy SDK contains a collection of Python classes that abstract CrowdStrike Falcon OAuth2 API interaction, removing duplicative code and allowing developers to focus on just the logic of their solution requirements.
+ [Overview](#overview-)
+ [Quick Start](#quick-start-)
+ [Documentation and Support](#documentation-and-support-)
+ [Contribute to FalconPy](#contribute-to-falconpy-)
## Overview 🔎
There are many CrowdStrike Falcon API [service collections](https://www.falconpy.io/Operations/Operations-by-Collection.html) collectively containing hundreds of [individual operations](https://www.falconpy.io/Operations/All-Operations.html), all of which are accessible to your project via FalconPy.
The CrowdStrike Falcon SDK for Python completely abstracts token management, while also supporting interaction with all CrowdStrike regions, custom connection and response timeouts, routing requests through a list of proxies, disabling SSL verification, and custom header configuration.
> If the CrowdStrike APIs were rings of great power, that the Dark Lord Sauron gifted to the kings of dwarves, elves and men, then CrowdStrike's FalconPy would be the One Ring.
>
> _"One SDK to rule them all, One SDK to find them, One SDK to bring them all and in the darkness bind them."_
[](https://pepy.tech/project/crowdstrike-falconpy)
[](https://pepy.tech/project/crowdstrike-falconpy-dev)
#### Supported versions of Python
The CrowdStrike Falcon SDK for Python was developed for Python 3. Current versions of FalconPy provide support for Python versions `3.7` - `3.12`. Every commit to the FalconPy code base is unit tested for functionality using all versions of Python the library currently supports.
> [!NOTE]
> Developers working with Python version `3.6` will need to leverage versions of FalconPy less than `1.4.0`.
[](https://pypi.org/project/crowdstrike-falconpy/#files)
[](https://pypi.org/project/crowdstrike-falconpy/#files)
[](https://github.com/CrowdStrike/falconpy/actions/workflows/unit_testing_ubuntu.yml)
#### Supported Operating Systems
The FalconPy SDK is unit tested on the following operating systems.
[](https://www.apple.com/macos/)
[](https://ubuntu.com/)
[](https://www.microsoft.com/en-us/windows/)
FalconPy will also run on any of the following operating systems.
[](https://aws.amazon.com/amazon-linux-ami/)
[](https://www.centos.org/)
[](https://getfedora.org/)
[](https://www.redhat.com/en/technologies/linux-platforms/enterprise-linux)
[](https://archlinux.org/)
[](https://www.debian.org/)
[](https://www.kali.org/)
[](https://pop.system76.com/)
[](https://www.suse.com/)
[](https://www.opensuse.org/)
Details regarding supported operating systems and Python versions, and project security and testing procedures can be found [here](https://github.com/CrowdStrike/falconpy/blob/main/SECURITY.md).
### Components
The FalconPy SDK provides two distinct methods for interacting with CrowdStrike's API.
| **[Service Classes](#service-classes)** | **[The Uber Class](#the-uber-class)** |
| :-- | :-- |
| <BR/>[](#service-classes) | [](#the-uber-class) |
| Each Service Class represents a single CrowdStrike API service collection providing an interface to the [operations available](https://www.falconpy.io/Operations/Operations-by-Collection.html) within that service collection.| An all-in-one class that provides a singular interface for [all operations](https://www.falconpy.io/Operations/All-Operations.html) in every CrowdStrike API service collection. |
### Service Classes
Representing a single CrowdStrike Falcon API service collection, each Service Class has a method defined for [every operation available](https://www.falconpy.io/Operations/Operations-by-Collection.html) within that service collection.
#### Available Service Classes
For each CrowdStrike Falcon API service collection, a matching Service Class is available in the FalconPy library. For a complete list of service collections and their related Service Class, please review the [Operations by Collection](https://www.falconpy.io/Operations/Operations-by-Collection.html) page on [falconpy.io](https://falconpy.io).
#### Service Class benefits
- Closely follows Python and OpenAPI best practice for code style and syntax. PEP-8 compliant.
- Completely abstracts token management, automatically refreshing your token when it expires.
- Interact with newly released API operations not yet available in the library via the `override` method.
- Provides simple programmatic patterns for interacting with CrowdStrike Falcon APIs.
- Supports [cloud region autodiscovery](https://www.falconpy.io/Usage/Environment-Configuration.html#cloud-region-autodiscovery) for the CrowdStrike `US-1`, `US-2` and `EU-1` regions.
- Supports dynamic [configuration](https://www.falconpy.io/Usage/Environment-Configuration.html) based upon the needs of your environment.
- Supports CrowdStrike Falcon API [parameter abstraction](https://www.falconpy.io/Usage/Payload-Handling.html#parameter-abstraction) functionality.
- Supports CrowdStrike Falcon API [body payload abstraction](https://www.falconpy.io/Usage/Payload-Handling.html#body-payload-abstraction) functionality.
### The Uber Class
Operating as a single harness for interacting with the entire CrowdStrike Falcon API, the _Uber Class_ can access [every available operation](https://www.falconpy.io/Operations/All-Operations.html) within [every API service collection](https://www.falconpy.io/Operations/Operations-by-Collection.html).
#### Uber Class benefits
- Access every CrowdStrike Falcon API service collection with only one import and only one class.
- Completely abstracts token management, automatically refreshing your token when it expires.
- Interact with newly released API operations not yet available in the library via the [`override`](https://www.falconpy.io/Usage/Basic-Uber-Class-usage.html#the-command-method) keyword.
- Provides simple programmatic patterns for interacting with CrowdStrike Falcon APIs.
- Supports [cloud region autodiscovery](https://www.falconpy.io/Usage/Environment-Configuration.html#cloud-region-autodiscovery) for the CrowdStrike `US-1`, `US-2` and `EU-1` regions.
- Supports CrowdStrike Falcon API [parameter abstraction](https://www.falconpy.io/Usage/Payload-Handling.html#parameter-abstraction) functionality.
- Supports all [environment configuration](https://www.falconpy.io/Usage/Environment-Configuration.html) options supported by FalconPy Service Classes.
### Comparing FalconPy class types
While the [usage syntax](https://www.falconpy.io/Usage/Basic-Uber-Class-usage.html) varies slightly, the Uber Class provides the same performance and [output](https://www.falconpy.io/Usage/Response-Handling.html) as FalconPy Service Classes, and can perform all of the same [operations](https://www.falconpy.io/Operations/All-Operations.html). The Uber Class does **not** support [body payload abstraction](https://www.falconpy.io/Usage/Payload-Handling.html#body-payload-abstraction).
<img width="1" src="data:image/gif;base64,R0lGODlhAQABAIAAAP///wAAACH5BAEAAAAALAAAAAABAAEAAAICRAEAOw==">
## Quick Start 💫
Stable releases of FalconPy are available on the Python Package Index. In a terminal, execute the following command:
```shell
python3 -m pip install crowdstrike-falconpy
```
Once installed, you can immediately begin using CrowdStrike functionality in your Python projects.
```python
"""CrowdStrike FalconPy Quick Start."""
import os
from falconpy import Hosts
# Use the API Clients and Keys page within your Falcon console to generate credentials.
# You will need to assign the Hosts: READ scope to your client to run this example.
# CrowdStrike does not recommend you hardcode credentials within source code.
# Instead, provide these values as variables that are retrieved from the environment,
# read from an encrypted file or secrets store, provided at runtime, etc.
# This example retrieves credentials from the environment as the variables
# "FALCON_CLIENT_ID" and "FALCON_CLIENT_SECRET".
hosts = Hosts(client_id=os.getenv("FALCON_CLIENT_ID"),
client_secret=os.getenv("FALCON_CLIENT_SECRET")
)
SEARCH_FILTER = "hostname-search-string"
# Retrieve a list of hosts that have a hostname that matches our search filter
hosts_search_result = hosts.query_devices_by_filter(filter=f"hostname:*'*{SEARCH_FILTER}*'")
# Confirm we received a success response back from the CrowdStrike API
if hosts_search_result["status_code"] == 200:
hosts_found = hosts_search_result["body"]["resources"]
# Confirm our search produced results
if hosts_found:
# Retrieve the details for all matches
hosts_detail = hosts.get_device_details(ids=hosts_found)["body"]["resources"]
for detail in hosts_detail:
# Display the AID and hostname for this match
aid = detail["device_id"]
hostname = detail["hostname"]
print(f"{hostname} ({aid})")
else:
print("No hosts found matching that hostname within your Falcon tenant.")
else:
# Retrieve the details of the error response
error_detail = hosts_search_result["body"]["errors"]
for error in error_detail:
# Display the API error detail
error_code = error["code"]
error_message = error["message"]
print(f"[Error {error_code}] {error_message}")
```
### More samples
If you are interested in reviewing more examples of FalconPy usage, this repository also maintains a collection of [samples](https://github.com/CrowdStrike/falconpy/tree/main/samples) to help get you started with integrating CrowdStrike Falcon into your DevOps processes.
## Documentation and Support 📖
FalconPy is a community-driven, open source project designed to assist developers in leveraging the power of CrowdStrike APIs within their solutions. While not a formal CrowdStrike product, FalconPy is maintained by CrowdStrike and supported in partnership with the open source developer community.
### Official Project Documentation: [falconpy.io](https://falconpy.io)
[](https://falconpy.io)
Extended documentation is also available via the [wiki](https://github.com/CrowdStrike/falconpy/wiki) for this repository.
### Issues and Questions
Is something going wrong? 🔥
GitHub Issues are used to report bugs and errors.
[](https://github.com/CrowdStrike/falconpy/issues/new/choose)
Have a question you can't find answered in the documentation?
Please submit usage questions to the Q&A section of our discussion board.
[](https://github.com/CrowdStrike/falconpy/discussions?discussions_q=category%3AQ%26A)
### Community forums
The discussion board for this repository also provides the community with means to communicate regarding [enhancements ideas](https://github.com/CrowdStrike/falconpy/discussions?discussions_q=category%3AIdeas), [integration examples](https://github.com/CrowdStrike/falconpy/discussions/496) and [new releases](https://github.com/CrowdStrike/falconpy/discussions?discussions_q=category%3A%22Show+and+tell%22).
[](https://github.com/CrowdStrike/falconpy/discussions)
> More information regarding FalconPy documentation and support can be found [here](https://github.com/CrowdStrike/falconpy/blob/main/SUPPORT.md).
## Contribute to FalconPy ☕
Interested in [being acknowledged](https://github.com/CrowdStrike/falconpy/blob/main/AUTHORS.md#contributors) as a member of an elite community of security-focused Python developers that **stop breaches**?
There are *many* ways you can contribute to the FalconPy project!
- _Providing feedback_ by opening a GitHub ticket. Even a fly-by "hey, this worked..." is appreciated and helps validate approaches. Ideas on improving the project are most welcome.
- _Documenting, blogging, or creating videos_, of how you've used FalconPy. This type of content is *invaluable* and helps our community grow. Post these in the [Show and Tell](https://github.com/CrowdStrike/falconpy/discussions/categories/show-and-tell) category of our [discussion board](https://github.com/CrowdStrike/falconpy/discussions).
- _Submit a sample_ demonstrating how you're using FalconPy by opening a pull request for inclusion in the [Samples Library](https://github.com/CrowdStrike/falconpy/tree/main/samples).
- _Fix a bug or implement a new feature_. Check out our [open issues on GitHub](https://github.com/CrowdStrike/falconpy/issues) or our [discussion board](https://github.com/CrowdStrike/falconpy/discussions) for inspiration.
- _Review pull requests_ by going through the queue of [open pull requests on GitHub](https://github.com/CrowdStrike/falconpy/pulls) and giving feedback to the authors.
To get started, review the [Code of Conduct](https://github.com/CrowdStrike/falconpy/blob/main/CODE_OF_CONDUCT.md) for community guidelines, and the [contribution guide](https://github.com/CrowdStrike/falconpy/blob/main/CONTRIBUTING.md) for more detail regarding contributing to the CrowdStrike FalconPy project.
---
<p align="center"><img src="https://raw.githubusercontent.com/CrowdStrike/falconpy/main/docs/asset/cs-logo-footer.png"><BR/><img width="250px" src="https://raw.githubusercontent.com/CrowdStrike/falconpy/main/docs/asset/adversary-red-eyes.png"></P>
<h3><P align="center">WE STOP BREACHES</P></h3>
Raw data
{
"_id": null,
"home_page": null,
"name": "crowdstrike-falconpy",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "Joshua Hiller <falconpy@crowdstrike.com>",
"keywords": "api, crowdstrike, crowdstrike-falcon, devsecops, falcon, oauth2, sdk",
"author": null,
"author_email": "CrowdStrike <falconpy@crowdstrike.com>",
"download_url": "https://files.pythonhosted.org/packages/a9/35/9265f7483c869db83c6b4c809f308ce42c631be52d1f2b05a9c3c5a066f3/crowdstrike_falconpy-1.4.6.tar.gz",
"platform": null,
"description": "\n\n[](https://reddit.com/r/crowdstrike)<br/>\n\n# FalconPy - The CrowdStrike Falcon SDK for Python\n\n[](https://pypi.org/project/crowdstrike-falconpy/)\n[](https://pypi.org/project/crowdstrike-falconpy/#history)\n[](https://github.com/CrowdStrike/falconpy/releases)\n[](https://github.com/CrowdStrike/falconpy/graphs/code-frequency)\n[](https://github.com/CrowdStrike/falconpy/commits/main)\n\n\nThe FalconPy SDK contains a collection of Python classes that abstract CrowdStrike Falcon OAuth2 API interaction, removing duplicative code and allowing developers to focus on just the logic of their solution requirements.\n\n+ [Overview](#overview-)\n+ [Quick Start](#quick-start-)\n+ [Documentation and Support](#documentation-and-support-)\n+ [Contribute to FalconPy](#contribute-to-falconpy-)\n\n## Overview \ud83d\udd0e\nThere are many CrowdStrike Falcon API [service collections](https://www.falconpy.io/Operations/Operations-by-Collection.html) collectively containing hundreds of [individual operations](https://www.falconpy.io/Operations/All-Operations.html), all of which are accessible to your project via FalconPy.\n\nThe CrowdStrike Falcon SDK for Python completely abstracts token management, while also supporting interaction with all CrowdStrike regions, custom connection and response timeouts, routing requests through a list of proxies, disabling SSL verification, and custom header configuration.\n\n> If the CrowdStrike APIs were rings of great power, that the Dark Lord Sauron gifted to the kings of dwarves, elves and men, then CrowdStrike's FalconPy would be the One Ring.\n> \n> _\"One SDK to rule them all, One SDK to find them, One SDK to bring them all and in the darkness bind them.\"_\n\n[](https://pepy.tech/project/crowdstrike-falconpy)\n[](https://pepy.tech/project/crowdstrike-falconpy-dev)\n\n#### Supported versions of Python\nThe CrowdStrike Falcon SDK for Python was developed for Python 3. Current versions of FalconPy provide support for Python versions `3.7` - `3.12`. Every commit to the FalconPy code base is unit tested for functionality using all versions of Python the library currently supports.\n\n> [!NOTE]\n> Developers working with Python version `3.6` will need to leverage versions of FalconPy less than `1.4.0`.\n\n[](https://pypi.org/project/crowdstrike-falconpy/#files)\n[](https://pypi.org/project/crowdstrike-falconpy/#files)\n[](https://github.com/CrowdStrike/falconpy/actions/workflows/unit_testing_ubuntu.yml)\n\n#### Supported Operating Systems\nThe FalconPy SDK is unit tested on the following operating systems.\n\n[](https://www.apple.com/macos/)\n[](https://ubuntu.com/)\n[](https://www.microsoft.com/en-us/windows/)\n\nFalconPy will also run on any of the following operating systems.\n\n[](https://aws.amazon.com/amazon-linux-ami/)\n[](https://www.centos.org/)\n[](https://getfedora.org/)\n[](https://www.redhat.com/en/technologies/linux-platforms/enterprise-linux)\n[](https://archlinux.org/)\n\n[](https://www.debian.org/)\n[](https://www.kali.org/)\n[](https://pop.system76.com/)\n[](https://www.suse.com/)\n[](https://www.opensuse.org/)\n\nDetails regarding supported operating systems and Python versions, and project security and testing procedures can be found [here](https://github.com/CrowdStrike/falconpy/blob/main/SECURITY.md).\n\n### Components\nThe FalconPy SDK provides two distinct methods for interacting with CrowdStrike's API. \n\n| **[Service Classes](#service-classes)** | **[The Uber Class](#the-uber-class)** |\n| :-- | :-- |\n| <BR/>[](#service-classes) | [](#the-uber-class) | \n| Each Service Class represents a single CrowdStrike API service collection providing an interface to the [operations available](https://www.falconpy.io/Operations/Operations-by-Collection.html) within that service collection.| An all-in-one class that provides a singular interface for [all operations](https://www.falconpy.io/Operations/All-Operations.html) in every CrowdStrike API service collection. |\n\n\n### Service Classes\nRepresenting a single CrowdStrike Falcon API service collection, each Service Class has a method defined for [every operation available](https://www.falconpy.io/Operations/Operations-by-Collection.html) within that service collection.\n\n#### Available Service Classes\nFor each CrowdStrike Falcon API service collection, a matching Service Class is available in the FalconPy library. For a complete list of service collections and their related Service Class, please review the [Operations by Collection](https://www.falconpy.io/Operations/Operations-by-Collection.html) page on [falconpy.io](https://falconpy.io).\n\n\n#### Service Class benefits\n\n- Closely follows Python and OpenAPI best practice for code style and syntax. PEP-8 compliant.\n- Completely abstracts token management, automatically refreshing your token when it expires.\n- Interact with newly released API operations not yet available in the library via the `override` method.\n- Provides simple programmatic patterns for interacting with CrowdStrike Falcon APIs.\n- Supports [cloud region autodiscovery](https://www.falconpy.io/Usage/Environment-Configuration.html#cloud-region-autodiscovery) for the CrowdStrike `US-1`, `US-2` and `EU-1` regions.\n- Supports dynamic [configuration](https://www.falconpy.io/Usage/Environment-Configuration.html) based upon the needs of your environment.\n- Supports CrowdStrike Falcon API [parameter abstraction](https://www.falconpy.io/Usage/Payload-Handling.html#parameter-abstraction) functionality.\n- Supports CrowdStrike Falcon API [body payload abstraction](https://www.falconpy.io/Usage/Payload-Handling.html#body-payload-abstraction) functionality.\n\n### The Uber Class\nOperating as a single harness for interacting with the entire CrowdStrike Falcon API, the _Uber Class_ can access [every available operation](https://www.falconpy.io/Operations/All-Operations.html) within [every API service collection](https://www.falconpy.io/Operations/Operations-by-Collection.html).\n\n\n#### Uber Class benefits\n\n- Access every CrowdStrike Falcon API service collection with only one import and only one class.\n- Completely abstracts token management, automatically refreshing your token when it expires.\n- Interact with newly released API operations not yet available in the library via the [`override`](https://www.falconpy.io/Usage/Basic-Uber-Class-usage.html#the-command-method) keyword.\n- Provides simple programmatic patterns for interacting with CrowdStrike Falcon APIs.\n- Supports [cloud region autodiscovery](https://www.falconpy.io/Usage/Environment-Configuration.html#cloud-region-autodiscovery) for the CrowdStrike `US-1`, `US-2` and `EU-1` regions.\n- Supports CrowdStrike Falcon API [parameter abstraction](https://www.falconpy.io/Usage/Payload-Handling.html#parameter-abstraction) functionality.\n- Supports all [environment configuration](https://www.falconpy.io/Usage/Environment-Configuration.html) options supported by FalconPy Service Classes.\n\n\n### Comparing FalconPy class types\nWhile the [usage syntax](https://www.falconpy.io/Usage/Basic-Uber-Class-usage.html) varies slightly, the Uber Class provides the same performance and [output](https://www.falconpy.io/Usage/Response-Handling.html) as FalconPy Service Classes, and can perform all of the same [operations](https://www.falconpy.io/Operations/All-Operations.html). The Uber Class does **not** support [body payload abstraction](https://www.falconpy.io/Usage/Payload-Handling.html#body-payload-abstraction).\n\n\n<img width=\"1\" src=\"data:image/gif;base64,R0lGODlhAQABAIAAAP///wAAACH5BAEAAAAALAAAAAABAAEAAAICRAEAOw==\">\n\n\n\n\n## Quick Start \ud83d\udcab\n\nStable releases of FalconPy are available on the Python Package Index. In a terminal, execute the following command:\n\n```shell\npython3 -m pip install crowdstrike-falconpy\n```\n\nOnce installed, you can immediately begin using CrowdStrike functionality in your Python projects.\n\n```python\n\"\"\"CrowdStrike FalconPy Quick Start.\"\"\"\nimport os\nfrom falconpy import Hosts\n\n# Use the API Clients and Keys page within your Falcon console to generate credentials.\n# You will need to assign the Hosts: READ scope to your client to run this example.\n\n# CrowdStrike does not recommend you hardcode credentials within source code.\n# Instead, provide these values as variables that are retrieved from the environment,\n# read from an encrypted file or secrets store, provided at runtime, etc.\n# This example retrieves credentials from the environment as the variables\n# \"FALCON_CLIENT_ID\" and \"FALCON_CLIENT_SECRET\".\n\nhosts = Hosts(client_id=os.getenv(\"FALCON_CLIENT_ID\"),\n client_secret=os.getenv(\"FALCON_CLIENT_SECRET\")\n )\n\nSEARCH_FILTER = \"hostname-search-string\"\n\n# Retrieve a list of hosts that have a hostname that matches our search filter\nhosts_search_result = hosts.query_devices_by_filter(filter=f\"hostname:*'*{SEARCH_FILTER}*'\")\n\n# Confirm we received a success response back from the CrowdStrike API\nif hosts_search_result[\"status_code\"] == 200:\n hosts_found = hosts_search_result[\"body\"][\"resources\"]\n # Confirm our search produced results\n if hosts_found:\n # Retrieve the details for all matches\n hosts_detail = hosts.get_device_details(ids=hosts_found)[\"body\"][\"resources\"]\n for detail in hosts_detail:\n # Display the AID and hostname for this match\n aid = detail[\"device_id\"]\n hostname = detail[\"hostname\"]\n print(f\"{hostname} ({aid})\")\n else:\n print(\"No hosts found matching that hostname within your Falcon tenant.\")\nelse:\n # Retrieve the details of the error response\n error_detail = hosts_search_result[\"body\"][\"errors\"]\n for error in error_detail:\n # Display the API error detail\n error_code = error[\"code\"]\n error_message = error[\"message\"]\n print(f\"[Error {error_code}] {error_message}\")\n```\n\n### More samples\nIf you are interested in reviewing more examples of FalconPy usage, this repository also maintains a collection of [samples](https://github.com/CrowdStrike/falconpy/tree/main/samples) to help get you started with integrating CrowdStrike Falcon into your DevOps processes.\n\n## Documentation and Support \ud83d\udcd6\nFalconPy is a community-driven, open source project designed to assist developers in leveraging the power of CrowdStrike APIs within their solutions. While not a formal CrowdStrike product, FalconPy is maintained by CrowdStrike and supported in partnership with the open source developer community.\n\n### Official Project Documentation: [falconpy.io](https://falconpy.io)\n\n[](https://falconpy.io)\n\n\nExtended documentation is also available via the [wiki](https://github.com/CrowdStrike/falconpy/wiki) for this repository.\n\n### Issues and Questions\n\nIs something going wrong? \ud83d\udd25\n\nGitHub Issues are used to report bugs and errors.\n\n[](https://github.com/CrowdStrike/falconpy/issues/new/choose)\n\nHave a question you can't find answered in the documentation?\n\nPlease submit usage questions to the Q&A section of our discussion board.\n\n[](https://github.com/CrowdStrike/falconpy/discussions?discussions_q=category%3AQ%26A)\n\n### Community forums\n\nThe discussion board for this repository also provides the community with means to communicate regarding [enhancements ideas](https://github.com/CrowdStrike/falconpy/discussions?discussions_q=category%3AIdeas), [integration examples](https://github.com/CrowdStrike/falconpy/discussions/496) and [new releases](https://github.com/CrowdStrike/falconpy/discussions?discussions_q=category%3A%22Show+and+tell%22).\n\n[](https://github.com/CrowdStrike/falconpy/discussions)\n\n> More information regarding FalconPy documentation and support can be found [here](https://github.com/CrowdStrike/falconpy/blob/main/SUPPORT.md).\n\n\n## Contribute to FalconPy \u2615\nInterested in [being acknowledged](https://github.com/CrowdStrike/falconpy/blob/main/AUTHORS.md#contributors) as a member of an elite community of security-focused Python developers that **stop breaches**? \n\nThere are *many* ways you can contribute to the FalconPy project! \n\n- _Providing feedback_ by opening a GitHub ticket. Even a fly-by \"hey, this worked...\" is appreciated and helps validate approaches. Ideas on improving the project are most welcome.\n- _Documenting, blogging, or creating videos_, of how you've used FalconPy. This type of content is *invaluable* and helps our community grow. Post these in the [Show and Tell](https://github.com/CrowdStrike/falconpy/discussions/categories/show-and-tell) category of our [discussion board](https://github.com/CrowdStrike/falconpy/discussions).\n- _Submit a sample_ demonstrating how you're using FalconPy by opening a pull request for inclusion in the [Samples Library](https://github.com/CrowdStrike/falconpy/tree/main/samples).\n- _Fix a bug or implement a new feature_. Check out our [open issues on GitHub](https://github.com/CrowdStrike/falconpy/issues) or our [discussion board](https://github.com/CrowdStrike/falconpy/discussions) for inspiration.\n- _Review pull requests_ by going through the queue of [open pull requests on GitHub](https://github.com/CrowdStrike/falconpy/pulls) and giving feedback to the authors.\n\nTo get started, review the [Code of Conduct](https://github.com/CrowdStrike/falconpy/blob/main/CODE_OF_CONDUCT.md) for community guidelines, and the [contribution guide](https://github.com/CrowdStrike/falconpy/blob/main/CONTRIBUTING.md) for more detail regarding contributing to the CrowdStrike FalconPy project.\n\n\n---\n\n\n<p align=\"center\"><img src=\"https://raw.githubusercontent.com/CrowdStrike/falconpy/main/docs/asset/cs-logo-footer.png\"><BR/><img width=\"250px\" src=\"https://raw.githubusercontent.com/CrowdStrike/falconpy/main/docs/asset/adversary-red-eyes.png\"></P>\n<h3><P align=\"center\">WE STOP BREACHES</P></h3>\n",
"bugtrack_url": null,
"license": "This is free and unencumbered software released into the public domain.\n \n Anyone is free to copy, modify, publish, use, compile, sell, or\n distribute this software, either in source code form or as a compiled\n binary, for any purpose, commercial or non-commercial, and by any\n means.\n \n In jurisdictions that recognize copyright laws, the author or authors\n of this software dedicate any and all copyright interest in the\n software to the public domain. We make this dedication for the benefit\n of the public at large and to the detriment of our heirs and\n successors. We intend this dedication to be an overt act of\n relinquishment in perpetuity of all present and future rights to this\n software under copyright law.\n \n THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND,\n EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF\n MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.\n IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR\n OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,\n ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR\n OTHER DEALINGS IN THE SOFTWARE.\n \n For more information, please refer to <https://unlicense.org>",
"summary": "The CrowdStrike Falcon SDK for Python",
"version": "1.4.6",
"project_urls": {
"Documentation": "https://www.falconpy.io",
"Homepage": "https://github.com/CrowdStrike/falconpy",
"Source": "https://github.com/CrowdStrike/falconpy/tree/main/src/falconpy",
"Tracker": "https://github.com/CrowdStrike/falconpy/issues"
},
"split_keywords": [
"api",
" crowdstrike",
" crowdstrike-falcon",
" devsecops",
" falcon",
" oauth2",
" sdk"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "c9ce639451ad4e5bb9fd1a4943a5a314d0bfb6ea3a5683213b788ac7973f9857",
"md5": "a096dc0e42fa47936bd611a76f1ee48f",
"sha256": "f927508ed221bca5736f0f4d697d6e070753ac64419cbbde212b5ee463f667ff"
},
"downloads": -1,
"filename": "crowdstrike_falconpy-1.4.6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a096dc0e42fa47936bd611a76f1ee48f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 743125,
"upload_time": "2024-11-01T20:57:35",
"upload_time_iso_8601": "2024-11-01T20:57:35.071896Z",
"url": "https://files.pythonhosted.org/packages/c9/ce/639451ad4e5bb9fd1a4943a5a314d0bfb6ea3a5683213b788ac7973f9857/crowdstrike_falconpy-1.4.6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "a9359265f7483c869db83c6b4c809f308ce42c631be52d1f2b05a9c3c5a066f3",
"md5": "0808abadbe18ec882492d526c0449dab",
"sha256": "01d134570d0b3682e01de9474e56cbcda7bc7ba02413dcf32c1f4d9077859fa8"
},
"downloads": -1,
"filename": "crowdstrike_falconpy-1.4.6.tar.gz",
"has_sig": false,
"md5_digest": "0808abadbe18ec882492d526c0449dab",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 551137,
"upload_time": "2024-11-01T20:57:33",
"upload_time_iso_8601": "2024-11-01T20:57:33.076866Z",
"url": "https://files.pythonhosted.org/packages/a9/35/9265f7483c869db83c6b4c809f308ce42c631be52d1f2b05a9c3c5a066f3/crowdstrike_falconpy-1.4.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-01 20:57:33",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "CrowdStrike",
"github_project": "falconpy",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "crowdstrike-falconpy"
}
