package daemon

Get desktop application:
View/edit binary Protocol Buffers messages

• rpc Login (LoginRequest, LoginResponse)

  daemon.proto:15

  Login uses setup key to prepare configuration for the daemon.

  message LoginRequest

  daemon.proto:73

  • string setupKey = 1

    setupKey netbird setup key.

  • string preSharedKey = 2

    This is the old PreSharedKey field which will be deprecated in favor of optionalPreSharedKey field that is defined as optional to allow clearing of preshared key while being able to persist in the config file.

  • string managementUrl = 3

    managementUrl to authenticate.

  • string adminURL = 4

    adminUrl to manage keys.

  • repeated string natExternalIPs = 5

    natExternalIPs map list of external IPs

  • bool cleanNATExternalIPs = 6

    cleanNATExternalIPs clean map list of external IPs. This is needed because the generated code omits initialized empty slices due to omitempty tags

  • bytes customDNSAddress = 7

  • bool isLinuxDesktopClient = 8

  • string hostname = 9

  • optional bool rosenpassEnabled = 10

  • optional string interfaceName = 11

  • optional int64 wireguardPort = 12

  • optional string optionalPreSharedKey = 13

  • optional bool disableAutoConnect = 14

  • optional bool serverSSHAllowed = 15

  • optional bool rosenpassPermissive = 16

  • repeated string extraIFaceBlacklist = 17

  • optional bool networkMonitor = 18

  • optional google.protobuf.Duration dnsRouteInterval = 19

  • optional bool disable_client_routes = 20

  • optional bool disable_server_routes = 21

  • optional bool disable_dns = 22

  • optional bool disable_firewall = 23

  • optional bool block_lan_access = 24

  • optional bool disable_notifications = 25

  • repeated string dns_labels = 26

  • bool cleanDNSLabels = 27

    cleanDNSLabels clean map list of DNS labels. This is needed because the generated code omits initialized empty slices due to omitempty tags

  message LoginResponse

  daemon.proto:139

  • bool needsSSOLogin = 1

  • string userCode = 2

  • string verificationURI = 3

  • string verificationURIComplete = 4

• rpc WaitSSOLogin (WaitSSOLoginRequest, WaitSSOLoginResponse)

  daemon.proto:19

  WaitSSOLogin uses the userCode to validate the TokenInfo and waits for the user to continue with the login on a browser

  message WaitSSOLoginRequest

  daemon.proto:146

  • string userCode = 1

  • string hostname = 2

  message WaitSSOLoginResponse

  daemon.proto:151

  (message has no fields)

• rpc Up (UpRequest, UpResponse)

  daemon.proto:22

  Up starts engine work in the daemon.

  message UpRequest

  daemon.proto:153

  (message has no fields)

  message UpResponse

  daemon.proto:155

  (message has no fields)

• rpc Status (StatusRequest, StatusResponse)

  daemon.proto:25

  Status of the service.

  message StatusRequest

  daemon.proto:157

  • bool getFullPeerStatus = 1

  message StatusResponse

  daemon.proto:161

  • string status = 1

    status of the server.

  • optional FullStatus fullStatus = 2

  • string daemonVersion = 3

    NetBird daemon version

• rpc Down (DownRequest, DownResponse)

  daemon.proto:28

  Down engine work in the daemon.

  message DownRequest

  daemon.proto:169

  (message has no fields)

  message DownResponse

  daemon.proto:171

  (message has no fields)

• rpc GetConfig (GetConfigRequest, GetConfigResponse)

  daemon.proto:31

  GetConfig of the daemon.

  message GetConfigRequest

  daemon.proto:173

  (message has no fields)

  message GetConfigResponse

  daemon.proto:175

  • string managementUrl = 1

    managementUrl settings value.

  • string configFile = 2

    configFile settings value.

  • string logFile = 3

    logFile settings value.

  • string preSharedKey = 4

    preSharedKey settings value.

  • string adminURL = 5

    adminURL settings value.

  • string interfaceName = 6

  • int64 wireguardPort = 7

  • bool disableAutoConnect = 9

  • bool serverSSHAllowed = 10

  • bool rosenpassEnabled = 11

  • bool rosenpassPermissive = 12

  • bool disable_notifications = 13

• rpc ListNetworks (ListNetworksRequest, ListNetworksResponse)

  daemon.proto:34

  List available networks

  message ListNetworksRequest

  daemon.proto:280

  Networks

  (message has no fields)

  message ListNetworksResponse

  daemon.proto:283

  • repeated Network routes = 1

• rpc SelectNetworks (SelectNetworksRequest, SelectNetworksResponse)

  daemon.proto:37

  Select specific routes

• rpc DeselectNetworks (SelectNetworksRequest, SelectNetworksResponse)

  daemon.proto:40

  Deselect specific routes

• rpc ForwardingRules (EmptyRequest, ForwardingRulesResponse)

  daemon.proto:42

  message EmptyRequest

  daemon.proto:11

  (message has no fields)

  message ForwardingRulesResponse

  daemon.proto:329

  • repeated ForwardingRule rules = 1

• rpc DebugBundle (DebugBundleRequest, DebugBundleResponse)

  daemon.proto:45

  DebugBundle creates a debug bundle

  message DebugBundleRequest

  daemon.proto:335

  DebugBundler

  • bool anonymize = 1

  • string status = 2

  • bool systemInfo = 3

  • string uploadURL = 4

  message DebugBundleResponse

  daemon.proto:342

  • string path = 1

  • string uploadedKey = 2

  • string uploadFailureReason = 3

• rpc GetLogLevel (GetLogLevelRequest, GetLogLevelResponse)

  daemon.proto:48

  GetLogLevel gets the log level of the daemon

  message GetLogLevelRequest

  daemon.proto:359

  (message has no fields)

  message GetLogLevelResponse

  daemon.proto:362

  • LogLevel level = 1

• rpc SetLogLevel (SetLogLevelRequest, SetLogLevelResponse)

  daemon.proto:51

  SetLogLevel sets the log level of the daemon

  message SetLogLevelRequest

  daemon.proto:366

  • LogLevel level = 1

  message SetLogLevelResponse

  daemon.proto:370

  (message has no fields)

• rpc ListStates (ListStatesRequest, ListStatesResponse)

  daemon.proto:54

  List all states

  message ListStatesRequest

  daemon.proto:379

  ListStatesRequest is empty as it requires no parameters

  (message has no fields)

  message ListStatesResponse

  daemon.proto:382

  ListStatesResponse contains a list of states

  • repeated State states = 1

• rpc CleanState (CleanStateRequest, CleanStateResponse)

  daemon.proto:57

  Clean specific state or all states

  message CleanStateRequest

  daemon.proto:387

  CleanStateRequest for cleaning states

  • string state_name = 1

  • bool all = 2

  message CleanStateResponse

  daemon.proto:393

  CleanStateResponse contains the result of the clean operation

  • int32 cleaned_states = 1

• rpc DeleteState (DeleteStateRequest, DeleteStateResponse)

  daemon.proto:60

  Delete specific state or all states

  message DeleteStateRequest

  daemon.proto:398

  DeleteStateRequest for deleting states

  • string state_name = 1

  • bool all = 2

  message DeleteStateResponse

  daemon.proto:404

  DeleteStateResponse contains the result of the delete operation

  • int32 deleted_states = 1

• rpc SetNetworkMapPersistence (SetNetworkMapPersistenceRequest, SetNetworkMapPersistenceResponse)

  daemon.proto:63

  SetNetworkMapPersistence enables or disables network map persistence

  message SetNetworkMapPersistenceRequest

  daemon.proto:409

  • bool enabled = 1

  message SetNetworkMapPersistenceResponse

  daemon.proto:413

  (message has no fields)

• rpc TracePacket (TracePacketRequest, TracePacketResponse)

  daemon.proto:65

  message TracePacketRequest

  daemon.proto:424

  • string source_ip = 1

  • string destination_ip = 2

  • string protocol = 3

  • uint32 source_port = 4

  • uint32 destination_port = 5

  • string direction = 6

  • optional TCPFlags tcp_flags = 7

  • optional uint32 icmp_type = 8

  • optional uint32 icmp_code = 9

  message TracePacketResponse

  daemon.proto:443

  • repeated TraceStage stages = 1

  • bool final_disposition = 2

• rpc SubscribeEvents (SubscribeRequest, stream SystemEvent)

  daemon.proto:67

  message SubscribeRequest

  daemon.proto:448

  (message has no fields)

• rpc GetEvents (GetEventsRequest, GetEventsResponse)

  daemon.proto:69

  message GetEventsRequest

  daemon.proto:475

  (message has no fields)

  message GetEventsResponse

  daemon.proto:477

  • repeated SystemEvent events = 1

Used in: ForwardingRulesResponse

• string protocol = 1

• optional PortInfo destinationPort = 2

• string translatedAddress = 3

• string translatedHostname = 4

• optional PortInfo translatedPort = 5

FullStatus contains the full state held by the Status instance

Used in: StatusResponse

• optional ManagementState managementState = 1

• optional SignalState signalState = 2

• optional LocalPeerState localPeerState = 3

• repeated PeerState peers = 4

• repeated RelayState relays = 5

• repeated NSGroupState dns_servers = 6

• int32 NumberOfForwardingRules = 8

• repeated SystemEvent events = 7

Used in: Network

• repeated string ips = 1

LocalPeerState contains the latest state of the local peer

Used in: FullStatus

• string IP = 1

• string pubKey = 2

• bool kernelInterface = 3

• string fqdn = 4

• bool rosenpassEnabled = 5

• bool rosenpassPermissive = 6

• repeated string networks = 7

Used in: GetLogLevelResponse, SetLogLevelRequest

• UNKNOWN = 0

• PANIC = 1

• FATAL = 2

• ERROR = 3

• WARN = 4

• INFO = 5

• DEBUG = 6

• TRACE = 7

ManagementState contains the latest state of a management connection

Used in: FullStatus

• string URL = 1

• bool connected = 2

• string error = 3

Used in: FullStatus

• repeated string servers = 1

• repeated string domains = 2

• bool enabled = 3

• string error = 4

Used in: ListNetworksResponse

• string ID = 1

• string range = 2

• bool selected = 3

• repeated string domains = 4

• map<string, IPList> resolvedIPs = 5

PeerState contains the latest state of a peer

Used in: FullStatus

• string IP = 1

• string pubKey = 2

• string connStatus = 3

• optional google.protobuf.Timestamp connStatusUpdate = 4

• bool relayed = 5

• string localIceCandidateType = 7

• string remoteIceCandidateType = 8

• string fqdn = 9

• string localIceCandidateEndpoint = 10

• string remoteIceCandidateEndpoint = 11

• optional google.protobuf.Timestamp lastWireguardHandshake = 12

• int64 bytesRx = 13

• int64 bytesTx = 14

• bool rosenpassEnabled = 15

• repeated string networks = 16

• optional google.protobuf.Duration latency = 17

• string relayAddress = 18

ForwardingRules

Used in: ForwardingRule

• oneof portSelection

  • uint32 port = 1

  • PortInfo.Range range = 2

Used in: PortInfo

• uint32 start = 1

• uint32 end = 2

RelayState contains the latest state of the relay

Used in: FullStatus

• string URI = 1

• bool available = 2

• string error = 3

Used as request type in: DaemonService.DeselectNetworks, DaemonService.SelectNetworks

• repeated string networkIDs = 1

• bool append = 2

• bool all = 3

Used as response type in: DaemonService.DeselectNetworks, DaemonService.SelectNetworks

(message has no fields)

SignalState contains the latest state of a signal connection

Used in: FullStatus

• string URL = 1

• bool connected = 2

• string error = 3

State represents a daemon state entry

Used in: ListStatesResponse

• string name = 1

Used as response type in: DaemonService.SubscribeEvents

Used as field type in: FullStatus, GetEventsResponse

• string id = 1

• SystemEvent.Severity severity = 2

• SystemEvent.Category category = 3

• string message = 4

• string userMessage = 5

• optional google.protobuf.Timestamp timestamp = 6

• map<string, string> metadata = 7

Used in: SystemEvent

• NETWORK = 0

• DNS = 1

• AUTHENTICATION = 2

• CONNECTIVITY = 3

• SYSTEM = 4

Used in: SystemEvent

• INFO = 0

• WARNING = 1

• ERROR = 2

• CRITICAL = 3

Used in: TracePacketRequest

• bool syn = 1

• bool ack = 2

• bool fin = 3

• bool rst = 4

• bool psh = 5

• bool urg = 6

Used in: TracePacketResponse

• string name = 1

• string message = 2

• bool allowed = 3

• optional string forwarding_details = 4