Upgrade

The Upgrade header field may be used by clients to invite a server to switch to one (or more) of the listed protocols, in descending preference order.

For example, the client might send a GET request as shown, listing the preferred protocols to switch to (in this case "example/1" and "foo/2"):

GET /index.html HTTP/1.1
Host: www.example.com
Connection: upgrade
Upgrade: example/1, foo/2

The server can choose to ignore the request, for any reason, in which case it should just respond as though the Upgrade header had not been sent (for example, with a 200 OK).

If the server decides to upgrade the connection, it must:

1. Send back a 101 Switching Protocols response status with an Upgrade header that specifies the protocol(s) being switched to. For example:

   http

   HTTP/1.1 101 Switching Protocols
   Upgrade: foo/2
   Connection: Upgrade
   

2. Send a response to the original request using the new protocol (the server may only switch to a protocol with which it can complete the original request).

A server may also send the header as part of a 426 Upgrade Required response, to indicate that the server won't perform the request using the current protocol, but might do so if the protocol is changed. The client can then request a protocol change using the process above.

More detail and examples are provided in the topic Protocol upgrade mechanism.

Connection: upgrade
Upgrade: protocol_name[/protocol_version]

Notes:

• The Connection header with type upgrade must always be sent with the Upgrade header (as shown above).
• Protocols are listed, comma-separated, in order of descending preference. Protocol version is optional. For example:

Connection: upgrade
Upgrade: a_protocol/1, example, another_protocol/2.2

any comma-separated list protocol names (each with optional protocol version)

One or more protocol names with optional version ("/" separated). The protocols are listed in order of descending preference.

• Protocol upgrade mechanism
• 101 Switching Protocol
• 426 Upgrade Required
• Connection