Skip to main content

Python modules to use Fortigate APIs

Project description

fortiosAPI Overview

Opensource python library to configure Fortigate/Fortios devices (Fortigate REST API)

Ready for config management.

Compare to the REST API there a few add-ons: In addition to get,put,post,delete methods there is a set which will try to post and if failing will put and collect the mkey directly. The lib will also find the mkey for you


You can find and propose examples here: Separated to avoid cluttering those who integrate the fortiosapi module.

### New overlay configuration

You now have an overlayconfig call which can be pass a complex configuration change in yaml. Including multiple endpoints (name/path) as the simple example below shows:

      "scan-mode": "quick"
      'http': {"options": "scan avmonitor",}
      "emulator": "enable"
      'name': "Testfortiosapi"
      'action': "accept"
      'srcintf': [{"name": "port1"}]
      'dstintf': [{"name": "port2"}]
      'srcaddr': [{"name": "all"}]
      'dstaddr': [{"name": "all"}]
      'schedule': "always"
      'service': [{"name": "HTTPS"}]
      "utm-status": "enable"
      "profile-type": "single"
      'av-profile': "apisettree"
      'profile-protocol-options': "default"
      'ssl-ssh-profile': "certificate-inspection"
      'logtraffic': "all"

The behaviour is to change the parameters at the higher level in the CMDB tree first then do a serie of set on the tables.

Will fail if one of the set fails.

Order in the yaml is preserved.

Login methods


Token (api key) documented in the Fortigate API Spec that you can find if having an account on

Multi vdom

In multi vdom environment use vdom=global in the API call. As it is a reserved word the API will switch to use the global=1 and take care of the differences in the repsonses.


There is a get_schema call and an example to get the schema of the differents methods to ease writting them.

License (5.6)

A rest call to check and force license validation check starting with 5.6 See license. usage of schema and mkey for every call for 5.6

License validity is now checked at login


Test driven development

In tests folder you will find a tox based set of tests as examples. The test_fortiosapi_virsh need you to have virsh access, especially to the console. This allow to perform actions automatically from the CLI and check API calls actual results. Other tests are welcomed.

Files upload/download

You will find the calls to exchange files (config, logs, licenses) with Fortigate in this LIB

Known Usage

Fortiosapi library is used in Home-Assistant, Fortinet Ansible modules and in Cloudify plugins.

Maintained mainly by Fortinet employees.

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

fortiosapi-1.0.5.tar.gz (16.0 kB view hashes)

Uploaded source

Built Distribution

fortiosapi-1.0.5-py2.py3-none-any.whl (19.9 kB view hashes)

Uploaded py2 py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page