Skip to main content
Manages authenticated connections to the Fiddler platform. The Connection class handles all aspects of connecting to and communicating with the Fiddler platform, including authentication, HTTP client management, server version compatibility checking, and organization context management. This class provides the foundation for all API interactions with Fiddler, managing connection parameters, authentication tokens, and ensuring proper communication protocols are established.

Example

# Creating a basic connection
connection = Connection(
    url="https://your-instance.fiddler.ai",
    token="your-auth-token"
)

# Creating a connection with custom timeout and proxy
connection = Connection(
    url="https://your-instance.fiddler.ai",
    token="your-auth-token",
    timeout=(5.0, 30.0),  # (connect_timeout, read_timeout)
    proxies={"https": "https://proxy.company.com:8080"}
)

# Creating a connection without SSL verification
connection = Connection(
    url="https://your-instance.fiddler.ai",
    token="your-auth-token",
    verify=False,  # Not recommended for production
    validate=False  # Skip version compatibility check
)
Initialize a connection to the Fiddler platform.

Parameters

url
str
required
The base URL to your Fiddler platform instance
token
str
required
Authentication token obtained from the Fiddler UI
proxies
dict | None
default:"None"
Dictionary mapping protocol to proxy URL for HTTP requests
timeout
float | tuple[float, float] | None
default:"None"
HTTP request timeout settings (float or tuple of connect/read timeouts)
verify
bool
default:"True"
Whether to verify server’s TLS certificate (default: True)
validate
bool
default:"True"
Whether to validate server/client version compatibility (default: True)

Raises

  • ValueError – If url or token parameters are empty
  • IncompatibleClient – If server version is incompatible with client version

property client

Get the HTTP request client instance for API communication.

Returns

Configured HTTP client with authentication headers, proxy settings, and timeout configurations.

property server_info

Get server information and metadata from the Fiddler platform.

Returns

Server information including version, organization details, and platform configuration.

property server_version

Get the semantic version of the connected Fiddler server.

Returns

Semantic version object representing the server version.

property organization_name

Get the name of the connected organization.

Returns

Name of the organization associated with this connection.

property organization_id

Get the UUID of the connected organization.

Returns

Unique identifier of the organization associated with this connection.