Text of httpd.apache.org › docs › current › mod › mod_headers.html as Styx crawled it on Nov 19, 2026. The page may have changed since. Only its words are kept, without pictures or layout, and only the first part of a long page.

Open the live page

mod_headers - Apache HTTP Server Version 2.4

Modules | Directives | FAQ | Glossary | Sitemap | Report a bug Apache HTTP Server Version 2.4 Apache > HTTP Server > Documentation > Version 2.4 > Modules Apache Module mod_headers Available Languages: en | fr | ja | ko Description: Customization of HTTP request and response headers Status: Extension Module Identifier: headers_module Source File: mod_headers.c Summary This module provides directives to control and modify HTTP request and response headers.

Headers can be merged, replaced or removed. Topics Order of Processing Early and Late Processing Examples Directives Header RequestHeader Bugfix checklist httpd changelog Known issues Report a bug Order of Processing ¶ The directives provided by mod_headers can occur almost anywhere within the server configuration, and can be limited in scope by enclosing them in configuration sections . Order of processing is important and is affected both by the order in the configuration file and by placement in configuration sections .

These two directives have a different effect if reversed: RequestHeader append MirrorID "mirror 12" RequestHeader unset MirrorID This way round, the MirrorID header is not set. If reversed, the MirrorID header is set to "mirror 12". Early and Late Processing ¶ mod_headers can be applied either early or late in the request. The normal mode is late, when Request Headers are set immediately before running the content generator and Response Headers just as the response is sent down the wire.

Always use Late mode in an operational server. Early mode is designed as a test/debugging aid for developers. Directives defined using the early keyword are set right at the beginning of processing the request. This means they can be used to simulate different requests and set up test cases, but it also means that headers may be changed at any time by other modules before generating a Response. Because early directives are processed before the request path's configuration is traversed, early headers can only be set in a main server or virtual host context.

Early directives cannot depend on a request path, so they will fail in contexts such as <Directory> or <Location> . Examples ¶ Copy all request headers that begin with "TS" to the response headers: Header echo ^TS Add a header, MyHeader , to the response including a timestamp for when the request was received and how long it took to begin serving the request. This header can be used by the client to intuit load on the server or in isolating bottlenecks between the client and the server.

Header set MyHeader "%D %t" results in this header being added to the response: MyHeader: D=3775428 t=991424704447256 Say hello to Joe Header set MyHeader "Hello Joe. It took %D microseconds for Apache to serve this request." results in this header being added to the response: MyHeader: Hello Joe. It took D=3775428 microseconds for Apache to serve this request. Conditionally send MyHeader on the response if and only if header MyRequestHeader is present on the request.

This is useful for constructing headers in response to some client stimulus. Note that this example requires the services of the mod_setenvif module. SetEnvIf MyRequestHeader myvalue HAVE_MyRequestHeader Header set MyHeader "%D %t mytext" env=HAVE_MyRequestHeader If the header MyRequestHeader: myvalue is present on the HTTP request, the response will contain the following header: MyHeader: D=3775428 t=991424704447256 mytext Enable DAV to work with Apache running HTTP through SSL hardware ( problem description ) by replacing https: with http: in the Destination header: RequestHeader edit Destination ^https: http: early Set the same header value under multiple nonexclusive conditions, but do not duplicate the value in the final header.

If all of the following conditions applied to a request (i.e., if the CGI , NO_CACHE and NO_STORE environment variables all existed for the request): Header merge Cache-Control no-cache env=CGI Header merge Cache-Control no-cache env=NO_CACHE Header merge Cache-Control no-store env=NO_STORE then the response would contain the following header: Cache-Control: no-cache, no-store If append was used instead of merge , then the response would contain the following header: Cache-Control: no-cache, no-cache, no-store Set a test cookie if and only if the client didn't send us a cookie Header set Set-Cookie testcookie "expr=-z %{req:Cookie}" Append a Caching header for responses with a HTTP status code of 200 Header append Cache-Control s-maxage=600 "expr=%{REQUEST_STATUS} == 200" Header Directive ¶ Description: Configure HTTP response headers Syntax: Header [ condition ] add|append|echo|edit|edit*|merge|set|setifempty|unset|note header [[expr=] value [ replacement ] [early|env=[!] varname |expr= expression ]] Context: server config, virtual host, directory, .htaccess Override: FileInfo Status: Extension Module: mod_headers Compatibility: SetIfEmpty available in 2.4.7 and later, expr=value available in 2.4.10 and later This directive can replace, merge or remove HTTP response headers.

The header is modified just after the content handler and output filters are run, allowing outgoing headers to be modified. The optional condition argument determines which internal table of responses headers this directive will operate against: onsuccess (default, can be omitted) or always . The difference between the two lists is that the headers contained in the latter are added to the response even on error, and persisted across internal redirects (for example, ErrorDocument handlers).

Note also that repeating this directive with both conditions makes sense in some scenarios because always is not a superset of onsuccess with respect to existing headers: You're adding a header to a locally generated non-success (non-2xx) response, such as a redirect, in which case only the table corresponding to always is used in the ultimate response. You're modifying or removing a header generated by a CGI script or by mod_proxy_fcgi , in which case the CGI scripts' headers are in the table corresponding to always and not in the default table.

You're modifying or removing a header generated by some piece of the server but that header is not being found by the default onsuccess condition. This difference between onsuccess and always is a feature that resulted as a consequence of how httpd internally stores headers for a HTTP response, since it does not offer any "normalized" single list of headers. The main problem that can arise if the following concept is not kept in mind while writing the configuration is that some HTTP responses might end up with the same header duplicated (confusing users or sometimes even HTTP clients).

For example, suppose that you have a simple PHP proxy setup with mod_proxy_fcgi and your backend PHP scripts adds the X-Foo: bar header to each HTTP response. As described above, mod_proxy_fcgi uses the always table to store headers, so a configuration like the following ends up in the wrong result, namely having the header duplicated with both values: # X-Foo's value is set in the 'onsuccess' headers table Header set X-Foo: baz To circumvent this limitation, there are some known configuration patterns that can help, like the following: # 'onsuccess' can be omitted since it is the default Header onsuccess unset X-Foo Header always set X-Foo "baz" Separately from the condition parameter described above, you can limit an action based on HTTP status codes for e.g. proxied or CGI requests.

See the example that uses %{REQUEST_STATUS} in the section above. The action it performs is determined by the first argument (second argument if a condition is specified). This can be one of the following values: Warning Please read the difference between always and onsuccess headers list described above before start reading the actions list, since that important concept still applies. Each action, in fact, works as described but only on the target headers list. add The response header is added to the

The rest of this page is on the live site.