For providers

The header reference

Every response header ReClash reads: name, format, aliases, what it does and an example. Search by name or description, filter by category. How it all fits together is in the documentation.

20 reclash-*7 commonHWIDDocumentation →Builder →

01the reference

Common headers 7

Standard Clash headers. If you already send them, ReClash picks them up unchanged.

subscription-userinfoCommonShows traffic usage and the expiry date.

Formatupload=<bytes>; download=<bytes>; total=<bytes>; expire=<unix-seconds>

Traffic usage and quota in bytes, plus the expiry as unix-seconds. total=0 means unlimited, expire=0 perpetual. The client shows the remaining amount, a usage bar and days left.

Subscription-Userinfo: upload=13421772800; download=83994443776; total=214748364800; expire=1798761600

profile-titleCommonNames the imported profile unless the user has renamed it. Use base64: for non-ASCII text.

FormatProfile name, plain UTF-8 or Base64

Names the imported profile unless the user has renamed it. Use base64: for non-ASCII text.

Profile-Title: Nebula VPN
Profile-Title: base64:0J3QtdCx0YPQu9CwIFZQTg==

content-dispositionCommonUsed as a profile-name fallback.

FormatA response filename

Used as a profile-name fallback.

Content-Disposition: attachment; filename="nebula.yaml"

profile-update-intervalCommonSets the profile update interval.

FormatPositive integer, in hours

Sets the profile update interval.

Profile-Update-Interval: 24

support-urlCommonAdds a support action. Use an absolute HTTPS URL.

FormatProvider support URL

Adds a support action. Use an absolute HTTPS URL.

Support-Url: https://nebula.example/help

announceCommonShows a provider announcement.

FormatPlain text or Base64

Shows a provider announcement.

Announce: base64:0J/RgNC+0YTQuNC70LDQutGC0LjQutCw

report-urlCommonCompatibility name for reclash-reporturl. Adds a “report an issue” action for the subscription.

FormatIssue-report URL

Compatibility name for reclash-reporturl. Adds a “report an issue” action for the subscription.

ReClash headers 20

Twenty headers only ReClash understands. Every one is optional.

reclash-announceReClashProvider announcement. Takes priority over announce.

FormatPlain text or Base64

Provider announcement. Takes priority over announce.

ReClash-Announce: base64:0J/RgNC+0YTQuNC70LDQutGC0LjQutCw 14.04

reclash-supporturlReClashflclashx-supporturlSupport page. Use an absolute HTTPS URL.

FormatProvider support URL

Aliasflclashx-supporturl

Support page. Use an absolute HTTPS URL.

ReClash-SupportURL: https://nebula.example/help

reclash-autoupdateintervalReClashflclashx-autoupdateintervalProfile update interval.

FormatPositive integer, in minutes

Aliasflclashx-autoupdateinterval

Profile update interval.

ReClash-AutoUpdateInterval: 60

reclash-servicenameReClashflclashx-servicenameProvider name shown in the dashboard.

FormatPlain text or Base64

Aliasflclashx-servicename

Provider name shown in the dashboard.

ReClash-ServiceName: Nebula VPN

reclash-activetextReClashThe caption under the hero orb and in the Android notification, in place of “You are protected”.

FormatPlain text or Base64

The caption under the connection ring and in the Android notification — in place of the default “You are protected”. Use base64: for non-ASCII.

ReClash-ActiveText: Nebula has you covered

reclash-servicelogoReClashflclashx-servicelogoProvider logo shown in the dashboard and connection control.

FormatAbsolute HTTPS image URL

Aliasflclashx-servicelogo

The logo on the dashboard and connection control. An absolute HTTPS URL, PNG or SVG, square 256–512 px, transparent background; keep the meaningful part inside the central 80 % — edges get rounded off.

ReClash-ServiceLogo: https://nebula.example/logo-512.png

reclash-serverinfoReClashflclashx-serverinfoGroup used to resolve the active server shown in the dashboard.

FormatProxy-group name, plain text or Base64

Aliasflclashx-serverinfo

Group used to resolve the active server shown in the dashboard.

ReClash-ServerInfo: Auto

reclash-buyplanReClashflclashx-buyplanSubscription renewal or plan purchase action.

FormatURL

Aliasflclashx-buyplan

Subscription renewal or plan purchase action.

ReClash-BuyPlan: https://nebula.example/billing

reclash-buytrafficReClashflclashx-buytrafficExtra-traffic purchase action.

FormatURL

Aliasflclashx-buytraffic

Extra-traffic purchase action.

ReClash-BuyTraffic: https://nebula.example/billing/traffic

reclash-reporturlReClashSubscription issue-report action.

FormatURL

Subscription issue-report action.

reclash-viewReClashflclashx-viewSuggests the proxy-page presentation for this profile.

Formattype:… sort:… layout:… icon:… card:…

Aliasflclashx-view

Tokens of the form key:value, comma- or semicolon-separated. Unknown keys and values are dropped, the rest apply. It is a suggestion, not an order: the user can switch the view back.

Key	Values	What it sets
`type`	`tab` `list`	Proxy page shape
`sort`	`default` `none` `delay` `name`	Node sorting
`layout`	`loose` `standard` `tight`	Grid density
`icon`	`none` `standard` `icon`	Node icons
`card`	`expand` `shrink` `min` `oneline`	Card size

ReClash-View: type:tab; sort:delay; layout:tight; icon:standard; card:shrink

reclash-hexReClashflclashx-hexApplies a theme while this profile is active.

FormatRRGGBB[:variant][:pureblack]

Aliasflclashx-hex

An RRGGBB or AARRGGBB colour, then an optional palette variant and an optional pureblack (an AMOLED black background). Separators are :, ; or ,. The theme applies while the profile is active.

Variant	What it does
`tonalspot`	Balanced, the default
`fidelity`	Closer to the source colour
`monochrome`	Greyscale
`neutral`	Nearly desaturated
`vibrant`	Maximum saturation
`expressive`	Shifted hue
`content`	Content-driven, livelier than fidelity

ReClash-Hex: 2FD3B6
ReClash-Hex: 2FD3B6:vibrant
ReClash-Hex: FF7C5CFF;expressive;pureblack

reclash-backgroundReClashflclashx-backgroundApplies a dashboard background while this profile is active.

Formaturl[,opacity]

Aliasflclashx-background

An absolute http or https image URL and an optional opacity from 1 to 100. The default is 10 — a background should stay a background. Applies while the profile is active.

ReClash-Background: https://nebula.example/bg.webp,14

reclash-heroringReClashSets the connected-state hero-ring gradient.

Formatc1;c2;c3

Exactly three colours — the gradient of the ring around the connect button. Fewer or more than three values are ignored entirely. This header has no alias.

ReClash-HeroRing: 7C5CFF;3686ED;2FD3B6

reclash-heroeffectReClashA living effect behind the connection ring. Only aurora is supported for now; any other value turns the effect off.

Formataurora

A living effect behind the connection ring. Only aurora — a soft aurora glow — is supported for now; any other value turns the effect off. This header has no alias.

ReClash-HeroEffect: aurora

reclash-widgetsReClashSuggests dashboard widgets and their order.

Formatcomma-separated names

Comma-separated widget names — their order becomes the order on the dashboard. Widgets unavailable on a platform simply do not appear. reclash-custom controls how the list merges with the user's own.

Name	Widget	Available on
`networkSpeed`	Network speed	all platforms
`outboundModeV2`	Routing mode	all platforms
`outboundMode`	Routing mode (legacy)	all platforms
`trafficUsage`	Traffic usage	all platforms
`networkDetection`	Network detection	all platforms
`tunButton`	TUN button	Windows, macOS, Linux
`vpnButton`	VPN button	Android
`systemProxyButton`	System proxy	Windows, macOS, Linux
`intranetIp`	Intranet IP	all platforms
`memoryInfo`	Memory info	all platforms
`metaInfo`	Subscription: term and quota	all platforms
`announce`	Announcement	all platforms
`serviceInfo`	Service card	all platforms
`changeServerButton`	Change server	all platforms
`smartRouting`	Smart routing	all platforms

ReClash-Widgets: serviceInfo,networkSpeed,trafficUsage,outboundModeV2

reclash-customReClashControls how reclash-widgets is merged.

Formatadd | update

How reclash-widgets merges with the set the user already assembled: add appends the missing widgets, update replaces the whole set. Without this header the set is suggested only when the profile is first added.

ReClash-Widgets: serviceInfo,networkSpeed,trafficUsage,outboundModeV2
ReClash-Custom: update

reclash-settingsReClashApplication defaults offered when the profile is first added — applied only after the user confirms.

Formatcomma-separated tokens

Application defaults. Offered once — when the profile is first added: ReClash shows the requested changes and applies them only after the user confirms. Unlisted settings keep their values; after that the settings belong to the user.

Token	What it turns on
`minimize`	Minimize instead of exiting
`autorun`	Start the connection when ReClash opens
`shadowstart`	Launch in the background
`autostart`	Launch at OS startup
`autoupdate`	Check for ReClash updates
`openlogs`	Open logs with the connection
`closeconnections`	Close connections when the VPN pauses

ReClash-Settings: minimize,autoupdate

reclash-newdomainReClashflclashx-newdomainProposes a subscription-domain migration subject to checks.

Formathost[:port]

Aliasflclashx-newdomain

A hostname and an optional port only — no scheme, path or query. The client does not switch blindly: it verifies that the new address really serves your subscription, and only then migrates the profile.

ReClash-NewDomain: sub.nebula.example
ReClash-NewDomain: sub.nebula.example:8443

reclash-fallbackhostsReClashSupplies fallback hosts for transient fetch failures.

Formatup to 4 comma-separated hosts

Up to four comma-separated hostnames — no ports, no scheme. Names are lowercased, duplicates removed, the excess dropped. The client falls back to them when the main address is temporarily unreachable. No alias.

ReClash-FallbackHosts: sub2.nebula.example,sub3.nebula.example

Devices and HWID 6

Request headers from the client and the responses to them.

x-hwidDeviceStable 16-character device hash

Format—

Stable 16-character device hash

X-HWID: 3f7a9c2e5b1d8046

x-device-osDeviceOperating-system name

Format—

Operating-system name

X-Device-OS: Android

x-ver-osDeviceOperating-system version

Format—

Operating-system version

X-Ver-OS: 14

x-device-modelDeviceDevice model or host name

Format—

Device model or host name

X-Device-Model: Pixel 8

x-hwid-max-devices-reachedDeviceShows the device-limit message and offers reclash-supporturl when available.

Formattrue

Shows the device-limit message and offers reclash-supporturl when available.

X-HWID-Max-Devices-Reached: true

x-hwid-not-supportedDeviceShows that the selected client/device mode is unsupported.

Formattrue

Shows that the selected client/device mode is unsupported.

X-HWID-Not-Supported: true