Glossary of Terms
Table of contents
The following terms have specific definitions for usage within this documentation.
The following definitions are utilized for the terms listed above.
GitHub-powered workflow that performs specific repository operations.
Example: Package deployment, Unit testing
Not to be confused with the
action keyword used in the Uber Class, or keys potentially found in body and parameter payloads.
The base address used for API requests.
Examples: US1 or https://api.crowdstrike.com
FalconPy supports the following CrowdStrike Base URLs:
|Short name||Base URL|
You may specify the short name or the base URL (with or without
https://) when using the
Body Payload Abstraction
Programmatic logic used to abstract body payload parameters into keywords for use within FalconPy library methods.
More detail about body payload abstraction can be found in the Payload Handling documentation.
A pre-release version of FalconPy available on the test package index.
In object-oriented programming, a class is an extensible program-code-template for creating objects, providing initial values for state (member variables) and implementations of behavior (member functions or methods).
(Definition provided by Wikipedia)
Cloud Region Autodiscovery
Starting in version 0.8.6, developers using the
EU1 regions no
longer need to specify their
base_url as this value is auto-discovered as part of the authentication process.
USGOV1users will still need to provide this value.
|Short name||Base URL||Auto discovery support?|
The percentage of code which is covered by automated unit testing. The FalconPy library maintains 100% code coverage for all released versions.
A combination of HTTP method and route that is used to perform a specific API operation.
The sub-module within FalconPy that contains definitions for every endpoint within the CrowdStrike API.
A helper-class within FalconPy that facilitates payload and module debugging.
FQL / FQL syntax
Falcon Query Language - The syntax used to provide filters and sort specifications to API requests.
More information about FQL can be found here.
HTTP operation (GET, POST, PATCH, PUT, DELETE, UPDATE) to use when sending a request to a specific endpoint route.
The combination of Route and HTTP Method define a specific API operation.
Shorthand abbreviation for Identity Protection.
Shorthand abbreviation for Indicator of Attack.
Shorthand abbreviation for Indicator of Compromise.
Context: Instance of XYZ Service Class
A single object, constructed or instantiated using a specific class definition.
A question, bug or enhancement request for the FalconPy library.
User submitted issues that do not result in a bug finding or enhancement request are converted into discussions and posted to the q & a section of our discussion board.
We want to hear from you! Please let us know of any issues you encounter.
A function defined within a library class or module that executes a discrete sequence of steps. Typically this is in reference to a method that performs a specific API operation.
Examples: query_detects, query_devices_by_filter
method is also used to refer to the HTTP method used to communicate with a specific endpoint route.
Shorthand abbreviation for Machine Learning.
Performing a request against a specific endpoint route within the CrowdStrike API using one of the allowed HTTP methods to accomplish a specific task.
More detail regarding Operations can be found here.
Unique string used to identify an operation from among all available operations within all CrowdStrike API service collections.
More detail regarding Operation IDs can be found here.
Operation ID syntax
FalconPy-specific term for using Operation IDs as the method names within Service Classes for calls that interact with the CrowdStrike API.
Generic reference to the installation bundle for the FalconPy library.
Generic reference to PyPI, the Python Package Index.
Programmatic logic used to abstract query string payload parameters into keywords for use within FalconPy library methods.
More detail about parameter abstraction can be found in the Payload Handling documentation.
In computing and telecommunications, the payload is the part of transmitted data that is the actual intended message. Headers and metadata are sent only to enable payload delivery.
(Definition provided by Wikipedia)
More detail regarding payload types and how they are handled can be found here.
The sub-module within FalconPy that contains helpers for creating and managing
body payloads used for API requests.
Python Enhancement Proposal #8 - A commonly referenced Python enhancement proposal that is used as the programmatic style guide for code implemented within this library.
More details about PEP 8 can be found here.
Python Enhancement Proposal #257 - A commonly referenced Python enhancement proposal that governs the semantics and conventions associated with Python docstrings used within this library.
More details about PEP 257 can be found here.
Shorthand abbreviation for Pull Request.
A formally distributed version of FalconPy, available on the production package index.
The URL address of an endpoint, without the Base URL, that identifies the location of a specific Operation.
Shorthand abbreviation for Real Time Response.
A FalconPy class that represents a single CrowdStrike API service collection, with methods defined for every operation within that service collection.
More detail regarding basic Service Class usage can be found here.
Collection of API endpoints that comprise a specific CrowdStrike offering.
Examples: Detects, Hosts, Real Time Response
Swagger is a set of open-source tools built around the OpenAPI Specification that can help you design, build, document and consume REST APIs.
More detail regarding Swagger / OpenAPI Specification can be found here.
A standalone FalconPy class that provides a singular harness to every operation within every service collection of the CrowdStrike API.
More detail regarding basic Uber Class usage can be found here.
A single test performed using the FalconPy library to confirm programmatic logic executes as intended. One unit test may be comprised of multiple real or simulated API operations.
Unit testing / Unit test series
A series of unit tests performed using the FalconPy library to confirm functionality. Typically performed after a push or merge to the repository, these can also be executed by developers locally. Unit testing is designed to test every available code path within the FalconPy library, not necessarily every element of CrowdStrike API functionality.
Shorthand abbreviation for Zero Trust Assessment.
Is there a term referenced within this repository that you feel needs a definition? Let us know by posting to our discussion board!