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.2.tar.gz (35.4 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.2-py3-none-any.whl (34.8 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for fortiedr-3.9.2.tar.gz
Algorithm Hash digest
SHA256 5338cac1506ed5fb0b72e44abd39877d5d9b733a1dfbb94ddffe15f84f35d36f
MD5 c49f00db6aef9d584362773d835c59b1
BLAKE2b-256 4a9aaca32f1d0b8a9022fe6f42025aa5546cfcfb2430e22259ebf61a346fb43b

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for fortiedr-3.9.2-py3-none-any.whl
Algorithm Hash digest
SHA256 3ebfa5c056d844d74f20347373aea37e446a2210ebc4e96d8961186a6759de4a
MD5 3becc9d3044b21904c10f83f2078ac1e
BLAKE2b-256 76af186304f262ea0e7cd5279add16b90a72a41ead8df7c185c8ef54936a4f94

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