pyfsr¶
A modern, typed Python client for the FortiSOAR REST API — record CRUD, a fluent query DSL, Pydantic models, and a framework-agnostic tool registry for driving FortiSOAR from an LLM agent.
pip install pyfsr
from pyfsr import FortiSOAR
client = FortiSOAR("soar.example.com", "your-api-token")
alerts = client.alerts.list()
Install pyfsr, connect to an appliance, and make your first calls.
API keys vs. username/password, SSL options, and environment config.
Generic CRUD over any module, typed models, and picklist resolution.
Build FortiSOAR queries fluently with the Query DSL and paginate results.
Create modules, add and alter fields, track pending changes, and publish.
Every field type, its properties, and how relationship fields wire to other modules.
Discover, configure, execute, and install connectors; manage remote agents.
Author playbooks in YAML, compile them, and deploy through the API or CLI.
Expose FortiSOAR as tools to Claude, OpenAI, or the bundled MCP server.
Administer the appliance over SSH: services, DB, queues, logs, HA, certs.
The complete, auto-generated reference for every module and class.