cfhttp

Overview ColdFusion Open BlueDragon Lucee

Generates an HTTP request and handles the response from the server.

Attributes

Name Required Type Default Description
3
addtoken No if yes add urltoken as cookie
4
authtype No authentication type for a request with username and password, valid values are "BASIC" (default) and "NTLM"
charset No String TThe character encoding of the request, including the URL query string and form or file data, and the response. For more information on character encodings, see: www.w3.org/International/O-charset.html.
8
clientcert No String The full path to a PKCS12 format file that contains the client certificate for the request.
8
clientcertpassword No String Password used to decrypt the client certificate.
columns No String The column names for the query, separated by commas, with no spaces. Column names must start with a letter. The remaining characters can be letters, numbers, or underscore characters (_). If there are no column name headers in the response, specify this attribute to identify the column names. If you specify this attribute, and the firstrowasHeader attribute is True (the default), the column names specified by this attribute replace the first line of the response. You can use this behavior to replace the column names retrieved by the request with your own names. If a duplicate column heading is encountered in either this attribute or in the column names from the response, ColdFusion appends an underscore to the name to make it unique. If the number of columns specified by this attribute does not equal the number of columns in the HTTP response body, ColdFusion generates an error.
9
4
compression No String Compression type
delimiter No String A character that separates query columns. The response body must use this character to separate the query columns.
4
domain No The domain to authenticate within. this attribute is only used when authenication type is "NTLM"
4
encoded No if set to true (default value) URL encodes the value of the attribute "URL" if necessary (no double encoding is happeing). This setting has no influence on the values from httpparam type="url", for this use the attribute "encoded" from httpparam
4
encodeurl No if set to true (default value) URL encodes the value of the attribute "URL" if necessary (no double encoding is happeing). This setting has no influence on the values from httpparam type="url", for this use the attribute "encoded" from httpparam
file No String Name of the file in which to store the response body.
firstrowasheaders No Boolean true Determines how ColdFusion processes the first row of the query record set: * yes: processes the first row as column heads. If you specify a columns attribute, ColdFusion ignores the first row of the file. * no: processes the first row as data. If you do not specify a columns attribute, ColdFusion generates column names by appending numbers to the word "column"; for example, "column_1".
getasbinary No String no * No If CFML does not recognize the response body type as text, convert it to a CFML object. * Auto If CFML does not recognize the response body type as text, convert it to CFML Binary type data. * Yes Always convert the response body content into CFML Binary type data, even if CFML recognizes the response body type as text.
method No String get * GET Requests information from the server. Any data that the server requires to identify the requested information must be in the URL or in cfhttp type="URL" tags. * POST Sends information to the server for processing. Requires one or more cfhttpparam tags. Often used for submitting form-like data. * PUT Requests the server to store the message body at the specified URL. Use this method to send files to the server. * DELETE Requests the server to delete the specified URL. * HEAD Identical to the GET method, but the server does not send a message body in the response. Use this method for testing hypertext links for validity and accessibility, determining the type or modification time of a document, or determining the type of server. * TRACE Requests that the server echo the received HTTP headers back to the sender in the response body. Trace requests cannot have bodies. This method enables the CFML application to see what is being received at the server, and use that data for testing or diagnostic information. * OPTIONS A request for information about the communication options available for the server or the specified URL. This method enables the CFML application to determine the options and requirements associated with a URL, or the capabilities of a server, without requesting any additional activity by the server.
multipart No Boolean false Tells ColdFusion to send all data specified by cfhttpparam type="formField" tags as multipart form data, with a Content-Type of multipart/form-data.
10
3
multiparttype No String Allows you to set the multipart header field to related or form-data. By default, the value is form-data
name No String Tells ColdFusion to create a query object with the given name from the returned HTTP response body.
password No String A password. May be required by server
path No String Required if File is specified. Tells ColdFusion to save the HTTP response body in a file. Contains the absolute path to the directory in which to store the file.
port No Numeric 80 Port number on the server to which to send the request. A port value in the url attribute overrides this value. (default: http 80 - https 443)
4
preauth No if set to true (default), Railo sends the basic authentication (username password) always (Preemptive Basic Authentication), if set to false the authentication is only send when the server ask for it (status code 401).
proxypassword No String The user's password on the proxy server.
proxyport No Numeric 80 The port to use on The proxy server.
proxyserver No String The proxy server required to access the URL.
proxyuser No String The user ID to send to the proxy server.
redirect No Boolean true If the response header includes a Location field, determines whether to redirect execution to the URL specified in the field.
resolveurl No Boolean false No does not resolve URLs in the response body. As a result, any relative URL links in the response body do not work. Yes resolves URLs in the response body to absolute URLs, including the port number, so that links in a retrieved page remain functional.
result No String cfhttp Specifies the name of the variable in which you want the result returned. Default: CFHTTP
textqualifier No String " A character that, optionally, specifies the start and end of a text column. This character must surround any text fields in the response body that contain the delimiter character as part of the field value. To include this character in column text, escape it by using two characters in place of one. For example, if the qualifier is a double-quotation mark, escape it as "".
throwonerror No Boolean false Yes if the server returns an error response code, throws an exception that can be caught using the cftry and cfcatch or CFML error pages. No does not throw an exception if an error response is returned. In this case, your application can use the cfhttp.StatusCode variable to determine if there was an error and its cause.
timeout No Numeric Value, in seconds of the maximum time the request can take. If the timeout passes without a response, CFML considers the request to have failed.
uridirectory No Is the file relative to the web root
url Yes URL Address of the resource on the server which will handle the request. The URL must include the hostname or IP address. If you do not specify the transaction protocol (http:// or https://), CFML defaults to http. If you specify a port number in this attribute, it overrides any port attribute value. The cfhttppparam tag URL attribute appends query string attribute-value pairs to the URL.
user No The user to user for authentication
useragent No String ColdFusion Text to put in the user agent request header. Used to identify the request client software. Can make the CFML application appear to be a browser.
username No String A username. May be required by server.
4
workstation No The workstation the authentication request is originating from. Essentially, the computer name for this machine. this attribute is only used when authenication type is "NTLM"