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.5.tar.gz (35.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

fortiedr-3.9.5-py3-none-any.whl (34.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: fortiedr-3.9.5.tar.gz
  • Upload date:
  • Size: 35.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.24

File hashes

Hashes for fortiedr-3.9.5.tar.gz
Algorithm Hash digest
SHA256 7bcce71ef73f53d4b5d0f08a1a20d436115e9417fa63eb906f88a5fafe094d07
MD5 c0888c774adf36026ada75ffdf637b02
BLAKE2b-256 b8a11b2b7c0afb98744a8d560afe2e8afb67572adf6ab3749a187e7c6cb3c9e6

See more details on using hashes here.

File details

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

File metadata

  • Download URL: fortiedr-3.9.5-py3-none-any.whl
  • Upload date:
  • Size: 34.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.24

File hashes

Hashes for fortiedr-3.9.5-py3-none-any.whl
Algorithm Hash digest
SHA256 6c107f9dcdbcd605227e9e8d6a0a16df6e19115cc770dfbc936b0ae14d95782a
MD5 18924e70e0017487f006cb4de66df3b0
BLAKE2b-256 65609b3b80196f93040955a56e5ab6e4411b3c1624c5ae20833d7fbc3d903ad5

See more details on using hashes here.

Supported by

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