package profile

Get desktop application:
View/edit binary Protocol Buffers messages

* ProfileService defines the RPC methods available for managing profiles.

• rpc AddProfile (AddProfileRequest, ProfileResponse)

  profile_service.proto:87

  * AddProfile adds a new profile using either a URL or the raw profile content.

  message AddProfileRequest

  profile_service.proto:29

  * AddProfileRequest is the request message for adding a profile via URL or content.

  • string url = 1

    The URL of the profile to add.

  • string content = 2

    The profile content to add (used if 'url' is empty).

  • string name = 3

    The optional name of the profile.

  • bool mark_as_active = 4

    Whether to mark the profile as active.

• rpc DeleteProfile (ProfileRequest, hcommon.Response)

  profile_service.proto:92

  * DeleteProfile deletes a profile identified by ID, name, or URL.

• rpc GetActiveProfile (hcommon.Empty, ProfileResponse)

  profile_service.proto:77

  * GetActiveProfile retrieves the currently active profile.

• rpc GetAllProfiles (hcommon.Empty, MultiProfilesResponse)

  profile_service.proto:72

  * GetAllProfiles fetches all profiles.

  message MultiProfilesResponse

  profile_service.proto:48

  * MultiProfilesResponse is the response message for fetching multi profiles.

  • repeated ProfileEntity profiles = 1

    A list of profile entities.

  • hcommon.ResponseCode response_code = 2

    The response code indicating success or failure.

  • string message = 3

    A message indicating the result or error, if any.

• rpc GetProfile (ProfileRequest, ProfileResponse)

  profile_service.proto:62

  * GetProfile fetches a profile by ID, name, or URL.

• rpc SetActiveProfile (ProfileRequest, hcommon.Response)

  profile_service.proto:82

  * SetActiveProfile sets a profile as active, identified by ID, name, or URL.

• rpc UpdateProfile (ProfileEntity, ProfileResponse)

  profile_service.proto:67

  * UpdateProfile updates an existing profile.

ProfileEntity defines a profile entity.

Used as request type in: ProfileService.UpdateProfile

Used as field type in: MultiProfilesResponse, ProfileResponse

• string id = 1

  Unique identifier for the profile.

• string name = 3

  bool active = 2; // Indicates if the profile is active.

  Name of the profile.

• string url = 4

  URL associated with the profile.

• int64 last_update = 5

  Last update time in milliseconds of the profile.

• optional ProfileOptions options = 6

  Options associated with the profile.

• optional SubscriptionInfo sub_info = 7

  Subscription-related information.

• optional hiddifyoptions.HiddifyOptions override_hiddify_options = 8

  Override Hiddify options.

ProfileOptions defines options for a profile.

Used in: ProfileEntity

• int64 update_interval = 1

  Update interval in milliseconds.

* ProfileRequest is the request message for fetching or identifying a profile by ID, name, or URL.

Used as request type in: ProfileService.DeleteProfile, ProfileService.GetProfile, ProfileService.SetActiveProfile

• string id = 1

  The ID of the profile to fetch (Fastest and recommended).

• string name = 2

  The name of the profile to fetch (if both 'id' and 'url' are empty).

• string url = 3

  The URL of the profile to fetch (if both 'id' and 'name' are empty).

* ProfileResponse is the response message for profile service operations.

Used as response type in: ProfileService.AddProfile, ProfileService.GetActiveProfile, ProfileService.GetProfile, ProfileService.UpdateProfile

• optional ProfileEntity profile = 1

  The profile entity, populated in successful operations.

• hcommon.ResponseCode response_code = 2

  The response code indicating success or failure.

• string message = 3

  A message indicating the result or error, if any.

SubscriptionInfo defines subscription-related information.

Used in: ProfileEntity

• int64 upload = 1

  Upload speed in bytes.

• int64 download = 2

  Download speed in bytes.

• int64 total = 3

  Total data in bytes.

• int64 expire = 4

  Expiration time in milliseconds of the subscription.

• string web_page_url = 5

  URL for the web page.

• string support_url = 6

  URL for support.