HTTPS -- get HTTPS headers

The same as %HTTP% but operates on the HTTPS environment variables present when the SSL protocol is in effect. Can be used to determine whether SSL is turned on.
  • Called with the name of an HTTP request header field, returns its value. Capitalization and the use of hyphens versus underscores are not significant.
  • Request headers are sent by the browser to the server. It is not possible to access the Response headers returned to the browser.
  • Only returns headers permitted by site configuration.
  • When called without a parameter, nothing is returned. See VarHTTPS for other options.
ALERT! The HTTP and HTTPS macros are deprecated as of Foswiki release 2.1. and will be removed in a future release.

Parameters

Parameter Description Default
"name" Name of the header to get optional

Examples

WriteSorted descending Returns Notes
%HTTPS{"User-Agent"}% Mozilla/5.0 (Linux; Android 10; YAL-AL00 Build/HUAWEIYAL-AL00; wv) AppleWebKit/537.36 (KHTML, like Gecko) Version/4.0 Chrome/130.0.6723.103 Mobile Safari/537.36 XWEB/1300493 MMWEBSDK/20250201 MMWEBID/6429 MicroMessenger/8.0.57.2820(0x28003939) WeChat/arm64 Weixin NetType/WIFI Language/zh_CN ABI/arm64 miniProgram/wx1753810b04aff5f8  
%HTTPS{"Cookie"}%   Not allowed by default.
%HTTPS{"Accept-language"}%    
%HTTPS% 1 Returns '1' if HTTPS is active
ALERT! You can see the HTTP headers your browser sends to the server on a number of sites e.g. http://www.ericgiguere.com/tools/http-header-viewer.html

HTTP, REMOTE_ADDR, REMOTE_PORT, REMOTE_USER
Topic revision: r1 - 18 Dec 2024, UnknownUser - This page was cached on 01 Jun 2025 - 11:42.