HFortix-Core

Contents:

  • Overview
    • Key Features
    • Architecture
    • Usage
    • Dependencies
    • Next Steps
  • Core Modules
    • HTTP Client Framework
      • IHTTPClient (Protocol Interface)
        • IHTTPClient
      • BaseHTTPClient (Base Client)
        • BaseHTTPClient
      • HTTPClient (Synchronous FortiOS)
        • HTTPClient
      • HTTPClientFMG (Synchronous FortiManager)
        • HTTPClientFMG
      • AsyncHTTPClient (Asynchronous)
        • AsyncHTTPClient
    • Caching
      • TTLCache
        • TTLCache
      • readonly_cache
        • readonly_cache
    • Logging
      • RequestLogger
        • RequestLogger
      • log_operation
        • log_operation()
      • StructuredFormatter
        • StructuredFormatter
      • TextFormatter
        • TextFormatter
      • LogFormatter (Protocol)
        • LogFormatter
      • LogRecord (TypedDict)
        • LogRecord
    • Debugging
      • DebugSession
        • DebugSession
      • debug_timer
        • debug_timer()
      • format_connection_stats
        • format_connection_stats()
      • format_request_info
        • format_request_info()
      • print_debug_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)
        • AuditHandler
      • SyslogHandler
        • SyslogHandler
      • FileHandler
        • FileHandler
      • StreamHandler
        • StreamHandler
      • CompositeHandler
        • CompositeHandler
      • NullHandler
        • NullHandler
      • AuditFormatter (Protocol)
        • AuditFormatter
      • JSONFormatter
        • JSONFormatter
      • SyslogFormatter
        • SyslogFormatter
      • CEFFormatter
        • CEFFormatter
      • AuditOperation (TypedDict)
        • AuditOperation
    • Request Hooks
      • BeforeRequestHook (Protocol)
        • BeforeRequestHook
      • AfterRequestHook (Protocol)
        • AfterRequestHook
      • RequestContext (TypedDict)
        • RequestContext
  • Exceptions
    • Exception Hierarchy
    • Base Exception
      • FortinetError
    • API Exceptions
      • APIError
        • APIError.message
        • APIError.http_status
        • APIError.error_code
        • APIError.response
        • APIError.endpoint
        • APIError.method
        • APIError.params
        • APIError.hint
        • APIError.request_id
        • APIError.timestamp
      • BadRequestError
      • AuthenticationError
      • AuthorizationError
      • PermissionDeniedError
      • ResourceNotFoundError
        • ResourceNotFoundError.suggest_recovery()
      • MethodNotAllowedError
      • DuplicateEntryError
        • DuplicateEntryError.suggest_recovery()
      • EntryInUseError
        • EntryInUseError.suggest_recovery()
      • InvalidValueError
      • RateLimitError
      • ServerError
      • ServiceUnavailableError
    • Configuration & Operation Exceptions
      • ValidationError
        • ValidationError.field
        • ValidationError.value
        • ValidationError.constraint
        • ValidationError.valid_options
        • ValidationError.description
        • ValidationError.example
        • ValidationError.suggestion
      • ConfigurationError
      • VDOMError
        • VDOMError.vdom
      • OperationNotSupportedError
        • OperationNotSupportedError.operation
        • OperationNotSupportedError.endpoint
      • ReadOnlyModeError
    • Retry & Circuit Breaker Exceptions
      • RetryableError
      • NonRetryableError
      • CircuitBreakerOpenError
      • TimeoutError
  • Type Definitions
    • Response Types
      • APIResponse
        • APIResponse.http_status
        • APIResponse.results
        • APIResponse.revision
        • APIResponse.revision_changed
        • APIResponse.old_revision
        • APIResponse.vdom
        • APIResponse.path
        • APIResponse.name
        • APIResponse.status
        • APIResponse.http_method
        • APIResponse.serial
        • APIResponse.version
        • APIResponse.build
        • APIResponse.mkey
      • RawAPIResponse
        • RawAPIResponse.http_method
        • RawAPIResponse.http_status
        • RawAPIResponse.status
        • RawAPIResponse.vdom
        • RawAPIResponse.results
        • RawAPIResponse.path
        • RawAPIResponse.name
        • RawAPIResponse.serial
        • RawAPIResponse.version
        • RawAPIResponse.build
        • RawAPIResponse.mkey
        • RawAPIResponse.revision
        • RawAPIResponse.revision_changed
        • RawAPIResponse.old_revision
      • MutationResponse
        • MutationResponse.http_status
        • MutationResponse.status
      • MutationResponseFull
        • MutationResponseFull.http_status
        • MutationResponseFull.status
        • MutationResponseFull.vdom
        • MutationResponseFull.mkey
        • MutationResponseFull.revision
        • MutationResponseFull.serial
        • MutationResponseFull.version
        • MutationResponseFull.build
      • ListResponse
        • ListResponse.http_status
        • ListResponse.results
        • ListResponse.vdom
        • ListResponse.path
        • ListResponse.name
        • ListResponse.status
        • ListResponse.serial
        • ListResponse.version
        • ListResponse.build
      • ObjectResponse
        • ObjectResponse.http_status
        • ObjectResponse.results
        • ObjectResponse.vdom
        • ObjectResponse.path
        • ObjectResponse.name
        • ObjectResponse.status
        • ObjectResponse.serial
        • ObjectResponse.version
        • ObjectResponse.build
      • ErrorResponse
        • ErrorResponse.http_status
        • ErrorResponse.error
        • ErrorResponse.errorcode
        • ErrorResponse.message
        • ErrorResponse.vdom
    • Connection & Request Types
      • ConnectionStats
        • ConnectionStats.http2_enabled
        • ConnectionStats.max_connections
        • ConnectionStats.max_keepalive_connections
        • ConnectionStats.active_requests
        • ConnectionStats.total_requests
        • ConnectionStats.pool_exhaustion_count
        • ConnectionStats.circuit_breaker_state
        • ConnectionStats.consecutive_failures
        • ConnectionStats.last_failure_time
      • RequestInfo
        • RequestInfo.method
        • RequestInfo.endpoint
        • RequestInfo.params
        • RequestInfo.data
        • RequestInfo.response_time_ms
        • RequestInfo.status_code
        • RequestInfo.timestamp
        • RequestInfo.error
    • Circuit Breaker Types
      • CircuitBreakerState
  • 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
  • HFortix-Core Documentation
  • Edit on GitHub

HFortix-Core Documentation

Contents:

  • Overview
    • Key Features
    • Architecture
    • Usage
    • Dependencies
    • Next Steps
  • Core Modules
    • HTTP Client Framework
    • Caching
    • Logging
    • Debugging
    • Formatting
    • Audit Logging
    • Request Hooks
  • Exceptions
    • Exception Hierarchy
    • Base Exception
    • API Exceptions
    • Configuration & Operation Exceptions
    • Retry & Circuit Breaker Exceptions
  • Type Definitions
    • Response Types
    • Connection & Request Types
    • Circuit Breaker Types
  • Utilities
    • Key Normalization
    • Deprecation Warnings
    • Caching Internals
    • Formatting Module

Installation

pip install hfortix-core

Indices and tables

  • Index

  • Module Index

  • Search Page

Next

© Copyright 2026, Herman W. Jacobsen.

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