App management
App Management
App management functionality includes two directions:
Standard parameters that work for most panels.
Advanced parameters for which it is necessary to pass Provider ID with the subscription.
To activate a parameter, pass the value true or 1; to disable it — any other non-empty value (for example, 0 or false).
Standard Parameters
Subscription Auto-Update
The system creates a task to perform the operation at a specified interval. Depending on internal priorities, the system tries to start the subscription update at the set time. If for any reason the update was not performed within the specified interval, it will occur automatically on the next app launch. The interval is set in hours and must be a multiple of one hour.
Example of setting this parameter:
profile-update-interval: [int]Transmission methods:
HTTP/2 200
date: Wed, 24 Nov 2024 10:00:52 GMT
content-type: application/json
content-length: 3798
content-disposition: attachment; filename="213"
profile-update-interval: 1#profile-update-interval: 1
vless://70cc48c5‑b2f4…
vmess://zkIAU1JitkI…Subscription Name
The name of the subscription profile. Can be passed as plain text or in base64 (UTF-8). Limit: Maximum length — 25 characters.
Via the subscription body, by adding a # sign before the parameter (for example, #profile-title)
Example of setting this parameter:
profile-title: [string]Transmission methods:
HTTP/2 200
date: Wed, 24 Nov 2024 10:00:52 GMT
content-type: application/json
content-length: 3798
content-disposition: attachment; filename="213"
profile-title: Name VPN#profile-title: Name VPN
vless://70cc48c5‑b2f4…
vmess://zkIAU1JitkI…Subscription Status String (traffic, expiration date)
Displays information about the balance, amount of used traffic, and subscription expiration date. In the app, the left part of the scale shows the amount of spent traffic (upload + download), and the right part — the total volume (total) after the "/" symbol. The subscription expiration date is specified in the expire parameter. Note: all data is passed in one header and separated by the ; symbol.
Example of setting this parameter:
subscription-userinfo: [string]Transmission methods:
HTTP/2 200
date: Wed, 24 Nov 2024 10:00:52 GMT
content-type: application/json
content-length: 3798
content-disposition: attachment; filename="213"
subscription-userinfo: upload=0; download=2153701362; total=0; expire=1790951622#subscription-userinfo: upload=0; download=2153701362; total=0; expire=1790951622
vless://70cc48c5‑b2f4…
vmess://zkIAU1JitkI…Support Page Link
Button to go to the support page. Displayed as a blue icon located on the right side of the line. If the link leads to Telegram, a Telegram icon is displayed; in other cases, a standard link icon is used.
Example of setting this parameter:
support-url: [string]Transmission methods:
HTTP/2 200
date: Wed, 24 Nov 2024 10:00:52 GMT
content-type: application/json
content-length: 3798
content-disposition: attachment; filename="213"
support-url: https://t.me/happ_chat#support-url: https://t.me/happ_chat
vless://70cc48c5‑b2f4…
vmess://zkIAU1JitkI…Website Page Link
Button to go to the subscription website page. Displayed as a blue icon located on the left side of the line. If the parameter is not set, the icon will be gray.
Example of setting this parameter:
profile-web-page-url: [string]Transmission methods:
HTTP/2 200
date: Wed, 24 Nov 2024 10:00:52 GMT
content-type: application/json
content-length: 3798
content-disposition: attachment; filename="213"
profile-web-page-url: https://happ.su#profile-web-page-url: https://happ.su
vless://70cc48c5‑b2f4…
vmess://zkIAU1JitkI…Announcement
The subscription can contain announcement text, passed in plain text or Base64 format. Limit: maximum displayed text length — 200 characters.
Example of setting this parameter:
announce: [string]Transmission methods:
HTTP/2 200
date: Wed, 24 Nov 2024 10:00:52 GMT
content-type: application/json
content-length: 3798
content-disposition: attachment; filename="213"
announce: base64:SGFwcCB0aGUgYmVzdCE=#announce: base64:SGFwcCB0aGUgYmVzdCE=
vless://70cc48c5‑b2f4…
vmess://zkIAU1JitkI…Advanced Parameters
Provider ID parameter is required!
Server Description in Subscription
Allows setting an additional caption that is displayed under the server name instead of the standard text (for example, "VMess", "VLESS", "Trojan").
Maximum length — 30 characters.
If it doesn't fit on the screen, it will be shortened with an ellipsis.
Set after
titlethrough the?separator.
Examples:
vless://[email protected]:443?encryption=none&node_id=482&headerType=none&type=tcp&security=reality&sni=booking.com&fp=chrome&pbk=YqHW8a4iAc1SZYpTrFVoOQg1F3yAdX1tWXuROZUCsEU&sid=6ba85179e30d4fc2&flow=xtls-rprx-vision&xtls=2#title?serverDescription=SGFwcCB0aGUgYmVzdA==vmess://eyJob3N0IjoiZWxhaG9tZWtpdGNoZW4uY29tIiwicGF0aCI6IiIsInRscyI6IiIsImFkZCI6ImVsYWhvbWVraXRjaGVuLmNvbSIsInBvcnQiOjUwMDAsImFpZCI6MCwibmV0IjoidGNwIiwidHlwZSI6Im5vbmUiLCJ2IjoiMiIsInBzIjoi4piB77iPIDogNTMuM0dCIiwiaWQiOiI4N2ZhN2VmMC1jM2ZjLTNiOTAtYTJkOC01OGZjYjhkZmZmMjYiLCJzZXJ2ZXJEZXNjcmlwdGlvbiI6IkhhcHAgdGhlIGJlc3QifQ==trojan://[email protected]:443?security=tls&insecure=1&fragment=3,1,tlshello&type=ws&headerType=&path=%2F&host=quictest.burncommunity.ru&sni=quictest.burncommunity.ru&fp=chrome&alpn=http%2F1.1#title?serverDescription=SGFwcCB0aGUgYmVzdA==socks://pkg-private2-country-us-city-new_york_city:[email protected]:1080#title?serverDescription=SGFwcCB0aGUgYmVzdA==ss://[email protected]:9042#title?serverDescription=SGFwcCB0aGUgYmVzdA==wireguard://[email protected]:10803?publickey=asd33d223d33&address=dom.ru&allowinsecure=1&mtu=1500&reserved=1,22,33#title?serverDescription=SGFwcCB0aGUgYmVzdA=={
"dns": {
...
},
"inbounds": [
...
],
"outbounds": [
...
],
"remarks": "🇭🇰 Hong Kong",
"meta": {
"serverDescription": "Happ the best"
}
}Hide Server Settings in Subscription
Disable the ability to view and edit server configurations for your subscription users. The setting applies to both already added subscriptions and those that will be added in the future.
Example of setting this parameter:
hide-settings: [true / 1]Transmission methods:
HTTP/2 200
date: Wed, 24 Nov 2024 10:00:52 GMT
content-type: application/json
content-length: 3798
content-disposition: attachment; filename="213"
hide-settings: 1#hide-settings: 1
vless://70cc48c5‑b2f4…
vmess://zkIAU1JitkI…Managing App Settings
Provider ID parameter is required!
Prohibit Collapsing Subscriptions
This function disables the ability to collapse the subscription: the server list is always displayed in full, expanded view.
Example of setting this parameter:
subscriptions-collapse: [String] Transmission methods:
HTTP/2 200
date: Wed, 24 Nov 2024 10:00:52 GMT
content-type: application/json
content-length: 3798
content-disposition: attachment; filename="213"
subscriptions-collapse: 1#subscriptions-collapse: 1
vless://70cc48c5‑b2f4…
vmess://zkIAU1JitkI…Ping Display Mode
Allows displaying icons instead of time values.
Example of setting this parameter:
ping-result: [time,icon]Transmission methods:
HTTP/2 200
date: Wed, 24 Nov 2024 10:00:52 GMT
content-type: application/json
content-length: 3798
content-disposition: attachment; filename="213"
ping-result: icon#ping-result: icon
vless://70cc48c5‑b2f4…
vmess://zkIAU1JitkI…Last updated