HFortix-Core

Contents:

  • Overview
    • Key Features
    • Architecture
    • Usage
    • Dependencies
    • Next Steps
  • CloudSession - Multi-Service OAuth Management
    • Overview
    • Key Features
    • Basic Usage
      • Simple Multi-Service Authentication
      • Override Client ID
      • Auto-Refresh Mode
      • Advanced Refresh Configuration
      • Manual Token Management
    • Enterprise Features
      • Distributed Token Storage
      • Token Lifecycle Hooks
      • Full Enterprise Setup
    • API Reference
      • CloudSession Class
      • TokenInfo Dataclass
    • Rate Limit Tracking
    • See Also
  • Rate Limiting
    • Overview
    • Key Features (Tracking)
    • Time Windows
    • Basic Usage
      • FortiCare Example
      • FortiZTP Example
      • Session-Wide Tracking
    • Status Response Format
    • Known API Rate Limits
      • FortiCare Asset Management
      • FortiZTP
      • FortiGateCloud
    • Enforcement
    • API Reference
      • RateLimitStats Class (tracking)
        • RateLimitStats
      • RateLimiter Class (enforcement, sync)
      • AsyncRateLimiter Class (enforcement, async)
    • Implementation Details
      • Sliding Window Algorithm
      • Thread Safety
    • Future Enhancements
    • See Also
  • Core Modules
    • HTTP Client Framework
      • IHTTPClient (Protocol Interface)
        • IHTTPClient
      • BaseHTTPClient (Base Client)
        • BaseHTTPClient
      • HTTPClient (Synchronous FortiOS)
        • HTTPClient
      • HTTPClientJSONRPC (Synchronous JSON-RPC, FortiManager/FortiAnalyzer)
      • AsyncHTTPClient (Asynchronous)
        • AsyncHTTPClient
      • CloudHTTPClient (FortiCloud REST)
        • CloudHTTPClient
      • FortiCloudAuth (OAuth2 Authentication)
        • FortiCloudAuth
      • get_oauth_token
        • get_oauth_token()
    • Caching
      • TTLCache
      • readonly_cache
    • Logging
      • RequestLogger
      • log_operation
      • StructuredFormatter
      • TextFormatter
      • LogFormatter (Protocol)
        • LogFormatter
      • LogRecord (TypedDict)
        • LogRecord
    • Debugging
      • DebugSession
      • debug_timer
      • format_connection_stats
      • format_request_info
      • print_debug_info
      • DebugFormatter (Protocol)
        • DebugFormatter
      • DebugInfo (TypedDict)
        • DebugInfo
      • SessionSummary (TypedDict)
        • SessionSummary
    • Formatting
      • fmt Module
        • to_json()
        • to_csv()
        • to_dict()
        • to_multiline()
        • to_list()
        • to_quoted()
        • to_table()
        • to_yaml()
        • to_xml()
        • to_key_value()
        • to_markdown_table()
        • to_dictlist()
        • to_listdict()
    • Audit Logging
      • AuditHandler (Protocol)
      • SyslogHandler
      • FileHandler
      • StreamHandler
      • CompositeHandler
      • NullHandler
      • AuditFormatter (Protocol)
      • JSONFormatter
      • SyslogFormatter
      • CEFFormatter
      • AuditOperation (TypedDict)
    • Request Hooks
  • Exceptions
    • Exception Hierarchy
    • Base Exception
    • API Exceptions
      • RateLimitExceededError
      • RateLimitQueueFullError
      • RateLimitQueueTimeoutError
    • Configuration & Operation Exceptions
    • Retry & Circuit Breaker Exceptions
      • CircuitBreakerError
      • CircuitBreakerTimeoutError
    • Helper Functions
      • raise_for_status()
      • is_retryable_error()
      • get_retry_delay()
      • get_error_description()
      • get_http_status_description()
  • Type Definitions
    • Response Types
    • Connection & Request Types
    • Circuit Breaker Types
  • Utilities
    • Key Normalization
    • Deprecation Warnings
    • Caching Internals
      • CacheEntry
        • CacheEntry.__init__()
        • CacheEntry.is_expired()
    • Formatting Module
      • to_json()
      • to_csv()
      • to_dict()
      • to_multiline()
      • to_list()
      • to_quoted()
      • to_table()
      • to_yaml()
      • to_xml()
      • to_key_value()
      • to_markdown_table()
      • to_dictlist()
      • to_listdict()
HFortix-Core
  • Search

© Copyright 2026, Herman W. Jacobsen.

Built with Sphinx using a theme provided by Read the Docs.