HttpRequestHeaders Module
Headers that can be sent in an HTTP request
Functions and values
| Function or value |
Description
|
Full Usage:
Accept contentType
Parameters:
string
Returns: string * string
|
Content-Types that are acceptable for the response
|
Full Usage:
AcceptCharset characterSets
Parameters:
string
Returns: string * string
|
Character sets that are acceptable
|
|
|
Full Usage:
AcceptEncoding encoding
Parameters:
string
Returns: string * string
|
List of acceptable encodings. See HTTP compression.
|
Full Usage:
AcceptLanguage language
Parameters:
string
Returns: string * string
|
List of acceptable human languages for response
|
Full Usage:
Allow methods
Parameters:
string
Returns: string * string
|
The Allow header, which specifies the set of HTTP methods supported.
|
Full Usage:
Authorization credentials
Parameters:
string
Returns: string * string
|
Authentication credentials for HTTP authentication
|
Full Usage:
BasicAuth username password
Parameters:
string
password : string
Returns: string * string
|
Authentication header using Basic Auth encoding
|
Full Usage:
CacheControl control
Parameters:
string
Returns: string * string
|
Used to specify directives that MUST be obeyed by all caching mechanisms along the request/response chain
|
Full Usage:
Connection connection
Parameters:
string
Returns: string * string
|
What type of connection the user-agent would prefer
|
Full Usage:
ContentDisposition (placement, name, fileName)
Parameters:
string
name : string option
fileName : string option
Returns: string * string
|
Describes the placement of the content. Valid dispositions are: inline, attachment, form-data
|
Full Usage:
ContentEncoding encoding
Parameters:
string
Returns: string * string
|
The type of encoding used on the data
|
Full Usage:
ContentLanguage language
Parameters:
string
Returns: string * string
|
The language the content is in
|
Full Usage:
ContentLocation location
Parameters:
string
Returns: string * string
|
An alternate location for the returned data
|
Full Usage:
ContentMD5 md5sum
Parameters:
string
Returns: string * string
|
A Base64-encoded binary MD5 sum of the content of the request body
|
Full Usage:
ContentRange range
Parameters:
string
Returns: string * string
|
Where in a full body message this partial message belongs
|
Full Usage:
ContentType contentType
Parameters:
string
Returns: string * string
|
The MIME type of the body of the request (used with POST and PUT requests)
|
Full Usage:
ContentTypeWithEncoding (contentType, charset)
Parameters:
string
charset : Encoding
Returns: string * string
|
The MIME type of the body of the request (used with POST and PUT requests) with an explicit encoding
|
Full Usage:
Expect behaviors
Parameters:
string
Returns: string * string
|
Indicates that particular server behaviors are required by the client
|
|
Gives the date/time after which the response is considered stale
|
Full Usage:
From email
Parameters:
string
Returns: string * string
|
The email address of the user making the request
|
Full Usage:
Host host
Parameters:
string
Returns: string * string
|
The domain name of the server (for virtual hosting), and the TCP port number on which the server is listening. The port number may be omitted if the port is the standard port for the service requested.
|
Full Usage:
IfMatch entity
Parameters:
string
Returns: string * string
|
Only perform the action if the client supplied entity matches the same entity on the server. This is mainly for methods like PUT to only update a resource if it has not been modified since the user last updated it. If-Match: "737060cd8c284d8af7ad3082f209582d" Permanent
|
|
Allows a 304 Not Modified to be returned if content is unchanged
|
Full Usage:
IfNoneMatch etag
Parameters:
string
Returns: string * string
|
Allows a 304 Not Modified to be returned if content is unchanged
|
Full Usage:
IfRange range
Parameters:
string
Returns: string * string
|
If the entity is unchanged, send me the part(s) that I am missing; otherwise, send me the entire new entity
|
|
Only send the response if the entity has not been modified since a specific time
|
Full Usage:
KeepAlive keepAlive
Parameters:
string
Returns: string * string
|
Specifies a parameter used into order to maintain a persistent connection
|
|
Specifies the date and time at which the accompanying body data was last modified
|
Full Usage:
MaxForwards count
Parameters:
int
Returns: string * string
|
Limit the number of times the message can be forwarded through proxies or gateways
|
Full Usage:
Origin origin
Parameters:
string
Returns: string * string
|
Initiates a request for cross-origin resource sharing (asks server for an 'Access-Control-Allow-Origin' response header)
|
Full Usage:
Pragma pragma
Parameters:
string
Returns: string * string
|
Implementation-specific headers that may have various effects anywhere along the request-response chain.
|
Full Usage:
Prefer prefer
Parameters:
string
Returns: string * string
|
Optional instructions to the server to control request processing. See RFC https://tools.ietf.org/html/rfc7240 for more details
|
Full Usage:
ProxyAuthorization credentials
Parameters:
string
Returns: string * string
|
Authorization credentials for connecting to a proxy.
|
Full Usage:
Range (start, finish)
Parameters:
int64
finish : int64
Returns: string * string
|
Request only part of an entity. Bytes are numbered from 0
|
Full Usage:
Referer referer
Parameters:
string
Returns: string * string
|
This is the address of the previous web page from which a link to the currently requested page was followed. (The word "referrer" is misspelled in the RFC as well as in most implementations.)
|
Full Usage:
TE te
Parameters:
string
Returns: string * string
|
The transfer encodings the user agent is willing to accept: the same values as for the response header Transfer-Encoding can be used, plus the "trailers" value (related to the "chunked" transfer method) to notify the server it expects to receive additional headers (the trailers) after the last, zero-sized, chunk.
|
Full Usage:
Trailer trailer
Parameters:
string
Returns: string * string
|
The Trailer general field value indicates that the given set of header fields is present in the trailer of a message encoded with chunked transfer-coding
|
Full Usage:
TransferEncoding directive
Parameters:
string
Returns: string * string
|
The TransferEncoding header indicates the form of encoding used to safely transfer the entity to the user. The valid directives are one of: chunked, compress, deflate, gzip, or identity.
|
Full Usage:
Translate translate
Parameters:
string
Returns: string * string
|
Microsoft extension to the HTTP specification used in conjunction with WebDAV functionality.
|
Full Usage:
Upgrade upgrade
Parameters:
string
Returns: string * string
|
Specifies additional communications protocols that the client supports.
|
Full Usage:
UserAgent userAgent
Parameters:
string
Returns: string * string
|
The user agent string of the user agent
|
Full Usage:
Via server
Parameters:
string
Returns: string * string
|
Informs the server of proxies through which the request was sent
|
Full Usage:
Warning message
Parameters:
string
Returns: string * string
|
A general warning about possible problems with the entity body
|
Full Usage:
XHTTPMethodOverride httpMethod
Parameters:
string
Returns: string * string
|
Override HTTP method.
|
Deedle