Terminology

Glossary of Terms

Table of contents

The following terms have specific definitions for usage within this repository.

Action	Base URL	Body Payload Abstraction	Bleeding Edge
Class	Code Coverage	Endpoint	Endpoint Module
FalconDebug	FQL / FQL Syntax	HTTP Method	IDP
IOA	IOC	Instance	Issue
Method	ML	Operation	Operation ID
Operation ID syntax	Package	Package Index	Parameter Abstraction
Payload	Payload Module	PEP 8	PEP 257
PR	Release	RTR	Service Class
Service Collection	Swagger	Uber Class	Unit test
Unit testing / Unit test series	ZTA

Definitions

The following definitions are utilized for the terms listed above.

Action

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.

Back to top

Base URL

The base address used for API requests.

Examples: US1 or https://api.crowdstrike.com

FalconPy supports the following CrowdStrike Base URLs:

• US1 - api.crowdstrike.com
• US2 - api.us-2.crowdstrike.com
• EU1 - api.eu-1.crowdstrike.com
• USGOV1 - api.laggar.gcw.crowdstrike.com

Back to top

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.

Back to top

Bleeding Edge

A pre-release version of FalconPy available on the test package index.

Back to top

Class

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)

Back to top

Code Coverage

The percentage of code which is covered by automated unit testing. The FalconPy library maintains 100% code coverage for all released versions.

Back to top

Endpoint

A URL target used to perform a specific API operation.

Back to top

Endpoint Module

The sub-module within FalconPy that contains definitions for every endpoint within the CrowdStrike API.

Back to top

FalconDebug

A helper-class within FalconPy that facilitates payload and module debugging.

Back to top

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.

Back to top

HTTP Method

HTTP operation to perform against an endpoint. (GET, POST, PATCH, PUT, DELETE, UPDATE)

The combination of Endpoint and HTTP Method define a specific API operation.

Back to top

IDP

Shorthand abbreviation for Identity Protection.

Back to top

IOA

Shorthand abbreviation for Indicator of Attack.

Back to top

IOC

Shorthand abbreviation for Indicator of Compromise.

Back to top

Instance

Context: Instance of XYZ Service Class

A single object, constructed or instantiated using a specific class definition.

Back to top

Issue

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.

Back to top

Method

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

Back to top

ML

Shorthand abbreviation for Machine Learning.

Back to top

Operation

Performing a request against a specific endpoint within the CrowdStrike API using one of the allowed HTTP methods to accomplish a specific task.

More detail regarding Operations can be found here.

Back to top

Operation ID

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.

Back to top

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.

Back to top

Package

Generic reference to the installation bundle for the FalconPy library.

Back to top

Package Index

Generic reference to PyPI, the Python Package Index.

Back to top

Parameter Abstraction

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.

Back to top

Payload

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.

Back to top

Payload Module

The sub-module within FalconPy that contains helpers for creating and managing body payloads used for API requests.

Back to top

PEP 8

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.

Back to top

PEP 257

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.

Back to top

PR

Shorthand abbreviation for Pull Request.

Back to top

Release

A formally distributed version of FalconPy, available on the production package index.

Back to top

RTR

Shorthand abbreviation for Real Time Response.

Back to top

Service Class

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.

Back to top

Service Collection

Collection of API endpoints that comprise a specific CrowdStrike offering.

Examples: Detects, Hosts, Real Time Response

Back to top

Swagger

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.

Back to top

Uber Class

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.

Back to top

Unit test

A single test performed using the FalconPy library to confirm programmatic logic executes as intended. One unit test may be compromised of multiple real or simulated API operations.

Back to top

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.

Back to top

ZTA

Shorthand abbreviation for Zero Trust Assessment.

Back to top

Updates

Is there a term referenced within this repository that you feel needs a definition? Let us know by posting to our discussion board!