跳转到主要内容

ETag header

The HTTP ETag (entity tag) {{Glossary("response header")}}header is an identifier for a specific version of a resource. It lets caches be more efficient and save bandwidth, as a web server does not need to resend a full response if the content has not changed. Additionally, ETags help to prevent simultaneous updates of a resource from overwriting each other ("mid-air collisions").

If the resource at a given URL changes, a new ETag value must be generated. A comparison of them can determine whether two representations of a resource are the same.

Header type {{Glossary("[Response header")}}header](https://developer.mozilla.org/en-US/docs/Glossary/Response%20header), {{Glossary("[Representation header")}}header](https://developer.mozilla.org/en-US/docs/Glossary/Representation%20header)
{{Glossary("[Forbidden request header")}}header](https://developer.mozilla.org/en-US/docs/Glossary/Forbidden%20request%20header) No

Syntax

ETag: W/"<etag_value>"
ETag: "<etag_value>"

Directives

  • W/ {{optional_inline}}
    • : W/ (case-sensitive) indicates that a weak validator is used. Weak ETags are easy to generate, but are far less useful for comparisons. Strong validators are ideal for comparisons but can be very difficult to generate efficiently. Weak ETag values of two representations of the same resources might be semantically equivalent, but not byte-for-byte identical. This means weak ETags prevent caching when byte range requests are used, but strong ETags mean range requests can still be cached.
  • <etag_value>
    • : Entity tag that uniquely represents the requested resource. It is a string of {{Glossary("ASCII")}}ASCII characters placed between double quotes, like "675af34563dc-tr34". The method by which ETag values are generated is not specified. Typically, the ETag value is a hash of the content, a hash of the last modification timestamp, or just a revision number. For example, a wiki engine can use a hexadecimal hash of the documentation article content.

Examples

ETag: "33a64df551425fcc55e4d42a148795d9f25f89d4"
ETag: W/"0815"

Avoiding mid-air collisions

With the help of the ETag and the {{HTTPHeader("If-Match")}}Match headers, you can detect mid-air edit collisions (conflicts).

For example, when editing a wiki, the current wiki content may be hashed and put into an ETag header in the response:

ETag: "33a64df551425fcc55e4d42a148795d9f25f89d4"

When saving changes to a wiki page (posting data), the {{HTTPMethod("POST")}}POST request will contain the {{HTTPHeader("If-Match")}}Match header containing the ETag values to check freshness against.

If-Match: "33a64df551425fcc55e4d42a148795d9f25f89d4"

If the hashes don't match, it means that the document has been edited in-between and a {{HTTPStatus("412", "412 Precondition Failed")}}Failed error is thrown.

Caching of unchanged resources

Another typical use of the ETag header is to cache resources that are unchanged. If a user visits a given URL again (that has an ETag set), and it is stale (too old to be considered usable), the client will send the value of its ETag along in an {{HTTPHeader("If-None-Match")}}Match header field:

If-None-Match: "33a64df551425fcc55e4d42a148795d9f25f89d4"

The server compares the client's ETag (sent with If-None-Match) with the ETag for its current version of the resource, and if both values match (that is, the resource has not changed), the server sends back a {{HTTPStatus("304", "304 Not Modified")}}Modified status, without a body, which tells the client that the cached version of the response is still good to use (fresh).

Specifications

{{Specifications}}

Browser compatibility

{{Compat}}

See also