httpGet

Version 20.0.7580


httpGet

Version 20.0.7580


Get a document from the Web using the HTTP GET method.

Required Parameters

  • url: The URL to retrieve.

Optional Parameters

  • timeout: The timeout, in seconds, for the operation to complete. Zero (0) means no timeout. The default value is ‘60’.
  • proxy_server: The IP address or host name of the proxy server used for the request.
  • proxy_auto: Whether or not the proxy should be detected from Windows system settings. This takes precedence over other proxy settings and is not available in Java. The allowed values are ‘TRUE, FALSE’. The default value is ‘FALSE’.
  • proxy_port: The port number of the proxy server.
  • proxy_user: The user Id used to authenticate with the proxy server.
  • proxy_password: The password used to authenticate with the proxy server.
  • proxy_authscheme: The authentication scheme of the proxy server. The allowed values are ‘BASIC, DIGEST, PROPRIETARY, NONE, NTLM’. The default value is ‘BASIC’.
  • proxy_authtoken: The proxy authentication token.
  • proxy_ssltype: The SSL/TLS type of the proxy server. The allowed values are ‘AUTO, ALWAYS, NEVER, TUNNEL’. The default value is ‘AUTO’.
  • firewall_server: The IP address or host name of the firewall.
  • firewall_port: The port number of the firewall.
  • firewall_user: The user Id used to authenticate with the firewall.
  • firewall_password: The password used to authenticate with the firewall.
  • firewall_type: The type of the firewall. The allowed values are ‘NONE, TUNNEL, SOCKS4, SOCKS5’. The default value is ‘NONE’.
  • kerberoskdc: The KDC setting of Kerberos, available when authscheme is Negotiate.
  • kerberosrealm: The Realm setting of Kerberos, available when authscheme is Negotiate.
  • internalconfig#: Sets an internal configuration setting.
  • charset: The charset of the exchanged/transferred data. The default value is ‘UTF-8’.
  • httpversion: Version of the HTTP protocol to use. The allowed values are ‘1.0, 1.1’. The default value is ‘1.1’.
  • cookie:*: Any cookies to add to the request.
  • followredirects: Whether or not to follow HTTP redirects. The allowed values are ‘TRUE, FALSE’. The default value is ‘TRUE’.
  • sslcert: The SSL/TLS certificate to be accepted from the server. Any other certificate will be rejected. This can take the form of a full PEM certificate, the path to a file containing the certificate, the public key, the MD5 thumbprint, or the SHA-1 thumbprint. If not specified any valid certificate will be accepted. The default value is ‘TRUSTED’.
  • sslclientcert: The name of the certificate store for the client certificate.
  • sslclientcerttype: The store type of the client certificate. The allowed values are ‘USER, MACHINE, PFXFILE, PFXBLOB, JKSFILE, JKSBLOB, PEMKEY_FILE, PEMKEY_BLOB, PUBLIC_KEY_FILE, PUBLIC_KEY_BLOB, SSHPUBLIC_KEY_BLOB, P7BFILE, P7BBLOB, SSHPUBLIC_KEY_FILE, PPKFILE, PPKBLOB, XMLFILE, XMLBLOB’.
  • sslclientcertpassword: The password of the client certificate.
  • sslclientcertsubject: The subject of the client certificate. Using an asterisk will find the first certificate in the store.
  • user: The username to authenticate with if the authscheme parameter is set to something other than None.
  • password: The password to authenticate with if the authscheme parameter is set to something other than None.
  • authscheme: The authorization mechanism to use. Only relevant if user and password are provided. Valid values are BASIC, DIGEST, and NTLM. Defaults to BASIC. The allowed values are ‘BASIC, DIGEST, NTLM’. The default value is ‘BASIC’.
  • version: The OAuth version. Use OAuth to authorize the request. Default is Disabled. The allowed values are ‘Disabled, 1.0, 2.0’. The default value is ‘Disabled’.
  • token: The request token for OAuth.
  • token_secret: The request token secret. OAuth 1.0 only.
  • sign_method: The signature method used to calculate the signature for OAuth 1.0. The allowed values are ‘HMAC-SHA1, PLAINTEXT’. The default value is ‘HMAC-SHA1’.
  • client_id: The client Id. OAuth 1.0 only.
  • client_secret: The client secret. OAuth 1.0 only.
  • header:name#: The name for each custom header to pass with the request.
  • header:value#: The value for each custom header to pass with the request.
  • ifmodifiedsince: The if-modified-since date and time to use as a filter for the results retrieved (for example: Sat, 25 Feb 2006 04:11:47 GMT).
  • localfile: If specified, the results of the GET will be written to this file.

Output Attributes

  • ssl:issuer: The issuer of the SSL/TLS certificate.
  • ssl:subject: The subject of the SSL/TLS certificate.
  • http:statuscode: The HTTP status code returned from the request.
  • http:content: The content of the HTTP response.
  • cookie:*: The cookies returned with the response.
  • http:allcookies: All of the cookies from the response, returned as a single string.
  • header:*: The headers returned with the response.