FortiOS#

Complete Python SDK for FortiOS/FortiGate automation with 100% API coverage (1,348 endpoints: 561 CMDB + 490 Monitor + 286 Log + 11 Service).

⚡ Quick Start

Get up and running in 5 minutes - install, connect, and make your first API calls.

Quick Start Guide

🎨 Custom Wrappers

Build your own convenience wrappers - aliases, validation, domain-specific abstractions.

Creating Custom Wrappers and Aliases

� User Guide

Learn core concepts and patterns.

User Guide

� Methods and Usage

Learn how to use SDK methods - usage patterns and examples.

Methods and Usage

�📚 API Reference

Complete endpoint reference - 1,348 endpoints across CMDB, Monitor, Log, and Service.

API Reference

� FortiManager Proxy

Manage multiple FortiGates through FortiManager with seamless API routing.

FortiManager Proxy

📋 Topic Guides

Advanced topics and patterns.

Topic Guides

Quick Example#

from hfortix_fortios import FortiOS

# Connect to FortiGate
fgt = FortiOS(host="192.168.1.99", token="your-api-token")

# Create firewall address
fgt.api.cmdb.firewall.address.post(
    name="web-server",
    subnet="10.0.1.100/32",
    comment="Production web server"
)

# Create firewall policy - simple list format (auto-converted)
fgt.api.cmdb.firewall.policy.post(
    name="Allow-Web-Traffic",
    srcintf=["internal"],      # Converted to [{"name": "internal"}]
    dstintf=["wan1"],          # Converted to [{"name": "wan1"}]
    srcaddr=["all"],           # Converted to [{"name": "all"}]
    dstaddr=["web-server"],    # Converted to [{"name": "web-server"}]
    service=["HTTP", "HTTPS"], # Converted to [{"name": "..."}]
    action="accept",
    nat="enable"
)

# Close connection when done
fgt.close()

Or use context manager for automatic cleanup:

from hfortix_fortios import FortiOS

# Context manager automatically closes connection
with FortiOS(host="192.168.1.99", token="your-api-token") as fgt:
    # Create resources
    fgt.api.cmdb.firewall.address.post(
        name="web-server",
        subnet="10.0.1.100/32"
    )

    # Query data
    addresses = fgt.api.cmdb.firewall.address.get()

# Connection automatically closed after with block

# Get system status
status = fgt.api.monitor.system.status.get()
print(f"Hostname: {status['hostname']}")
print(f"Version: {status['version']}")

Key Features#

Complete API Coverage: All 1,348 FortiOS 7.6.5 API endpoints: 561 CMDB + 490 Monitor + 286 Log + 11 Service endpoints.
Dual Interface Patterns: Use dict-style or kwargs-style - choose what fits your workflow.
Full Async Support: All endpoints available in async/await with _async suffix.
Direct API Access (New in v0.5.0): Use request() method for zero-translation workflow - copy JSON from FortiGate GUI, paste into Python.
Production Ready: Circuit breaker pattern, automatic retries, connection pooling, comprehensive validation.
Comprehensive Testing: 1,447 schema validator tests (100% endpoint coverage), 80+ live integration tests, CI/CD ready.
Developer Friendly: 100% type hints with .pyi stubs, extensive documentation, rich error messages, validation framework.

Supported FortiOS Versions#

FortiOS 7.6.x - Full support
FortiOS 7.4.x - Compatible
FortiOS 7.2.x - Compatible
FortiOS 7.0.x - Compatible
FortiOS 6.x - Most features work

API Categories#

The FortiOS API is organized into four main types:

CMDB (Configuration): 561 endpoints for managing firewall configuration: addresses, policies, routes, VPN, system settings, etc.
Monitor (Status/Stats): 490 endpoints for real-time monitoring: system status, interface stats, routing tables, VPN status, etc.
Log (Historical Data): 286 endpoints for accessing historical logs and events with full parameterization support.
Service (Operations): 11 endpoints for service-level operations and special actions.

See API Reference for complete category listing.

Next Steps#

Install - Installation
Quick Start - Quick Start Guide
Authentication - Authentication
Browse Examples - /fortios/examples/index
Explore API - API Reference