package hcore

Get desktop application:
View/edit binary Protocol Buffers messages

• rpc ChangeHiddifySettings (ChangeHiddifySettingsRequest, CoreInfoResponse)

  hcore_service.proto:18

  message ChangeHiddifySettingsRequest

  hcore.proto:202

  • string hiddify_settings_json = 1

• rpc Close (CloseRequest, hcommon.Empty)

  hcore_service.proto:35

  message CloseRequest

  hcore.proto:78

  • SetupMode mode = 1

• rpc CoreInfoListener (hcommon.Empty, stream CoreInfoResponse)

  hcore_service.proto:11

• rpc EnsureAdminBgService (EnsureAdminBgServiceRequest, stream EnsureAdminBgServiceEvent)

  hcore_service.proto:42

  Windows/Linux: install/start admin_bgservice if needed and start the bg core until STARTED.

  message EnsureAdminBgServiceRequest

  hcore.proto:316

  • string config_content = 1

  • string config_name = 2

  • string settings_json = 3

  • map<string, bytes> resources = 4

  • bool disable_memory_limit = 5

  • int32 owner_pid = 6

  • string cli_path = 7

    Absolute path to this app's HiddifyCli / HiddifyCli.exe (used for elevate install).

  • string owner_user = 8

  message EnsureAdminBgServiceEvent

  hcore.proto:328

  • EnsureAdminBgServiceProgress progress = 1

  • string message = 2

  • uint32 service_port = 3

• rpc GenerateWarpConfig (GenerateWarpConfigRequest, WarpGenerationResponse)

  hcore_service.proto:31

  message GenerateWarpConfigRequest

  hcore.proto:227

  • string license_key = 1

  • string account_id = 2

  • string access_token = 3

  message WarpGenerationResponse

  hcore.proto:178

  • optional WarpAccount account = 1

  • string log = 2

  • optional WarpWireguardConfig config = 3

• rpc GetLANIP (hcommon.Empty, LANIPResponse)

  hcore_service.proto:36

  message LANIPResponse

  hcore.proto:264

  • string ip = 1

• rpc GetSystemInfo (hcommon.Empty, SystemInfo)

  hcore_service.proto:14

• rpc GetSystemInfoStream (hcommon.Empty, stream SystemInfo)

  hcore_service.proto:15

• rpc GetSystemProxyStatus (hcommon.Empty, SystemProxyStatus)

  hcore_service.proto:32

  message SystemProxyStatus

  hcore.proto:184

  • bool available = 1

  • bool enabled = 2

• rpc HotReload (StartRequest, CoreInfoResponse)

  hcore_service.proto:27

  Apply the config to the running core without restarting it: outbounds, endpoints, inbounds (not TUN), DNS servers/rules/final and route rules/rule sets/final may change. Anything else, or a changed TUN inbound, returns HOT_RELOAD_FAILED and leaves the core running unchanged. When the core is stopped, it is started like Start.

• rpc IsAdmin (hcommon.Empty, IsAdminResponse)

  hcore_service.proto:38

  Whether this core process already has administrator/root rights (same token as the app).

  message IsAdminResponse

  hcore.proto:268

  • bool is_admin = 1

    True when the core process runs as Administrator (Windows) or root (Unix).

• rpc LogListener (LogRequest, stream LogMessage)

  hcore_service.proto:34

  message LogRequest

  hcore.proto:257

  • LogLevel level = 1

  message LogMessage

  hcore.proto:250

  • LogLevel level = 1

  • LogType type = 2

  • string message = 3

  • optional google.protobuf.Timestamp time = 4

• rpc MainOutboundsInfo (hcommon.Empty, stream OutboundGroupList)

  hcore_service.proto:13

• rpc NeedAdminBgService (NeedAdminBgServiceRequest, NeedAdminBgServiceResponse)

  hcore_service.proto:40

  Windows/Linux: whether elevated admin_bgservice is required for this connect.

  message NeedAdminBgServiceRequest

  hcore.proto:302

  • string service_mode = 1

    proxy | system-proxy | vpn

  • string hiddify_settings_json = 2

  • AdminPreference admin_preference = 3

  • bool privilege_error_remembered = 4

    True after an in-process start failed with a privilege error.

  message NeedAdminBgServiceResponse

  hcore.proto:311

  • AdminBgServiceDecision decision = 1

  • repeated AdminNeededProxy admin_needed_proxies = 2

• rpc OutboundsInfo (hcommon.Empty, stream OutboundGroupList)

  hcore_service.proto:12

• rpc Parse (ParseRequest, ParseResponse)

  hcore_service.proto:17

  message ParseRequest

  hcore.proto:189

  • string content = 1

  • string config_path = 2

  • string temp_path = 3

  • bool debug = 4

  message ParseResponse

  hcore.proto:196

  • hcommon.ResponseCode response_code = 1

  • string content = 2

  • string message = 3

• rpc Restart (StartRequest, CoreInfoResponse)

  hcore_service.proto:22

• rpc SelectOutbound (SelectOutboundRequest, hcommon.Response)

  hcore_service.proto:28

  message SelectOutboundRequest

  hcore.proto:218

  • string group_tag = 1

  • string outbound_tag = 2

• rpc SetSystemProxyEnabled (SetSystemProxyEnabledRequest, hcommon.Response)

  hcore_service.proto:33

  message SetSystemProxyEnabledRequest

  hcore.proto:233

  • bool is_enabled = 1

• rpc Setup (SetupRequest, hcommon.Response)

  hcore_service.proto:16

  message SetupRequest

  hcore.proto:82

  Define the message equivalent of SetupParameters

  • string base_path = 1

  • string working_dir = 2

  • string temp_dir = 3

  • int64 flutter_status_port = 4

  • string listen = 5

  • string secret = 6

  • bool debug = 7

  • SetupMode mode = 8

  • bool fix_android_stack = 9

• rpc Start (StartRequest, CoreInfoResponse)

  hcore_service.proto:10

• rpc StartService (StartRequest, CoreInfoResponse)

  hcore_service.proto:20

  rpc GenerateConfig (GenerateConfigRequest) returns (GenerateConfigResponse);

• rpc Stop (hcommon.Empty, CoreInfoResponse)

  hcore_service.proto:21

• rpc UrlTest (UrlTestRequest, hcommon.Response)

  hcore_service.proto:29

  message UrlTestRequest

  hcore.proto:223

  • string tag = 1

• rpc UrlTestActive (hcommon.Empty, hcommon.Response)

  hcore_service.proto:30

Used in: NeedAdminBgServiceResponse

• ADMIN_BG_SERVICE_NO = 0

• ADMIN_BG_SERVICE_ALREADY_CONNECTED = 1

• ADMIN_BG_SERVICE_NEEDS_ADMIN = 2

• ADMIN_BG_SERVICE_OPTIONAL_PROXY_NEED_ADMIN = 3

Used in: NeedAdminBgServiceResponse

• string tag = 1

• string summary = 2

• string detail = 3

Used in: NeedAdminBgServiceRequest

• ADMIN_PREFERENCE_UNSET = 0

• ADMIN_PREFERENCE_PREFER_ADMIN = 1

• ADMIN_PREFERENCE_PREFER_NO_ADMIN = 2

Used as response type in: Core.ChangeHiddifySettings, Core.CoreInfoListener, Core.HotReload, Core.Restart, Core.Start, Core.StartService, Core.Stop

• CoreStates core_state = 1

• MessageType message_type = 2

• string message = 3

The lifecycle is owned by the core: STOPPED -> STARTING -> WAITING -> STARTED, and STOPPING from any running state. A start is accepted only from STOPPED. While the core runs, its monitoring moves it between WAITING, STARTED and NO_AVAILABLE_PROXIES.

Used in: CoreInfoResponse

• STOPPED = 0

• STARTING = 1

  the background core is starting up completely

• STARTED = 2

  the core is up and at least one proxy has a positive ping; a lost ping moves it back to WAITING

• STOPPING = 3

  a stop was requested: reported at once, and every queued start is dropped

• HOT_RELOADING = 4

  the running core is applying a new config (HotReload); traffic keeps flowing

• WAITING = 5

  the core is up and no proxy has a ping yet (not tested, or the ping was lost); a positive ping moves it to STARTED

• NO_AVAILABLE_PROXIES = 6

  the core is up and every proxy was tested and timed out; not an error, a positive ping moves it to STARTED

Used in: EnsureAdminBgServiceEvent

• ENSURE_ADMIN_BG_WAITING_FOR_ELEVATION = 0

• ENSURE_ADMIN_BG_SERVICE_STARTING = 1

• ENSURE_ADMIN_BG_SERVICE_CONNECTED = 2

• ENSURE_ADMIN_BG_FAILED_PERMISSION_DENIED = 3

• ENSURE_ADMIN_BG_FAILED_OTHER = 4

• string path = 1

• string temp_path = 2

• bool debug = 3

• string config_content = 1

Used in: OutboundInfo

• string ip = 1

  The IP address.

• string country_code = 2

  The country code.

• string region = 3

  The region (optional).

• string city = 4

  The city (optional).

• int32 asn = 5

  The Autonomous System Number (optional).

• string org = 6

  The organization (optional).

• double latitude = 7

  The latitude (optional).

• double longitude = 8

  The longitude (optional).

• string postal_code = 9

  The postal code (optional).

• bool from_cache = 10

  Of a previous run, not looked up in this one yet; it may have changed.

Used in: LogMessage, LogRequest

• TRACE = 0

• DEBUG = 1

• INFO = 2

• WARNING = 3

• ERROR = 4

• FATAL = 5

Used in: LogMessage

• CORE = 0

• SERVICE = 1

• CONFIG = 2

Used in: CoreInfoResponse

• EMPTY = 0

• EMPTY_CONFIGURATION = 1

• START_COMMAND_SERVER = 2

• CREATE_SERVICE = 3

• START_SERVICE = 4

• UNEXPECTED_ERROR = 5

• ALREADY_STARTED = 6

• ALREADY_STOPPED = 7

• INSTANCE_NOT_FOUND = 8

• INSTANCE_NOT_STOPPED = 9

• INSTANCE_NOT_STARTED = 10

• ERROR_BUILDING_CONFIG = 11

• ERROR_PARSING_CONFIG = 12

• ERROR_READING_CONFIG = 13

• ERROR_EXTENSION = 14

• HOT_RELOAD_FAILED = 15

  HotReload could not apply the config (e.g. the TUN inbound changed); the running core is unchanged, restart it to apply the config

Used in: OutboundGroupList

• string tag = 1

• string type = 2

• string selected = 3

• bool selectable = 4

• bool Is_expand = 5

• repeated OutboundInfo items = 6

Used as response type in: Core.MainOutboundsInfo, Core.OutboundsInfo

• repeated OutboundGroup items = 1

• optional OutboundInfo chain_hop = 2

  main list only: the extra security / unblocker hop the traffic goes through now

Used in: OutboundGroup, OutboundGroupList

• string tag = 1

• string type = 2

• optional google.protobuf.Timestamp url_test_time = 3

• int32 url_test_delay = 4

• optional IpInfo ipinfo = 5

• bool is_selected = 6

• bool is_group = 7

• optional string group_selected_tag = 13

• optional string group_selected_tag_display = 14

• bool is_secure = 8

• bool is_visible = 9

• uint32 port = 10

• string host = 11

• string tag_display = 12

• int64 upload = 15

• int64 download = 16

• string detour = 17

• Status status = 18

  ready / connecting / registering / … (outbound or endpoint)

Used in: CloseRequest, SetupRequest

• OLD = 0

• GRPC_NORMAL = 1

• GRPC_BACKGROUND = 2

• GRPC_NORMAL_INSECURE = 3

• GRPC_BACKGROUND_INSECURE = 4

Used as request type in: Core.HotReload, Core.Restart, Core.Start, Core.StartService

• string config_path = 1

• string config_content = 2

  Optional if configPath is not provided.

• bool disable_memory_limit = 3

• bool delay_start = 4

• bool enable_old_command_server = 5

• bool enable_raw_config = 6

• string config_name = 7

Connection state of an outbound or endpoint (mirrors adapter.Status).

Used in: OutboundInfo

• READY = 0

• CONNECTING = 1

• RECONNECTING = 2

• SEARCHING = 3

• FAILED = 4

• REGISTERING = 5

(message has no fields)

Used as response type in: Core.GetSystemInfo, Core.GetSystemInfoStream

• int64 memory = 1

• int32 goroutines = 2

• int32 connections_in = 3

• int32 connections_out = 4

• bool traffic_available = 5

• int64 uplink = 6

• int64 downlink = 7

• int64 uplink_total = 8

• int64 downlink_total = 9

• string current_outbound = 10

• string current_profile = 11

Used in: WarpGenerationResponse

• string account_id = 1

• string access_token = 2

Used in: WarpGenerationResponse

• string private_key = 1

• string local_address_ipv4 = 2

• string local_address_ipv6 = 3

• string peer_public_key = 4

• string client_id = 5