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.
This SDK provides two distinct methods for interacting with CrowdStrike's Falcon OAuth2 APIs: Service Classes and the Uber Class.
Representing a single API service collection, each service class has a method defined for every operation available in that service collection.
Provides a single harness for interacting with the entire API, covering every available operation within every API service collection.
api_complete.py - The Uber Class provides an interface to all CrowdStrike APIs with a single handler. This solution supports communicating with API endpoints that do not have an available Service Class or are recently released.
Stable releases of FalconPy are available on the Python Package Index:
python3 -m pip install crowdstrike-falconpy
If you'd like to try the absolute bleeding edge, an automated GitHub action releases a test package with every merged pull request containing the string
[DEPLOY]
in the head of the commit.
To install this testing version of the package, use the command:
python3 -m pip install -i https://test.pypi.org/simple crowdstrike-falconpy
To uninstall and remove FalconPy:
python3 -m pip uninstall crowdstrike-falconpy
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 communities grow. Open a pull request for inclusion in the Documentation and Collateral section.
- Fix a bug or implement a new feature. Check out our open issues on GitHub for inspiration.
- Review pull requests by going through the queue of open pull requests on GitHub and giving feedback to the authors.
Review CONTRIBUTING.md for more details regarding contributing to the FalconPy project.
Open to do something else but not sure where to start? Try opening an issue or posting a topic on our discussion board to introduce yourself and your interests. We look forward to chatting with you!
FalconPy is an open source project, not a formal CrowdStrike product, to assist developers implement CrowdStrike's APIs within their applications. As such it carries no formal support, expressed or implied.
๐ฅ Is something going wrong? ๐ฅ
GitHub Issues are used to report bugs. Submit a ticket here:
https://github.com/CrowdStrike/falconpy/issues/new/choose
GitHub Discussions provide the community with means to communicate. There are four discussion categories:
- ๐ฌ General: Catch all for general discussions.
- ๐ก Ideas: Have a suggestion for a feature request? Is there something the community or project could improve upon? Let us know here.
- ๐ Q&A: Have a question about how to accomplish something? A usability question? Submit them here!
- ๐ Show and Tell: Share with the community what you're up to! Perhaps this is letting everyone know about your upcoming conference talk, sharing a project that has embedded FalconPy, or your recent blog.
See the wiki for extended documentation: https://github.com/CrowdStrike/falconpy/wiki.
Coming soon.
Coming soon.