Connection

API reference for Connection

Connection

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

Parameter	Type	Required	Default	Description
url	str	✗	None	The base URL to your Fiddler platform instance
token	str	✗	None	Authentication token obtained from the Fiddler UI
proxies	dict | None	✗	None	Dictionary mapping protocol to proxy URL for HTTP requests
timeout	float | tuple[float, float] | None	✗	None	HTTP request timeout settings (float or tuple of connect/read timeouts)
verify	bool	✗	True	Whether to verify server’s TLS certificate (default: True)
validate	bool	✗	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 Return type: None

property client : RequestClient

Get the HTTP request client instance for API communication.

Returns

Configured HTTP client with authentication headers, proxy settings, and timeout configurations. Return type: RequestClient

property server_info : ServerInfo

Get server information and metadata from the Fiddler platform.

Returns

Server information including version, organization details, and platform configuration. Return type: ServerInfo

property server_version : VersionInfo

Get the semantic version of the connected Fiddler server.

Returns

Semantic version object representing the server version. Return type: VersionInfo

property organization_name : str

Get the name of the connected organization.

Returns

Name of the organization associated with this connection. Return type: str

property organization_id : UUID

Get the UUID of the connected organization.

Returns

Unique identifier of the organization associated with this connection. Return type: UUID