REST Connection Options
  • Dark
    Light
  • PDF

REST Connection Options

  • Dark
    Light
  • PDF

Auth Scheme The type of authentication to use when connecting to remote services.
Auto Cache Automatically caches the results of SELECT queries into a cache database specified by either CacheLocation or both of CacheConnection and CacheProvider .
AWS Access Key Your AWS account access key. This value is accessible from your AWS security credentials page.
AWS Region The hosting region for your Amazon Web Services.
AWS Role ARN The Amazon Resource Name of the role to use when authenticating.
AWS Secret Key Your AWS account secret key. This value is accessible from your AWS security credentials page.
Azure Access Key The storage key associated with your Azure Blob storage account.
Azure Account The name of your Azure Blob storage account.
Backwards Compatibility Mode Set BackwardsCompatibilityMode to true to use the XML/JSON functionality and features available in the 2017 version.
Batch Size The maximum size of each batch operation to submit.
Cache Connection The connection string for the cache database. This property is always used in conjunction with CacheProvider . Setting both properties will override the value set for CacheLocation for caching data.
Cache Driver The database driver to be used to cache data.
Cache Location Specifies the path to the cache when caching to a file.
Cache Metadata This property determines whether or not to cache the table metadata to a file store.
Cache Tolerance The tolerance for stale data in the cache specified in seconds when using AutoCache .
Callback URL The OAuth callback URL to return to when authenticating. This value must match the callback URL you specify in your app settings.
Connection Life Time The maximum lifetime of a connection in seconds. Once the time has elapsed, the connection object is disposed.
Connect On Open This property species whether to connect to the REST when the connection is opened.
Custom Headers Other headers as determined by the user (optional).
Custom Url Params The custom query string to be included in the request.
Data Model Specifies the data model to use when parsing XML/JSON documents and generating the database metadata.
Data Source This property specifies a URI for the XML/JSON resource location.
Firewall Password A password used to authenticate to a proxy-based firewall.
Firewall Port The TCP port for a proxy-based firewall.
Firewall Server The name or IP address of a proxy-based firewall.
Firewall Type The protocol used by a proxy-based firewall.
Firewall User The user name to use to authenticate with a proxy-based firewall.
Flatten Arrays By default, nested arrays are returned as strings of JSON. The FlattenArrays property can be used to flatten the elements of nested arrays into columns of their own. Set FlattenArrays to the number of elements you want to return from nested arrays.
Flatten Objects Set FlattenObjects to true to flatten object properties into columns of their own. Otherwise, objects nested in arrays are returned as strings of XML/JSON.
Format The Format property specifies whether the data from the REST data source is in XML or JSON format.
Generate Schema Files Indicates the user preference as to when schemas should be generated and saved.
Initiate OAuth Set this property to initiate the process to obtain or refresh the OAuth access token when you connect.
JSON Format Specifies the format of the JSON document. Only has an effect when Format is set to JSON.
Kerberos KDC The Kerberos Key Distribution Center (KDC) service used to authenticate the user.
Kerberos Keytab File The Keytab file containing your pairs of Kerberos principals and encrypted keys.
Kerberos Realm The Kerberos Realm used to authenticate the user with.
Kerberos Service KDC The Kerberos KDC of the service.
Kerberos Service Realm The Kerberos realm of the service.
Kerberos SPN The service principal name (SPN) for the Kerberos Domain Controller.
Kerberos Ticket Cache The full file path to an MIT Kerberos credential cache file.
Location A path to the directory that contains the schema files defining tables, views, and stored procedures.
Logfile A filepath which designates the name and location of the log file.
Log Modules Core modules to be included in the log file.
Max Log File Count A string specifying the maximum file count of log files. When the limit is hit, a new log is created in the same folder with the date and time appended to the end and the oldest log file will be deleted.
Max Log File Size A string specifying the maximum size in bytes for a log file (for example, 10 MB). When the limit is hit, a new log is created in the same folder with the date and time appended to the end.
Max Rows Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.
MFA Serial Number The serial number of the MFA device if one is being used.
MFA Token The temporary token available from your MFA device.
OAuth Access Token The access token for connecting using OAuth.
OAuth Access Token Secret The OAuth access token secret for connecting using OAuth.
OAuth Access Token URL The URL to retrieve the OAuth access token from.
OAuth Authorization URL The authorization URL for the OAuth service.
OAuth Client Id The client ID assigned when you register your application with an OAuth authorization server.
OAuth Client Secret The client secret assigned when you register your application with an OAuth authorization server.
OAuth Expires In The lifetime in seconds of the OAuth AccessToken.
OAuth Grant Type The grant type for the OAuth flow.
OAuth Params A comma-separated list of other parameters to submit in the request for the OAuth access token in the format paramname=value.
OAuth Refresh Token The OAuth refresh token for the corresponding OAuth access token.
OAuth Refresh Token URL The URL to refresh the OAuth token from.
OAuth Request Token URL The URL the service provides to retrieve request tokens from. This is required in OAuth 1.0.
OAuth Settings Location The location of the settings file where OAuth values are saved when InitiateOAuth is set to GETANDREFRESH or REFRESH. Alternatively, this can be held in memory by specifying a value starting with memory://.
OAuth Token Timestamp The Unix epoch timestamp in milliseconds when the current Access Token was created.
OAuth Verifier The verifier code returned from the OAuth authorization URL.
OAuth Version The version of OAuth being used.
Offline Use offline mode to get the data from the cache instead of the live source.
Other These hidden properties are used only in specific use cases.
Password The password used to authenticate the user.
Pool Idle Timeout The allowed idle time for a connection before it is closed.
Pool Max Size The maximum connections in the pool.
Pool Min Size The minimum number of connections in the pool.
Pool Wait Time The max seconds to wait for an available connection.
Proxy Auth Scheme The authentication type to use to authenticate to the ProxyServer proxy.
Proxy Auto Detect This indicates whether to use the system proxy settings or not. This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.
Proxy Exceptions A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .
Proxy Password A password to be used to authenticate to the ProxyServer proxy.
Proxy Port The TCP port the ProxyServer proxy is running on.
Proxy Server The hostname or IP address of a proxy to route HTTP traffic through.
Proxy SSL Type The SSL type to use when connecting to the ProxyServer proxy.
Proxy User A user name to be used to authenticate to the ProxyServer proxy.
Pseudo Columns This property indicates whether or not to include pseudo columns as columns to the table.
Readonly You can use this property to enforce read-only access to REST from the provider.
Row Scan Depth The number of rows to scan when dynamically determining columns for the table.
RTK The runtime key used for licensing.
SSL Client Cert The TLS/SSL client certificate store for SSL Client Authentication (2-way SSL).
SSL Client Cert Password The password for the TLS/SSL client certificate.
SSL Client Cert Subject The subject of the TLS/SSL client certificate.
SSL Client Cert Type The type of key store containing the TLS/SSL client certificate.
SSL Server Cert The certificate to be accepted from the server when connecting using TLS/SSL.
Support Enhanced SQL This property enhances SQL functionality beyond what can be supported through the API directly, by enabling in-memory client-side processing.
Tables This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.
Timeout The value in seconds until the timeout error is thrown, canceling the operation.
URI This property specifies a URI for the XML/JSON resource location.
Use Connection Pooling This property enables connection pooling.
User The REST user account used to authenticate.
Verbosity The verbosity level that determines the amount of detail included in the log file.
Views Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.
XPath The XPath of an element that repeats at the same height within the XML/JSON document (used to split the document into multiple rows).