package api.instance

Get desktop application:
View/edit binary Protocol Buffers messages

• rpc GetAclStats (GetAclStatsRequest, GetAclStatsResponse)

  api_instance.proto:292

  message GetAclStatsRequest

  api_instance.proto:287

  • optional InstanceIdentifier instance = 1

  message GetAclStatsResponse

  api_instance.proto:289

  • optional acl.AclStats acl_stats = 1

• rpc GetWhitelist (GetWhitelistRequest, GetWhitelistResponse)

  api_instance.proto:293

  message GetWhitelistRequest

  api_instance.proto:296

  • optional InstanceIdentifier instance = 1

  message GetWhitelistResponse

  api_instance.proto:298

  • repeated string tcp_ports = 1

  • repeated string udp_ports = 2

• rpc ListConnector (ListConnectorRequest, ListConnectorResponse)

  api_instance.proto:218

  message ListConnectorRequest

  api_instance.proto:213

  • optional InstanceIdentifier instance = 1

  message ListConnectorResponse

  api_instance.proto:215

  • repeated Connector connectors = 1

• rpc GenerateCredential (GenerateCredentialRequest, GenerateCredentialResponse)

  api_instance.proto:377

  message GenerateCredentialRequest

  api_instance.proto:335

  • repeated string groups = 1

    optional: ACL groups for this credential

  • bool allow_relay = 2

    optional: allow relay through credential node

  • repeated string allowed_proxy_cidrs = 3

    optional: restrict proxy_cidrs

  • int64 ttl_seconds = 4

    must be > 0: credential TTL in seconds (0 / omitted is invalid)

  • optional string credential_id = 5

    optional: user-specified credential id, reused if already exists

  • optional InstanceIdentifier instance = 6

    target network instance

  • optional bool reusable = 7

    default true: allow multiple peers to reuse this credential

  message GenerateCredentialResponse

  api_instance.proto:345

  • string credential_id = 1

    UUID

  • string credential_secret = 2

    private key base64

• rpc ListCredentials (ListCredentialsRequest, ListCredentialsResponse)

  api_instance.proto:379

  message ListCredentialsRequest

  api_instance.proto:359

  • optional InstanceIdentifier instance = 1

    target network instance

  message ListCredentialsResponse

  api_instance.proto:372

  • repeated CredentialInfo credentials = 1

• rpc RevokeCredential (RevokeCredentialRequest, RevokeCredentialResponse)

  api_instance.proto:378

  message RevokeCredentialRequest

  api_instance.proto:350

  • string credential_id = 1

  • optional InstanceIdentifier instance = 2

    target network instance

  message RevokeCredentialResponse

  api_instance.proto:355

  • bool success = 1

• rpc ListMappedListener (ListMappedListenerRequest, ListMappedListenerResponse)

  api_instance.proto:230

  message ListMappedListenerRequest

  api_instance.proto:223

  • optional InstanceIdentifier instance = 1

  message ListMappedListenerResponse

  api_instance.proto:225

  • repeated MappedListener mappedlisteners = 1

• rpc DumpRoute (DumpRouteRequest, DumpRouteResponse)

  api_instance.proto:192

  message DumpRouteRequest

  api_instance.proto:132

  • optional InstanceIdentifier instance = 1

  message DumpRouteResponse

  api_instance.proto:134

  • string result = 1

• rpc GetForeignNetworkSummary (GetForeignNetworkSummaryRequest, GetForeignNetworkSummaryResponse)

  api_instance.proto:198

  message GetForeignNetworkSummaryRequest

  api_instance.proto:181

  • optional InstanceIdentifier instance = 1

  message GetForeignNetworkSummaryResponse

  api_instance.proto:183

  • optional peer_rpc.RouteForeignNetworkSummary summary = 1

• rpc ListForeignNetwork (ListForeignNetworkRequest, ListForeignNetworkResponse)

  api_instance.proto:193

  message ListForeignNetworkRequest

  api_instance.proto:136

  • optional InstanceIdentifier instance = 1

  • bool include_trusted_keys = 2

  message ListForeignNetworkResponse

  api_instance.proto:160

  • map<string, ForeignNetworkEntryPb> foreign_networks = 1

    foreign network in local

• rpc ListGlobalForeignNetwork (ListGlobalForeignNetworkRequest, ListGlobalForeignNetworkResponse)

  api_instance.proto:195

  message ListGlobalForeignNetworkRequest

  api_instance.proto:165

  • optional InstanceIdentifier instance = 1

  message ListGlobalForeignNetworkResponse

  api_instance.proto:167

  • map<uint32, ListGlobalForeignNetworkResponse.ForeignNetworks> foreign_networks = 1

• rpc ListPeer (ListPeerRequest, ListPeerResponse)

  api_instance.proto:188

  message ListPeerRequest

  api_instance.proto:57

  • optional InstanceIdentifier instance = 1

  message ListPeerResponse

  api_instance.proto:59

  • repeated PeerInfo peer_infos = 1

  • optional NodeInfo my_info = 2

• rpc ListPublicIpv6Info (ListPublicIpv6InfoRequest, ListPublicIpv6InfoResponse)

  api_instance.proto:189

  message ListPublicIpv6InfoRequest

  api_instance.proto:121

  • optional InstanceIdentifier instance = 1

  message ListPublicIpv6InfoResponse

  api_instance.proto:123

  • optional common.Ipv6Inet provider_prefix = 1

  • repeated PublicIpv6LeaseInfo provider_leases = 2

• rpc ListRoute (ListRouteRequest, ListRouteResponse)

  api_instance.proto:191

  message ListRouteRequest

  api_instance.proto:128

  • optional InstanceIdentifier instance = 1

  message ListRouteResponse

  api_instance.proto:130

  • repeated Route routes = 1

• rpc ShowNodeInfo (ShowNodeInfoRequest, ShowNodeInfoResponse)

  api_instance.proto:197

  message ShowNodeInfoRequest

  api_instance.proto:109

  • optional InstanceIdentifier instance = 1

  message ShowNodeInfoResponse

  api_instance.proto:111

  • optional NodeInfo node_info = 1

• rpc ListPortForward (ListPortForwardRequest, ListPortForwardResponse)

  api_instance.proto:310

  message ListPortForwardRequest

  api_instance.proto:303

  • optional InstanceIdentifier instance = 1

  message ListPortForwardResponse

  api_instance.proto:305

  • repeated common.PortForwardConfigPb cfgs = 1

• rpc GetPrometheusStats (GetPrometheusStatsRequest, GetPrometheusStatsResponse)

  api_instance.proto:329

  message GetPrometheusStatsRequest

  api_instance.proto:323

  • optional InstanceIdentifier instance = 1

  message GetPrometheusStatsResponse

  api_instance.proto:325

  • string prometheus_text = 1

• rpc GetStats (GetStatsRequest, GetStatsResponse)

  api_instance.proto:328

  message GetStatsRequest

  api_instance.proto:319

  • optional InstanceIdentifier instance = 1

  message GetStatsResponse

  api_instance.proto:321

  • repeated MetricSnapshot metrics = 1

• rpc ListTcpProxyEntry (ListTcpProxyEntryRequest, ListTcpProxyEntryResponse)

  api_instance.proto:283

  message ListTcpProxyEntryRequest

  api_instance.proto:278

  • optional InstanceIdentifier instance = 1

  message ListTcpProxyEntryResponse

  api_instance.proto:280

  • repeated TcpProxyEntry entries = 1

• rpc GetVpnPortalInfo (GetVpnPortalInfoRequest, GetVpnPortalInfoResponse)

  api_instance.proto:244

  message GetVpnPortalInfoRequest

  api_instance.proto:240

  • optional InstanceIdentifier instance = 1

  message GetVpnPortalInfoResponse

  api_instance.proto:241

  • optional VpnPortalInfo vpn_portal_info = 1

Used in: ListConnectorResponse

• optional common.Url url = 1

• ConnectorStatus status = 2

Used in: Connector

• CONNECTED = 0

• DISCONNECTED = 1

• CONNECTING = 2

Used in: ListCredentialsResponse

• string credential_id = 1

  UUID

• repeated string groups = 2

• bool allow_relay = 3

• int64 expiry_unix = 4

• repeated string allowed_proxy_cidrs = 5

• optional bool reusable = 6

Used in: ListForeignNetworkResponse

• repeated PeerInfo peers = 1

• bytes network_secret_digest = 2

• uint32 my_peer_id_for_this_network = 3

• repeated TrustedKeyInfoPb trusted_keys = 4

Used in: config.GetConfigRequest, config.PatchConfigRequest, DumpRouteRequest, GenerateCredentialRequest, GetAclStatsRequest, GetForeignNetworkSummaryRequest, GetPrometheusStatsRequest, GetStatsRequest, GetVpnPortalInfoRequest, GetWhitelistRequest, ListConnectorRequest, ListCredentialsRequest, ListForeignNetworkRequest, ListGlobalForeignNetworkRequest, ListMappedListenerRequest, ListPeerRequest, ListPortForwardRequest, ListPublicIpv6InfoRequest, ListRouteRequest, ListTcpProxyEntryRequest, RevokeCredentialRequest, ShowNodeInfoRequest

• oneof selector

  • common.UUID id = 1

  • InstanceIdentifier.InstanceSelector instance_selector = 2

Used in: InstanceIdentifier

• optional string name = 1

Used in: ListGlobalForeignNetworkResponse

• repeated OneForeignNetwork foreign_networks = 1

foreign network in the entire network

Used in: ForeignNetworks

• string network_name = 1

• repeated uint32 peer_ids = 2

• string last_updated = 3

• uint32 version = 4

Used in: ListMappedListenerResponse

• optional common.Url url = 1

Used in: GetStatsResponse

• string name = 1

• uint64 value = 2

• map<string, string> labels = 3

Used in: ListPeerResponse, ShowNodeInfoResponse

• uint32 peer_id = 1

• string ipv4_addr = 2

• repeated string proxy_cidrs = 3

• string hostname = 4

• optional common.StunInfo stun_info = 5

• string inst_id = 6

• repeated string listeners = 7

• string config = 8

• string version = 9

• optional common.PeerFeatureFlag feature_flag = 10

• optional peer_rpc.GetIpListResponse ip_list = 11

• optional common.Ipv6Inet public_ipv6_addr = 12

• optional common.Ipv6Inet ipv6_public_addr_prefix = 13

Used in: PeerInfo

• string conn_id = 1

• uint32 my_peer_id = 2

• uint32 peer_id = 3

• repeated string features = 4

• optional common.TunnelInfo tunnel = 5

• optional PeerConnStats stats = 6

• float loss_rate = 7

• bool is_client = 8

• string network_name = 9

• bool is_closed = 10

• bytes noise_local_static_pubkey = 11

• bytes noise_remote_static_pubkey = 12

• peer_rpc.SecureAuthLevel secure_auth_level = 13

• peer_rpc.PeerIdentityType peer_identity_type = 14

Used in: PeerConnInfo

• uint64 rx_bytes = 1

• uint64 tx_bytes = 2

• uint64 rx_packets = 3

• uint64 tx_packets = 4

• uint64 latency_us = 5

Used in: ForeignNetworkEntryPb, ListPeerResponse, PeerRoutePair, manage.NetworkInstanceRunningInfo

• uint32 peer_id = 1

• repeated PeerConnInfo conns = 2

• optional common.UUID default_conn_id = 3

• repeated common.UUID directly_connected_conns = 4

Used in: manage.NetworkInstanceRunningInfo

• optional Route route = 1

• optional PeerInfo peer = 2

Used in: ListPublicIpv6InfoResponse

• uint32 peer_id = 1

• string inst_id = 2

• optional common.Ipv6Inet leased_addr = 3

• int64 valid_until_unix_seconds = 4

• bool reused = 5

Used in: ListRouteResponse, PeerRoutePair, manage.NetworkInstanceRunningInfo, magic_dns.UpdateDnsRecordRequest

• uint32 peer_id = 1

• optional common.Ipv4Inet ipv4_addr = 2

• uint32 next_hop_peer_id = 3

• int32 cost = 4

• int32 path_latency = 11

• repeated string proxy_cidrs = 5

• string hostname = 6

• optional common.StunInfo stun_info = 7

• string inst_id = 8

• string version = 9

• optional common.PeerFeatureFlag feature_flag = 10

• optional uint32 next_hop_peer_id_latency_first = 12

• optional int32 cost_latency_first = 13

• optional int32 path_latency_latency_first = 14

• optional common.Ipv6Inet ipv6_addr = 15

• optional common.Ipv6Inet public_ipv6_addr = 16

• optional common.Ipv6Inet ipv6_public_addr_prefix = 17

• int32 code = 1

• string message = 2

Used in: ListTcpProxyEntryResponse

• optional common.SocketAddr src = 1

• optional common.SocketAddr dst = 2

• uint64 start_time = 3

• TcpProxyEntryState state = 4

• TcpProxyEntryTransportType transport_type = 5

Used in: TcpProxyEntry

• Unknown = 0

• SynReceived = 1

  receive syn packet but not start connecting to dst

• ConnectingDst = 2

  connecting to dst

• Connected = 3

  connected to dst

• Closed = 4

  connection closed

• ClosingSrc = 5

  closing src

• ClosingDst = 6

  closing dst

Used in: TcpProxyEntry

• TCP = 0

• KCP = 1

• QUIC = 2

Used in: ForeignNetworkEntryPb

• bytes pubkey = 1

• TrustedKeySourcePb source = 2

• optional int64 expiry_unix = 3

Used in: TrustedKeyInfoPb

• TRUSTED_KEY_SOURCE_PB_UNSPECIFIED = 0

• TRUSTED_KEY_SOURCE_PB_OSPF_NODE = 1

• TRUSTED_KEY_SOURCE_PB_OSPF_CREDENTIAL = 2

Used in: GetVpnPortalInfoResponse

• string vpn_type = 1

• string client_config = 2

• repeated string connected_clients = 3