HTTP Client Parameters

This page describes the HTTP Client options that you can use with the Lua function send_http_request.

NOTE: When configuring authentication, do not set more than one of the following combinations.

  • BasicUsername and BasicPassword
  • DigestUsername and DigestPassword
  • NTLMUsername and NTLMPassword

TIP: You can encrypt user names and passwords before entering them into your configuration file. For information about how to encrypt parameter values, refer to the IDOL Getting Started Guide.

Parameter Type Default Description
AcceptCompressedEncodings Boolean True Specifies whether to accept compressed responses to HTTP requests (by setting the header Accept-Encoding).
BasicOnAuthenticate Boolean False Specifies whether to delay authentication. Some types of authentication (for example Siteminder) require that authentication is delayed until credentials are requested. To delay authentication, set this parameter to TRUE.
BasicPassword String   The password to use to access resources protected by basic authentication.
BasicUsername String   The username to use to access resources protected by basic authentication.
DigestPassword String   The password to use to access resources protected by HTTP Digest authentication.
DigestUsername String   The username to use to access resources protected by HTTP Digest authentication.
EnableKerberos Boolean False Specifies whether to use Kerberos authentication.
GSSName String   The file name of the GSS library. This library is required to use Kerberos authentication.
GSSPath String   The path to the folder that contains the GSS library. This library is required to use Kerberos authentication.
HTTPConnectTimeout Time Duration 60s The maximum amount of time to wait for the server to respond when establishing a connection.
HTTPReadTimeout Time Duration 60s The maximum amount of time to wait to receive data.
NTLMPassword String   The password to use to access resources protected by NTLM authentication.
NTLMUsername String   The username to use to access resources protected by NTLM authentication.
ProxyHost String   The host name or IP address of the proxy server to use.
ProxyPassword String   The password to use to authenticate with the proxy server.
ProxyPort Integer   The port of the proxy server to use.
ProxyUsername String   The user name to use to authenticate with the proxy server.
SSLConfig String The current section The name of a section in the configuration file that contains the SSL settings to use.
UseNTLMv2 Boolean False Specifies whether to use NTLM version 2, rather than NTLM version 1.
UserAgent String   The value to use for the user-agent in the header of requests.
UseSpnego Boolean False Specifies whether to use the SPNEGO protocol to decide which type of authentication to use.
UseSystemProxy Boolean False

A Boolean value that specifies whether to obtain details about your HTTP proxy from the system. On Windows, MongoDB Connector reads the proxy settings configured through Internet Explorer or the Windows Control Panel. On Linux, MongoDB Connector reads the proxy settings from environment variables such as HTTP_PROXY and HTTPS_PROXY.

You can set this parameter instead of setting ProxyHost, ProxyPort, ProxyUsername, and ProxyPassword.