package mullvad_daemon.management_interface
Get desktop application:
View/edit binary Protocol Buffers messages
Control and get tunnel state
rpc EventsListen (, stream )
management_interface.proto:19Control the daemon and receive events
message
management_interface.proto:693oneof event
tunnel_state = 1
settings = 2
relay_list = 3
version_info = 4
device = 5
remove_device = 6
new_access_method = 7
DEPRECATED: Prefer PrepareRestartV2.
Takes a a boolean argument which says whether the daemon should stop after it is done preparing for a restart.
Relays and tunnel constraints
Settings
Account management
message
management_interface.proto:138string id = 1
optional expiry = 2
message
management_interface.proto:143optional number = 1
message
management_interface.proto:145uint64 seconds_added = 1
optional new_expiry = 2
Device management
message
management_interface.proto:754repeated devices = 1
message
management_interface.proto:756string account_number = 1
string device_id = 2
WireGuard key management
message
management_interface.proto:619bytes key = 1
optional created = 2
Custom lists
Access methods
message
management_interface.proto:458string name = 1
bool enabled = 2
optional access_method = 3
rpc GetSplitTunnelProcesses (, stream )
management_interface.proto:97Split tunneling (Linux)
Split tunneling (Windows, macOS, Android)
Split tunneling (Windows, macOS)
message
management_interface.proto:630repeated processes = 1
Play payment (Android)
message
management_interface.proto:788string product_id = 1
optional purchase_token = 2
Check whether the app needs TCC approval for split tunneling (macOS)
Notify the split tunnel monitor that a volume was mounted or dismounted (Windows).
Apply a JSON blob to the settings See ../../docs/settings-patch-format.md for a description of the format
Return a JSON blob containing all overridable settings, if there are any
Get current feature indicators
Debug features
message
management_interface.proto:439Used in: ,
oneof access_method
direct = 1
bridges = 2
encrypted_dns_proxy = 3
custom = 4
message
management_interface.proto:441Used in:
(message has no fields)
message
management_interface.proto:440Used in:
(message has no fields)
message
management_interface.proto:442Used in:
(message has no fields)
message
management_interface.proto:451Used as request type in: ManagementService.UpdateApiAccessMethod
Used as response type in: ManagementService.GetCurrentApiAccessMethod
Used as field type in: ,
optional id = 1
string name = 2
bool enabled = 3
optional access_method = 4
message
management_interface.proto:741Used in:
string account_number = 1
optional device = 2
Used in:
NOTHING = 0
BLOCK = 1
RECONNECT = 2
message
management_interface.proto:464Used in:
optional direct = 1
optional mullvad_bridges = 2
optional encrypted_dns_proxy = 3
repeated custom = 4
message
management_interface.proto:632Used as response type in: ManagementService.GetVersionInfo
Used as field type in:
bool supported = 1
string latest_stable = 2
string latest_beta = 3
optional string suggested_upgrade = 4
message
management_interface.proto:719Used in:
repeated shadowsocks = 1
message
management_interface.proto:346Used as request type in: ManagementService.SetBridgeSettings
Used as field type in:
BridgeSettings.BridgeType bridge_type = 1
optional normal = 2
optional custom = 3
message
management_interface.proto:351Used in:
optional location = 1
repeated string providers = 2
Ownership ownership = 3
Used in:
NORMAL = 0
CUSTOM = 1
message
management_interface.proto:375Used as request type in: ManagementService.SetBridgeState
Used as field type in:
BridgeState.State state = 1
Used in:
AUTO = 0
ON = 1
OFF = 2
message
management_interface.proto:538Used in:
oneof config
openvpn = 1
wireguard = 2
message
management_interface.proto:539Used in:
string address = 1
TransportProtocol protocol = 2
string username = 3
string password = 4
message
management_interface.proto:545Used in:
optional tunnel = 1
optional peer = 2
string ipv4_gateway = 3
optional string ipv6_gateway = 4
message
management_interface.proto:550Used in:
bytes public_key = 1
repeated string allowed_ips = 2
string endpoint = 3
message
management_interface.proto:546Used in:
bytes private_key = 1
repeated string addresses = 2
message
management_interface.proto:607Used in:
repeated string addresses = 1
message
management_interface.proto:401Used as request type in: ManagementService.UpdateCustomList
Used as field type in:
string id = 1
string name = 2
repeated locations = 3
message
management_interface.proto:407Used in:
repeated custom_lists = 1
message
management_interface.proto:431Used as request type in: ManagementService.TestCustomApiAccessMethod
Used as field type in: ,
oneof proxy_method
socks5local = 1
socks5remote = 2
shadowsocks = 3
message
management_interface.proto:533Used in:
string host = 1
optional config = 2
message
management_interface.proto:577Used as request type in: ManagementService.SetDaitaSettings
Used as field type in:
bool enabled = 1
bool direct_only = 2
message
management_interface.proto:598Used in:
bool block_ads = 1
bool block_trackers = 2
bool block_malware = 3
bool block_adult_content = 4
bool block_gambling = 5
bool block_social_media = 6
message
management_interface.proto:746Used in: , ,
string id = 1
string name = 2
bytes pubkey = 3
bool hijack_dns = 5
optional created = 6
message
management_interface.proto:771Used in:
DeviceEvent.Cause cause = 1
optional new_state = 2
Used in:
LOGGED_IN = 0
LOGGED_OUT = 1
REVOKED = 2
UPDATED = 3
ROTATED_KEY = 4
message
management_interface.proto:761Used as response type in: ManagementService.GetDevice
Used as field type in:
DeviceState.State state = 1
optional device = 2
Used in:
LOGGED_IN = 0
LOGGED_OUT = 1
REVOKED = 2
message
management_interface.proto:609Used as request type in: ManagementService.SetDnsOptions
Used as field type in:
DnsOptions.DnsState state = 1
optional default_options = 2
optional custom_options = 3
Used in:
DEFAULT = 0
CUSTOM = 1
message
management_interface.proto:308Used in:
string address = 1
TransportProtocol protocol = 2
message
management_interface.proto:156Used in:
ErrorState.Cause cause = 1
optional blocking_error = 2
ErrorState.AuthFailedError auth_failed_error = 3
AUTH_FAILED
ErrorState.GenerationError parameter_error = 4
TUNNEL_PARAMETER_ERROR
optional policy_error = 5
SET_FIREWALL_POLICY_ERROR
optional int32 create_tunnel_error = 6
CREATE_TUNNEL_DEVICE
optional other_always_on_app_error = 8
Android only
optional invalid_dns_servers_error = 9
Android only
Used in:
UNKNOWN = 0
INVALID_ACCOUNT = 1
EXPIRED_ACCOUNT = 2
TOO_MANY_CONNECTIONS = 3
Used in:
AUTH_FAILED = 0
IPV6_UNAVAILABLE = 1
SET_FIREWALL_POLICY_ERROR = 2
SET_DNS_ERROR = 3
START_TUNNEL_ERROR = 4
CREATE_TUNNEL_DEVICE = 5
TUNNEL_PARAMETER_ERROR = 6
IS_OFFLINE = 7
NOT_PREPARED = 8
Android only
OTHER_ALWAYS_ON_APP = 9
Android only
OTHER_LEGACY_ALWAYS_ON_VPN = 10
Android only
INVALID_DNS_SERVERS = 11
Android only
SPLIT_TUNNEL_ERROR = 12
NEED_FULL_DISK_PERMISSIONS = 13
message
management_interface.proto:194Used in:
FirewallPolicyError.ErrorType type = 1
uint32 lock_pid = 2
LOCKED
optional string lock_name = 3
Used in:
GENERIC = 0
LOCKED = 1
Used in:
NO_MATCHING_RELAY = 0
NO_MATCHING_BRIDGE_RELAY = 1
NO_WIREGUARD_KEY = 2
CUSTOM_TUNNEL_HOST_RESOLUTION_ERROR = 3
NETWORK_IPV4_UNAVAILABLE = 4
NETWORK_IPV6_UNAVAILABLE = 5
message
management_interface.proto:208Used in:
repeated string ip_addrs = 1
message
management_interface.proto:206Used in:
string app_name = 1
message
management_interface.proto:624Used in:
uint32 pid = 1
string image = 2
bool inherited = 3
Used in:
QUANTUM_RESISTANCE = 0
MULTIHOP = 1
BRIDGE_MODE = 2
SPLIT_TUNNELING = 3
LOCKDOWN_MODE = 4
UDP_2_TCP = 5
SHADOWSOCKS = 6
LAN_SHARING = 7
DNS_CONTENT_BLOCKERS = 8
CUSTOM_DNS = 9
SERVER_IP_OVERRIDE = 10
CUSTOM_MTU = 11
CUSTOM_MSS_FIX = 12
DAITA = 13
DAITA_MULTIHOP = 14
message
management_interface.proto:275Used as response type in: ManagementService.GetFeatureIndicators
Used as field type in: ,
repeated FeatureIndicator active_features = 1
message
management_interface.proto:324Used in: ,
optional string ipv4 = 1
optional string ipv6 = 2
string country = 3
optional string city = 4
double latitude = 5
double longitude = 6
bool mullvad_exit_ip = 7
optional string hostname = 8
optional string bridge_hostname = 9
optional string entry_hostname = 10
optional string obfuscator_hostname = 11
message
management_interface.proto:369Used in: ,
string country = 1
optional string city = 2
optional string hostname = 3
Used in:
V4 = 0
V6 = 1
message
management_interface.proto:679Used in:
string country = 1
string country_code = 2
string city = 3
string city_code = 4
double latitude = 5
double longitude = 6
message
management_interface.proto:362Used in: , ,
oneof type
string custom_list = 1
location = 2
message
management_interface.proto:505Used in:
optional location = 1
repeated string providers = 2
TunnelType tunnel_type = 3
optional wireguard_constraints = 4
optional openvpn_constraints = 5
Ownership ownership = 6
message
management_interface.proto:295Used in:
string address = 1
uint32 port = 2
TransportProtocol protocol = 3
ObfuscationEndpoint.ObfuscationType obfuscation_type = 4
Used in:
UDP2TCP = 0
SHADOWSOCKS = 1
QUIC = 2
message
management_interface.proto:388Used as request type in: ManagementService.SetObfuscationSettings
Used as field type in:
ObfuscationSettings.SelectedObfuscation selected_obfuscation = 1
optional udp2tcp = 2
optional shadowsocks = 3
Used in:
AUTO = 0
OFF = 1
UDP2TCP = 2
SHADOWSOCKS = 3
QUIC = 4
message
management_interface.proto:714Used in:
uint32 port = 1
TransportProtocol protocol = 2
message
management_interface.proto:712Used in:
repeated endpoints = 1
message
management_interface.proto:519Used in:
optional port = 1
Used in: ,
ANY = 0
MULLVAD_OWNED = 1
RENTED = 2
message
management_interface.proto:793Used as response type in: ManagementService.InitPlayPurchase
Used as field type in:
string token = 1
message
management_interface.proto:736Used in:
uint32 first = 1
uint32 last = 2
message
management_interface.proto:313Used in:
string address = 1
TransportProtocol protocol = 2
ProxyEndpoint.ProxyType proxy_type = 3
Used in:
SHADOWSOCKS = 0
CUSTOM = 1
message
management_interface.proto:568Used as request type in: ManagementService.SetQuantumResistantTunnel
Used as field type in:
QuantumResistantState.State state = 1
Used in:
AUTO = 0
ON = 1
OFF = 2
message
management_interface.proto:653Used in:
string hostname = 1
string ipv4_addr_in = 2
optional string ipv6_addr_in = 3
bool include_in_country = 4
bool active = 5
bool owned = 6
string provider = 7
fixed64 weight = 8
Relay.RelayType endpoint_type = 9
optional endpoint_data = 10
optional location = 11
Used in:
OPENVPN = 0
BRIDGE = 1
WIREGUARD = 2
message
management_interface.proto:705Used as response type in: ManagementService.GetRelayLocations
Used as field type in:
repeated countries = 1
optional openvpn = 2
optional bridge = 3
optional wireguard = 4
message
management_interface.proto:645Used in:
string name = 1
string code = 2
double latitude = 3
double longitude = 4
repeated relays = 5
message
management_interface.proto:639Used in:
string name = 1
string code = 2
repeated cities = 3
message
management_interface.proto:487Used as request type in: ManagementService.SetRelayOverride
Used as field type in:
string hostname = 1
optional string ipv4_addr_in = 2
optional string ipv6_addr_in = 3
message
management_interface.proto:498Used as request type in: ManagementService.SetRelaySettings
Used as field type in:
oneof endpoint
custom = 1
normal = 2
message
management_interface.proto:783Used in:
string account_number = 1
repeated new_device_list = 2
message
management_interface.proto:471Used as response type in: ManagementService.GetSettings
Used as field type in:
optional relay_settings = 1
optional bridge_settings = 2
optional bridge_state = 3
bool allow_lan = 4
bool block_when_disconnected = 5
bool auto_connect = 6
optional tunnel_options = 7
bool show_beta_releases = 8
optional split_tunnel = 9
optional obfuscation_settings = 10
optional custom_lists = 11
optional api_access_methods = 12
repeated relay_overrides = 13
message
management_interface.proto:424Used in:
string ip = 1
uint32 port = 2
string password = 3
string cipher = 4
message
management_interface.proto:721Used in:
uint32 port = 1
string cipher = 2
string password = 3
TransportProtocol protocol = 4
message
management_interface.proto:386Used in:
optional uint32 port = 1
message
management_interface.proto:409Used in:
string remote_ip = 1
uint32 remote_port = 2
TransportProtocol remote_transport_protocol = 3
uint32 local_port = 4
message
management_interface.proto:419Used in:
string ip = 1
uint32 port = 2
optional auth = 3
message
management_interface.proto:415Used in:
string username = 1
string password = 2
message
management_interface.proto:493Used in:
bool enable_exclusions = 1
repeated string apps = 2
message
management_interface.proto:514Used in:
TransportProtocol protocol = 1
optional uint32 port = 2
Used in: , , , , , , , ,
UDP = 0
TCP = 1
message
management_interface.proto:263Used in:
string address = 1
TransportProtocol protocol = 2
TunnelType tunnel_type = 3
bool quantum_resistant = 4
optional proxy = 5
optional obfuscation = 6
optional entry_endpoint = 7
optional tunnel_metadata = 8
bool daita = 9
message
management_interface.proto:338Used in:
string tunnel_interface = 1
message
management_interface.proto:582Used in:
optional openvpn = 1
optional wireguard = 2
optional generic = 3
optional dns_options = 4
message
management_interface.proto:590Used in:
bool enable_ipv6 = 1
message
management_interface.proto:583Used in:
optional uint32 mssfix = 1
message
management_interface.proto:584Used in:
optional uint32 mtu = 1
optional rotation_interval = 2
optional quantum_resistant = 4
optional daita = 5
message
management_interface.proto:228Used as response type in: ManagementService.GetTunnelState
Used as field type in:
oneof state
disconnected = 1
connecting = 2
connected = 3
disconnecting = 4
error = 5
message
management_interface.proto:237Used in:
optional relay_info = 1
optional feature_indicators = 2
message
management_interface.proto:233Used in:
optional relay_info = 1
optional feature_indicators = 2
message
management_interface.proto:229Used in:
optional disconnected_location = 1
bool locked_down = 2
message
management_interface.proto:241Used in:
AfterDisconnect after_disconnect = 1
message
management_interface.proto:242Used in:
optional error_state = 1
message
management_interface.proto:258Used in: ,
optional tunnel_endpoint = 1
optional location = 2
Used in: ,
OPENVPN = 0
WIREGUARD = 1
message
management_interface.proto:136Used as request type in: ManagementService.RemoveApiAccessMethod, ManagementService.SetApiAccessMethod, ManagementService.TestApiAccessMethodById
Used as response type in: ManagementService.AddApiAccessMethod
Used as field type in:
string value = 1
message
management_interface.proto:384Used in:
optional uint32 port = 1
message
management_interface.proto:526Used in:
optional uint32 port = 1
optional IpVersion ip_version = 2
bool use_multihop = 3
optional entry_location = 4
message
management_interface.proto:728Used in:
repeated port_ranges = 1
string ipv4_gateway = 2
string ipv6_gateway = 3
repeated shadowsocks_port_ranges = 4
repeated uint32 udp2tcp_ports = 5
message
management_interface.proto:673bytes public_key = 1
bool daita = 2
repeated string shadowsocks_extra_addr_in = 3