ExpandedToggleIcon        Connection Dialog

The following connection options are required:

1.API Version - the Freshdesk API version to use;
2.Host - the URL of your Freshdesk subdomain;
3.API Key - the API Key for authorization;


To get the Freshdesk API key for authorization, perform the following steps:

1.Sign in to your Freshdesk Support Portal
2.Click your profile picture in the top right corner of your portal page.
3.Go to the Profile settings page.
4.Your API key will be available below the change password section to the right.


ExpandedToggleIcon        Advanced Connection Options

The following table describes the options that you can include in the Connection String using the Advanced Connection Editor dialog box:





The API Key used to identify the client application.

API Version

Determines Freshdesk API version to use v1 or v2. Note that API v2 version provides access to more Freshdesk objects than API v1, and the structure of common objects may be different for different API versions.

Connection Lifetime

When a connection is returned to the pool, its creation time is compared with the current time, and the connection is destroyed if that time span (in seconds) exceeds the value specified by Connection Lifetime. The default value is 0 (connection always returns to pool).

Connection Timeout

The length of time (in seconds) to wait for a connection to the server before terminating the attempt and generating an error. The default value is 15.

Failover Retries

The number of retry attempts to automatically re-run a command before displaying an error message in case when the command failed because of an error that may be temporary.

Local SQL Engine

Determines whether to use local SQL engine for SELECT queries, that are too complex to translate them directly to Freshdesk API calls or to show an error message.

Default Command Timeout

The time in seconds to wait while trying to execute a command before terminating the attempt and generating an error.

Max Pool Size

The maximum number of connections allowed in the pool. Setting the Max Pool Size value in the connection string can affect performance. The default value is 100.

Min Pool Size

The minimum number of connections allowed in the pool. The default value is 0.

Persist Security Info

Indicates if security-sensitive information, such as the password, is not returned as part of the connection if the connection is open or has ever been in an open state.


If true, by default, the connection is drawn from the appropriate pool or is created and added to the appropriate pool.

Proxy Host

The host name or IP address of proxy server.

Proxy Password

The password for the proxy server account.

Proxy Port

The port number of the proxy server. The default value is 3128.

Proxy User

The proxy server account name.


Indicates whether the connection is read-only (allows only SELECT statements).


The URL of your Freshdesk subdomain

Token Server

Not used for Freshdesk.

UTC Dates

If set to True, dates will be converted to UTC format during import, and the date values entered by the user (in SELECT statements, etc.) are considered UTC dates when sending them to the data source.