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.
Issues may be reported here and are used to track bugs, documentation and link updates, enhancement requests and security concerns.
Whenever possible, please try to format issues and questions in the Minimal, Complete, and Verifiable Example format. This format reduces "noise", allowing the community to better understand your concern, and provide you with a solution more quickly. This also reduces the likelihood of confidential environment details being accidentally shared within your post.
MCVE formatted code examples provided within issues or questions should be:
- Minimal: Provide as little as code as possible to produce the problem.
- Only provide the statements required to create an example of the issue.
- Use simple, descriptive names for functions and variables. Don't just copy your existing code.
- Do not include real data. Mock data examples to describe the format used, but do not provide real values.
- Complete: Provide all the necessary programmatic pieces to recreate the issue.
- Do not provide screenshots of code.
- Use
code blocksfor each file or snippet. Include a description with each block. - Provide all error messages received, including the complete traceback.
- Reproducible: Provide code that reliably reproduces the problem.
- Provide as much detail regarding the problem as possible.
- Test your example to make sure it produces consistent results.
To read more about MCVE format, review this post on Stack Overflow. For tips on how to properly format questions, check out the blog post by @mrocklin on crafting minimal bug reports.
Generally, we endeavor to provide support for using FalconPy here within the repository. This expands our online knowledge base, enables self-help for our community, and can reduce the amount of time for you to receive answers.
If you are a CrowdStrike customer and you would prefer to have your questions or issues handled directly with CrowdStrike Support, you are welcome to contact the CrowdStrike technical support team.
Depending on the root cause, there is a possibility that an identified issue exceeds the scope of the FalconPy SDK, and may require additional investigation. A maintainer may ask you to contact the CrowdStrike technical support team directly should this occur.
There are also situations where aspects of a support concern cannot be discussed in an online forum, such as:
- customer entitlement
- data sensitivity
- environment configuration
MCVE format is designed to reduce the potential for encountering confidentiality concerns while describing your issue, but cannot speak to every scenario. If one of these concerns impacts your ability to post an issue to this repository, please contact the CrowdStrike technical support team directly making sure to highlight the concern as part of your support request.
Have a question you can't find answered in the documentation or samples?
Find out if anyone else in the community is experiencing the same issue on our discussion board. Your questions are welcome; please submit them to the Q&A section.
Not sure if you're asking a question or submitting an issue? 🤔
Issue reports that do not result in a bug finding, documentation or link update, security alert, or enhancement request are converted into discussions. Discussions that relate to potential errors, documentation and link updates, security concerns or enhancement requests will result in the generation of an issue report. Either button should get the job done.
The discussion board for this repository also provides the community with means to communicate regarding enhancements ideas, integration examples and new releases.
There are four discussion categories:
Purpose |
||
|---|---|---|
| 💬 | 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. |
Official Project Documentation: falconpy.io
Extended documentation is also available via the wiki for this repository.
This content is updated as part of our release cycle and synchronized hourly.
Interested in earning a place on our contributors list?
Join an elite community of security-focused Python coders and help stop breaches.
We want your contributions!
Start here.
