docs

FalconPy Project Documentation

Where can I find help?

falconpy.io

Our primary documentation resource is located at falconpy.io. This website contains usage details for all classes, a complete listing of all service collections and API operations with code samples for each operation, and is searchable.

Repository wiki

The wiki for this repository also maintains an exact replica of the content maintained on falconpy.io.

Docstrings

Service Classes provide internal documentation for available API operations within their docstrings. You can use the built-in Python help method to retrieve this documentation if it is not available within your IDE.

from falconpy import Hosts

help(Hosts)

Discussion forums

Our community maintains a discussion board for interacting about FalconPy usage and for handling questions. This content is labeled by API and fully searchable. Check there to see if someone else hasn't encountered the issue you are having. If they haven't, please submit your question to the community. We want to help!