Options
All
  • Public
  • Public/Protected
  • All
Menu

Enumeration HttpRequestHeaderEnum

HTTP request headers enum.

Enumeration members

ACCEPT

ACCEPT: = "accept"

Media type(s) that is/are acceptable for the response. See Content negotiation.

ACCEPT_CHARSET

ACCEPT_CHARSET: = "accept-charset"

Character sets that are acceptable.

ACCEPT_DATETIME

ACCEPT_DATETIME: = "accept-datetime"

Acceptable version in time.

ACCEPT_ENCODING

ACCEPT_ENCODING: = "accept-encoding"

List of acceptable encodings. See HTTP compression.

ACCEPT_LANGUAGE

ACCEPT_LANGUAGE: = "accept-language"

List of acceptable human languages for response. See Content negotiation.

ACCESS_CONTROL_REQUEST_HEADERS

ACCESS_CONTROL_REQUEST_HEADERS: = "access-control-request-headers"

Initiates a request for cross-origin resource sharing with Origin.

ACCESS_CONTROL_REQUEST_METHOD

ACCESS_CONTROL_REQUEST_METHOD: = "access-control-request-method"

Initiates a request for cross-origin resource sharing with Origin.

AUTHORIZATION

AUTHORIZATION: = "authorization"

Authentication credentials for HTTP authentication.

A_IM

A_IM: = "a-im"

Acceptable instance-manipulations for the request.

CACHE_CONTROL

CACHE_CONTROL: = "cache-control"

Used to specify directives that must be obeyed by all caching mechanisms along the request-response chain.

CONNECTION

CONNECTION: = "connection"

Control options for the current connection and list of hop-by-hop request fields. Must not be used with HTTP/2.

CONTENT_ENCODING

CONTENT_ENCODING: = "content-encoding"

The type of encoding used on the data. See HTTP compression.

CONTENT_LENGTH

CONTENT_LENGTH: = "content-length"

The length of the request body in octets (8-bit bytes).

CONTENT_MD5

CONTENT_MD5: = "content-md5"

A Base64-encoded binary MD5 sum of the content of the request body.

CONTENT_TYPE

CONTENT_TYPE: = "content-type"

The Media type of the body of the request (used with POST and PUT requests).

COOKIE

COOKIE: = "cookie"
An [HTTP cookie](https://en.wikipedia.org/wiki/HTTP_cookie) previously sent by the server
with [Set-Cookie](https://en.wikipedia.org/wiki/List_of_HTTP_header_fields#innerlink_set-cookie).

DATE

DATE: = "date"

The date and time at which the message was originated (in "HTTP-date" format as defined by RFC 7231 Date/Time Formats).

DNT

DNT: = "dnt"

Requests a web application to disable their tracking of a user. This is Mozilla's version of the X-Do-Not-Track header field (since Firefox 4.0 Beta 11). Safari and IE9 also have support for this field.[23] On March 7, 2011, a draft proposal was submitted to IETF. The W3C Tracking Protection Working Group is producing a specification.

EXPECT

EXPECT: = "expect"
Indicates that particular server behaviors are required by the client.

FORWARDED

FORWARDED: = "forwarded"

Disclose original information of a client connecting to a web server through an HTTP proxy.

FROM

FROM: = "from"

The email address of the user making the request.

FRONT_END_HTTPS

FRONT_END_HTTPS: = "front-end-https"

Non-standard header field used by Microsoft applications and load-balancers

HOST

HOST: = "host"

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.
Mandatory since HTTP/1.1. If the request is generated directly in HTTP/2, it should not be used.

HTTP2_SETTING

HTTP2_SETTING: = "http2-settings"

A request that upgrades from HTTP/1.1 to HTTP/2 MUST include exactly one HTTP2-Setting header field. The HTTP2-Settings header field is a connection-specific header field that includes parameters that govern the HTTP/2 connection, provided in anticipation of the server accepting the request to upgrade.

IF_MATCH

IF_MATCH: = "if-match"

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_MODIFIED_SINCE

IF_MODIFIED_SINCE: = "if-modified-since"

Allows a 304 Not Modified to be returned if content is unchanged.

IF_NONE_MATCH

IF_NONE_MATCH: = "if-none-match"

Allows a 304 Not Modified to be returned if content is unchanged, see [HTTP ETag](https://en.wikipedia.org/wiki/HTTP_ETag_.

IF_RANGE

IF_RANGE: = "if-range"

If the entity is unchanged, send me the part(s) that I am missing; otherwise, send me the entire new entity.

IF_UNMODIFIED_SINCE

IF_UNMODIFIED_SINCE: = "if-unmodified-since"

Only send the response if the entity has not been modified since a specific time.

MAX_FORWARDS

MAX_FORWARDS: = "max-forwards"

Limit the number of times the message can be forwarded through proxies or gateways.

ORIGIN

ORIGIN: = "origin"

Initiates a request for cross-origin resource sharing (asks server for Access-Control-* response fields).

PRAGMA

PRAGMA: = "pragma"

Implementation-specific fields that may have various effects anywhere along the request-response chain.

PREFER

PREFER: = "prefer"
Allows client to request that certain behaviors be employed by a server while processing a request.

PROXY_AUTHORIZATION

PROXY_AUTHORIZATION: = "proxy-authorization"

Authorization credentials for connecting to a proxy.

PROXY_CONNECTION

PROXY_CONNECTION: = "proxy-connection"

Implemented as a misunderstanding of the HTTP specifications. Common because of mistakes in implementations of early HTTP versions. Has exactly the same functionality as standard Connection field. Must not be used with HTTP/2.

RANGE

RANGE: = "range"

Request only part of an entity. Bytes are numbered from 0. See Byte serving.

REFERER

REFERER: = "referer"

This is the address of the previous web page from which a link to the currently requested page was followed. (The word "referrer" has been misspelled in the RFC as well as in most implementations to the point that it has become standard usage and is considered correct terminology). See Referer.

SAVE_DATA

SAVE_DATA: = "save-data"

The Save-Data client hint request header available in Chrome, Opera, and Yandex browsers lets developers deliver lighter, faster applications to users who opt-in to data saving mode in their browser.

TE

TE: = "te"

The transfer encodings the user agent is willing to accept: the same values as for the response header field Transfer-Encoding can be used, plus the "trailers" value (related to the "chunked" transfer method) to notify the server it expects to receive additional fields in the trailer after the last, zero-sized, chunk.
Only trailers is supported in HTTP/2.

TRAILER

TRAILER: = "trailer"

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.

TRANSFER_ENCODING

TRANSFER_ENCODING: = "transfer-encoding"

The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity.
Must not be used with HTTP/2.

UPGRADE

UPGRADE: = "upgrade"

Ask the server to upgrade to another protocol.
Must not be used in HTTP/2.

UPGRADE_INSECURE_REQUESTS

UPGRADE_INSECURE_REQUESTS: = "upgrade-insecure-requests"

Tells a server which (presumably in the middle of a HTTP -> HTTPS migration) hosts mixed content that the client would prefer redirection to HTTPS and can handle Content-Security-Policy: upgrade-insecure-requests/ Must not be used with HTTP/2.

USER_AGENT

USER_AGENT: = "user-agent"

The user agent string of the user agent.

VIA

VIA: = "via"
Informs the server of proxies through which the request was sent.

WARNING

WARNING: = "warning"

A general warning about possible problems with the entity body.

X_ATT_DEVICE_ID

X_ATT_DEVICE_ID: = "x-att-deviceid"

Allows easier parsing of the MakeModel/Firmware that is usually found in the User-Agent String of AT&T Devices

X_CORRELATION_ID

X_CORRELATION_ID: = "x-correlation-id"

Correlates HTTP requests between a client and server.

X_CSRF_TOKEN

X_CSRF_TOKEN: = "x-csrf-token"

Used to prevent cross-site request forgery. Alternative header names are: X-CSRFToken[38] and X-XSRF-TOKEN

X_FORWARDED_FOR

X_FORWARDED_FOR: = "x-forwarded-for"

A de facto standard for identifying the originating IP address of a client connecting to a web server through an HTTP proxy or load balancer. Superseded by Forwarded header.

X_FORWARDED_HOST

X_FORWARDED_HOST: = "x-forwarded-host"

A de facto standard for identifying the original host requested by the client in the Host HTTP request header, since the host name and/or port of the reverse proxy (load balancer) may differ from the origin server handling the request. Superseded by Forwarded header.

X_FORWARDED_PROTO

X_FORWARDED_PROTO: = "x-forwarded-proto"

A de facto standard for identifying the originating protocol of an HTTP request, since a reverse proxy (or a load balancer) may communicate with a web server using HTTP even if the request to the reverse proxy is HTTPS. An alternative form of the header (X-ProxyUser-Ip) is used by Google clients talking to Google servers. Superseded by Forwarded header.

X_HTTP_METHOD_OVERRIDE

X_HTTP_METHOD_OVERRIDE: = "x-http-method-override"

Requests a web application to override the method specified in the request (typically POST) with the method given in the header field (typically PUT or DELETE). This can be used when a user agent or firewall prevents PUT or DELETE methods from being sent directly (note that this is either a bug in the software component, which ought to be fixed, or an intentional configuration, in which case bypassing it may be the wrong thing to do).

X_REQUESTED_WITH

X_REQUESTED_WITH: = "x-requested-with"

Mainly used to identify Ajax requests (most JavaScript frameworks send this field with value of XMLHttpRequest); also identifies Android apps using WebView.

X_REQUEST_ID

X_REQUEST_ID: = "x-request-id"

Correlates HTTP requests between a client and server.

X_UIDH

X_UIDH: = "x-uidh"

Server-side deep packet insertion of a unique ID identifying customers of Verizon Wireless; also known as "perma-cookie" or "supercookie"

X_WAP_PROFILE

X_WAP_PROFILE: = "x-wap-profile"

Links to an XML file on the Internet with a full description and details about the device currently connecting. In the example to the right is an XML file for an AT&T Samsung Galaxy S2.