Skip to main content

This Fortiedr module is an open-source Python library that simplifies interaction with the FortiEDR Cloud API.

Project description

FortiEDR Python module

An open-source Python package intended to help interact with FortiEDR API.

See changelog for more.

How do I install the FortiEDR Python module?

Be sure you have at least Python 3.8 and PIP (https://pypi.org/project/pip/) installed.

After downloading this tool, use pip to install dependencies using the following command:

pip install fortiedr

Or you can download it directly from this repo:

git clone https://github.com/rafaelfoster/fortiedr.git

cd fortiedr

pip3 install .

First steps with fortiedr

First of all, create a Rest API user on FortiEDR Management console:

After creating a user with privileges for interacting with FortiEDR API, you can start using the package by importing the modules you want to your code:

import fortiedr

Once imported, you need to authenticate with Management Host using valid credentials, as such:

organization = "ORGANIZATION_NAME"

authentication = auth(
    user="USER",
    passw="PASSWORD",
    host="FORTIEDR_HOST.COM", # use only the hostname, without 'https://' and '/'.
    org=organization          # Add organization IF needed. Case sensitive
)

If the authentication is successful, you can proceed by interacting with the API, like:

collectors = fortiedr.Collectors()

data = collectors.list_collectors()

How do I use FortiEDR Python module?

After credentials are defined and successfully authenticated, you are now able to start consuming FortiEDR API.

The "example.py" file contains some examples of how to use the package.

How to contribute, provide feedback, or report bugs?

You can e-mail me at rafaelgfoster at gmail (.) com.

Enjoy it!

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

fortiedr-3.9.tar.gz (35.4 kB view details)

Uploaded Source

Built Distribution

fortiedr-3.9-py3-none-any.whl (34.8 kB view details)

Uploaded Python 3

File details

Details for the file fortiedr-3.9.tar.gz.

File metadata

  • Download URL: fortiedr-3.9.tar.gz
  • Upload date:
  • Size: 35.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.9.19

File hashes

Hashes for fortiedr-3.9.tar.gz
Algorithm Hash digest
SHA256 93d5823a0393e1f7fe4c025d752d6e1f8a9ed80dcd932e7e0cade9e43e5b2b93
MD5 6ead115110ffc54f41710cdc94ebf6b8
BLAKE2b-256 455173f71bfb1611c8b7e862ec07d3700835d2c00e286aea3dff799f6986ec93

See more details on using hashes here.

File details

Details for the file fortiedr-3.9-py3-none-any.whl.

File metadata

  • Download URL: fortiedr-3.9-py3-none-any.whl
  • Upload date:
  • Size: 34.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.9.19

File hashes

Hashes for fortiedr-3.9-py3-none-any.whl
Algorithm Hash digest
SHA256 06c3cb5793a67e830c2b5494ea70500ecd24c7588b05bf6c0a4759e4aa35026b
MD5 06b38a65a5f84bc3200502c217864ab7
BLAKE2b-256 2d177fe2a08443ea8289d57b8ee82d5aca6e5d7b8486d532c5b75e547416e20b

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page