API Reference

The complete, auto-generated reference for every pyfsr module and class.

Module overview

• Client – main FortiSOAR client (pyfsr.client.FortiSOAR)

• Records – generic CRUD over any module (pyfsr.records.RecordSet)

• Query – fluent query DSL (pyfsr.query.Query)

• Pagination – Hydra page helpers (pyfsr.pagination.HydraPage, pyfsr.pagination.paginate())

• Models – typed Pydantic records (Alert, Incident, …)

• Config – environment-driven setup (pyfsr.config.EnvConfig)

• Instances – named multi-appliance client registry (pyfsr.instances.InstanceRegistry)

• Tools – agent tool registry (pyfsr.agent.tools)

• MCP – bundled Model Context Protocol server (pyfsr.agent.mcp)

Full reference

The per-module pages below are auto-generated. They’re listed flat (instead of nested under the pyfsr package) so every module is one click from here.

Core

• pyfsr.client
• pyfsr.records
• pyfsr.query
• pyfsr.pagination
• pyfsr.fields
• pyfsr.config
• pyfsr.instances
• pyfsr.exceptions
• pyfsr.exports

Endpoint APIs & models

• pyfsr.api
• pyfsr.models
• pyfsr.auth

Playbook authoring

• pyfsr.authoring

Agent & MCP

• pyfsr.agent

CLI, appliance & content

• pyfsr.cli
• pyfsr.appliance
• pyfsr.repo
• pyfsr.content_catalog

Advanced & internal

• Advanced & internal