The Client object is used to communicate with Fiddler. In order to use the client, you'll need to provide authentication details as shown below.
For more information, see Authorizing the Client.
| Parameter | Type | Default | Description |
|---|---|---|---|
| url | str | None | The URL used to connect to Fiddler |
| org_id | str | None | The organization ID for a Fiddler instance. Can be found on the General tab of the Settings page. |
| auth_token | str | None | The authorization token used to authenticate with Fiddler. Can be found on the Credentials tab of the Settings page. |
| proxies | Optional [dict] | None | A dictionary containing proxy URLs. |
| verbose | Optional [bool] | False | If True, client calls will be logged verbosely. |
| verify | Optional [bool] | True | If False, client will allow self-signed SSL certificates from the Fiddler server environment. If True, the SSL certificates need to be signed by a certificate authority (CA). |
Warning
If verbose is set to True, all information required for debugging will be logged, including the authorization token.
Info
To maximize compatibility, please ensure that your client version matches the server version for your Fiddler instance.
When you connect to Fiddler using the code on the right, you'll receive a notification if there is a version mismatch between the client and server.
You can install a specific version of fiddler-client using pip:
pip install fiddler-client==X.X.X
import fiddler as fdl
URL = 'https://app.fiddler.ai'
ORG_ID = 'my_org'
AUTH_TOKEN = 'p9uqlkKz1zAA3KAU8kiB6zJkXiQoqFgkUgEa1sv4u58'
client = fdl.FiddlerApi(
url=URL,
org_id=ORG_ID,
auth_token=AUTH_TOKEN
)
import fiddler as fdl
URL = 'https://app.fiddler.ai'
ORG_ID = 'my_org'
AUTH_TOKEN = 'p9uqlkKz1zAA3KAU8kiB6zJkXiQoqFgkUgEa1sv4u58'
client = fdl.FiddlerApi(
url=URL,
org_id=ORG_ID,
auth_token=AUTH_TOKEN,
verify=False
)
proxies = {
'http' : 'http://proxy.example.com:1234',
'https': 'https://proxy.example.com:5678'
}
client = fdl.FiddlerApi(
url=URL,
org_id=ORG_ID,
auth_token=AUTH_TOKEN,
proxies=proxies
)
If you want to authenticate with Fiddler without passing this information directly into the function call, you can store it in a file named fiddler.ini, which should be stored in the same directory as your notebook or script.
%%writefile fiddler.ini
[FIDDLER]
url = https://app.fiddler.ai
org_id = my_org
auth_token = p9uqlkKz1zAA3KAU8kiB6zJkXiQoqFgkUgEa1sv4u58
client = fdl.FiddlerApi()