Skip to main content
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.

Attributes

Base URL of the Fiddler platform instance
API key obtained from the Fiddler UI Credentials tab (named token for backward compatibility)
Optional proxy configuration for HTTP requests
HTTP request timeout settings
Whether to verify SSL/TLS certificates
HTTP headers including authentication and client info

Examples

Creating a basic connection:
Creating a connection with custom timeout and proxy:
Creating a connection without SSL verification:
Initialize a connection to the Fiddler platform.

Parameters

str
required
The base URL to your Fiddler platform instance
str
required
API key obtained from the Fiddler UI Credentials tab
dict | None
default:"None"
Dictionary mapping protocol to proxy URL for HTTP requests
float | tuple[float, float] | None
default:"None"
HTTP request timeout settings (float or tuple of connect/read timeouts)
bool
default:"True"
Whether to verify server’s TLS certificate (default: True)
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.