Protocol Documentation

Proto is the protocol of the traffic.

Src is the address of the client that initiated the request.

Dst is the destination address of the traffic.

Port is the destination port of the traffic.

Offer is the offer for the node to use as its local description.

Answer is the answer for the node to use as its remote description.

Candidate is an ICE candidate.

StunServers is the list of STUN servers to use.

Feature is the feature advertised on the port.

Port is the port the feature is advertised on.

ID is the ID of the node. If unset, the status of the local node is returned.

DeviceName is the name of the device.

PublicKey is the public key of the node.

AddressV4 is the IPv4 address of the node.

AddressV6 is the IPv6 address of the node.

Type is the type of interface being used for wireguard.

ListenPort is the port wireguard is listening on.

TotalReceiveBytes is the total number of bytes received.

TotalTransmitBytes is the total number of bytes transmitted.

NumPeers is the number of peers connected to the node.

Peers are the per-peer statistics.

ID is the ID of the node.

PublicKey is the public key of the node.

PrimaryEndpoint is the primary endpoint of the node.

WireguardEndpoints is a list of WireGuard endpoints for the node.

ZoneAwarenessID is the zone awareness ID of the node.

PrivateIPv4 is the private IPv4 address of the node.

PrivateIPv6 is the private IPv6 address of the node.

Features are a list of features and the ports they are advertised on.

Multiaddrs are the multiaddrs of the node.

JoinedAt is the time the node joined the cluster.

Nodes is the list of nodes.

PublicKey is the public key of the peer.

Endpoint is the connected endpoint of the peer.

PersistentKeepAlive is the persistent keep alive interval for the peer.

LastHandshakeTime is the last handshake time for the peer.

AllowedIPs is the list of allowed IPs for the peer.

ProtocolVersion is the version of the wireguard protocol negotiated with the peer.

ReceiveBytes is the bytes received from the peer.

TransmitBytes is the bytes transmitted to the peer.

ID is the ID of the node.

Description is an optional description provided by the node.

Version is the version of the node.

GitCommit is the git commit of the node.

BuildDate is the build date of the node.

Uptime is the uptime of the node.

StartedAt is the time the node started.

Features is the list of features currently enabled.

ClusterStatus is the status of the node in the cluster.

CurrentLeader is the current leader of the cluster.

InterfaceMetrics are the metrics for the node's interfaces.

NodeID is the ID of the node to send the signal to. This is set by the original sender. On the node that receives the ReceiveSignalChannel request, this will be set to the ID of the node that sent the request.

Candidate is an ICE candidate.

Description is a session description.

ID is the ID of the node.

Source is the source node.

Target is the target node.

Weight is the weight of the edge.

Attributes is a list of attributes for the edge.

Items is the list of edges.

Nodes is the list of nodes.

Edges is the list of edges.

DOT is the DOT representation of the graph.

Name is the name of the ACL.

Priority is the priority of the ACL. ACLs with higher priority are evaluated first.

Action is the action to take when a request matches the ACL.

SourceNodes is a list of source nodes to match against. If empty, all nodes are matched. Groups can be specified with the prefix "group:". If one or more of the nodes is '*', all nodes are matched.

DestinationNodes is a list of destination nodes to match against. If empty, all nodes are matched. Groups can be specified with the prefix "group:". If one or more of the nodes is '*', all nodes are matched.

SourceCIDRs is a list of source CIDRs to match against. If empty, all CIDRs are matched. If one or more of the CIDRs is '*', all CIDRs are matched.

DestinationCIDRs is a list of destination CIDRs to match against. If empty, all CIDRs are matched. If one or more of the CIDRs is '*', all CIDRs are matched.

Items is the list of network ACLs.

SrcNode is the source node of the action.

SrcCIDR is the source CIDR of the action.

DstNode is the destination node of the action.

DstCIDR is the destination CIDR of the action.

Name is the name of the route.

Node is the node that broadcasts the route. A group can be specified with the prefix "group:".

DestinationCIDRs are the destination CIDRs of the route.

NextHopNode is an optional node that is used as the next hop for the route. This field is not currentl used.

Items is the list of routes.

Name is the name of the group.

Subjects is the list of subjects in the group.

Items is the list of groups.

Resource is the resource on which the action is performed.

ResourceName is the name of the resource on which the action is performed.

Verb is the verb that is performed on the resource.

Name is the name of the role.

Rules is the list of rules that apply to the role.

Name is the name of the role binding.

Role is the name of the role to which the binding applies.

Subjects is the list of subjects to which the binding applies.

Items is the list of role bindings.

Items is the list of roles.

Resources is the resources to which the rule applies.

ResourceNames is the list of resource names to which the rule applies.

Verbs is the list of verbs that apply to the resource.

Name is the name of the subject.

Type is the type of the subject.

Key is the key of the event.

Value is the value of the event. This will be the raw value of the key.

TTL is the time for the event to live in the database.

Command is the command of the query.

Type is the type of resource for the query.

Query is the string of the query. This follows the format of a comma-separted label selector and is only applicable for certain queries. For get queries this will usually be an ID. For list queries this will usually be one or more filters. On put or delete queries, this should be an ID.

Item is an item to put. This is only applicable for PUT queries. It should be a protobuf-JSON encoded object of the given query type.

Items contain the results of the query. These will be protobuf json-encoded objects of the given query type.

Error is an error that happened during the query. This will always be populated on errors, but single-flight queries will return a coded error instead.

Prefix is the prefix of the events to subscribe to.

Key is the key of the event.

Value is the value of the event. This will be the raw value of the key.

ID is the unique identifier of this connection.

Query is the query to execute.

ID is the unique identifier of the connection.

ID is the unique identifier of this connection.

Node id is the unique identifier of the node.

Mesh domain is the domain of the mesh.

IPv4Address is the IPv4 address of the node.

IPv6Address is the IPv6 address of the node.

IPv4Network is the IPv4 network of the mesh.

IPv6Network is the IPv6 network of the mesh.

AuthMethod is the type of authentication to use.

AuthCredentials are additional credentials as required by the authType.

AddrType is the type of join addresses in the addrs list.

Addrs are the join addresses to use to connect to the mesh.

Networking is the networking configuration to use.

Services are the services to expose to other nodes on the mesh.

Bootstrap are options for bootstrapping a new mesh.

TLS are TLS configurations for the mesh connection.

NodeID is the unique identifier of the daemon. This is used for mesh connections from the daemon.

PublicKey is the public key of the daemon.

Description is a description of the daemon.

Version is the version of the daemon.

GitCommit is the git commit of the daemon.

BuildDate is the build date of the daemon.

Uptime is the uptime of the daemon.

StartedAt is the time the daemon started.

Connections are a map of known connections to the daemon and their statuses.

ID is the unique identifier of the connection.

ID is the unique identifier of this connection.

ID is the unique identifier of the connection.

Status is the status of the connection.

Parameters are the parameters for the connection.

Metadata are arbitrary key/value pairs stored with the connection.

Node is the node information for the connection. This is only populated when the connection is connected.

IPv4Network is the IPv4 network of the mesh. This is only populated when the connection is connected.

IPv6Network is the IPv6 network of the mesh. This is only populated when the connection is connected.

Domain is the domain of the mesh. This is only populated when the connection is connected.

IDs are the unique identifiers of the connections to retrieve information for. If not provided, metrics for all known connections will be returned.

Connections are the parameters and statuses of all connections.

Enabled indicates whether or not to bootstrap a new mesh.

Domain is the domain of the mesh. Defaults to "webmesh.internal".

IPv4Network is the IPv4 network of the mesh. Defaults to 172.16.0.0/12.

RBACEnabled indicates whether or not to enable RBAC on the mesh.

DefaultNetworkACL is the default network ACL to use for the mesh.

UseDNS indicates whether or not to use the DNS servers of the mesh.

Endpoints are wireguard endpoints to broadcast to the mesh.

DetectEndpoints enables endpoint detection.

DetectPrivateEndpoints enables endpoint detection for private addresses. This only makes sense when DetectEndpoints is enabled.

Enabled indicates whether or not to expose services to other nodes.

EnableLibP2P indicates whether or not to serve the API over libp2p.

EnableTLS indicates whether or not to use TLS for the API.

Rendezvous is an optional rendezvous string to use for anouncing the service on the IPFS DHT.

ListenAddress is a raw IP address and port to listen on.

ListenMultiaddrs are multiaddrs to listen on. If not provided and EnableLibP2P is set, the default listen addresses will be used.

AuthMetod is the of authentication to enable for the services. Only mTLS and ID are supported.

Features are which features to enable on the API.

DNS are configurations for running a MeshDNS server.

Enabled indicates whether or not to use TLS.

CACert is a base64 and PEM encoded CA certificate to use for TLS.

CertData is a base64 and PEM encoded certificate to use for TLS.

KeyData is a base64 and PEM encoded private key to use for TLS.

VerifyChainOnly indicates whether or not to only verify the certificate chain.

SkipVerify indicates whether or not to skip verification of the server certificate.

Enabled indicates whether or not to run a MeshDNS server.

ListenUDP is a raw IP address and port to listen on for UDP. Defaults to :53. Set to an empty string to disable.

ListenTCP is a raw IP address and port to listen on for TCP. Defaults to :53. Set to an empty string to disable.

IDs are the unique identifiers of the connections to retrieve metrics for. If not provided, metrics for all known connections will be returned.

Interfaces is a map of network IDs to their interface metrics.

ID is the unique identifier of the connection. If not provided one will be generated.

Parameters are the parameters for the connection.

Metadata are arbitrary key/value pairs to store with the connection.

ID is the unique identifier of the connection.

Time is the total time it took to apply the log entry.

Error is an error that occurred during the apply.

Key is the key of the data item.

Value is the value of the data item.

TTL is the time to live of the data item.

Type is the type of the log entry.

Key is the key of the log entry.

Value is the value of the log entry.

TTL is the time to live of the log entry.

KV is the key/value pairs of the snapshot.

ID is the ID of the node.

PublicKey is the public key of the node to broadcast to peers.

PrimaryEndpoint is a routable address for the node. If left unset, the node is assumed to be behind a NAT and not directly accessible.

WireguardEndpoints is a list of WireGuard endpoints for the node.

ZoneAwarenessID is the zone awareness ID of the node.

AssignIPv4 is whether an IPv4 address should be assigned to the node.

PreferStorageIPv6 is whether IPv6 should be preferred over IPv4 for storage communication. This is only used if assign_ipv4 is true.

AsVoter is whether the node should receive a vote in elections. The request will be denied if the node is not allowed to vote.

AsObserver is whether the node should be added as an observer. They will receive updates to the storage, but not be able to vote in elections.

Routes is a list of routes to advertise to peers. The request will be denied if the node is not allowed to put routes.

DirectPeers is a map of extra peers that should be connected to directly over relays. The provided edge attribute is the callers preference of how the relay should be created. The request will be denied if the node is not allowed to put data channels or edges. The default joining behavior creates direct links between the caller and the joiner. If the caller has a primary endpoint, the joiner will link the caller to all other nodes with a primary endpoint. If the caller has a zone awareness ID, the joiner will link the caller to all other nodes with the same zone awareness ID that also have a primary endpoint.

Features is a list of features supported by the node that should be advertised to peers and the port they are available on.

Multiaddrs are libp2p multiaddresses this node is listening on.

AddressIPv4 is the private IPv4 wireguard address of the node in CIDR format representing the network. This is only set if assign_ipv4 was set in the request or no network_ipv6 was provided.

AddressIPv6 is the IPv6 network assigned to the node.

NetworkIPv4 is the IPv4 network of the Mesh.

NetworkIPv6 is the IPv6 network of the Mesh.

Peers is a list of wireguard peers to connect to.

ICEServers is a list of public nodes that can be used to negotiate ICE connections if required. This may only be populated when one of the peers has the ICE flag set. This must be set if the requestor specifies direct_peers.

DNSServers is a list of peers offering DNS services.

MeshDomain is the domain of the mesh.

ID is the ID of the node.

Peers is a list of wireguard peers to connect to.

ICEServers is a list of public nodes that can be used to negotiate ICE connections if required. This may only be populated when one of the peers has the ICE flag set.

DNSServers is a list of peers offering DNS services.

Servers is the list of servers in the storage configuration.

ID is the ID of the server.

Suffrage is the suffrage of the server.

PublicKey is the public key of this server. Not all storage providers track this field.

Address is the mesh address of the server.

ID is the ID of the node.

ID is the ID of the node.

PublicKey is the public key of the node to broadcast to peers.

PrimaryEndpoint is a routable address for the node. If left unset, the node is assumed to be behind a NAT and not directly accessible.

WireguardEndpoints is a list of WireGuard endpoints for the node.

ZoneAwarenessID is the zone awareness ID of the node.

AsVoter is whether the node should receive a vote in elections. The request will be denied if the node is not allowed to vote.

Routes is a list of routes to advertise to peers. The request will be denied if the node is not allowed to put routes.

Features is a list of features supported by the node that should be advertised to peers and the port they are available on.

Multiaddrs are libp2p multiaddresses this node is listening on.

Node is information about this node.

AllowedIPs is the list of allowed IPs for the peer.

AllowedRoutes is the list of allowed routes for the peer.

Proto indicates the protocol to use to connect to the peer.

NodeID is the node that the IP should be allocated for.

Subnet is the subnet that the IP should be allocated from.

IP is the allocated IP. It should be returned in CIDR notation.

Headers are the headers of the request.

Certificates are the DER encoded certificates of the request.

ID is the id of the authenticated user.

Type is the type of the watch event.

Node is the node that the event is about.

ID is the ID of the node.

NetworkIPv4 is the IPv4 network that the node is a part of.

NetworkIPv6 is the IPv6 network that the node is a part of.

AddressIPv4 is the IPv4 address of the node.

AddressIPv6 is the IPv6 address of the node.

Domain is the domain of the network.

PrivateKey is the private key of the node.

Config is the configuration for the plugin. This will be specific for each plugin.

NodeConfig is the configuration of the node and the network that it is a part of.

Name is the name of the plugin.

Version is the version of the plugin.

Description is the description of the plugin.

Capabilities is the capabilities of the plugin.

NodeID is the node that the IP should be released for.

IP is the IP that should be released.

The ID derived from the public key to lookup.

The public key to lookup.

The alias of the public key to lookup.

The ID of the public key that was looked up.

The encoded public key that was looked up.

Any alias associated with the public key.

The encoded public key to register.

An alias to associate with the public key. This can be used to lookup the public key later.

Expiry is the time at which the public key and its associated aliases should be removed from the registrar. If not provided, a default value of 1 day from the time of registration will be used.

ID of the public key that was registered.

Status is the status of the storage after the bootstrap.

Key is the key to delete.

Key is the key to get the value for.

Value is the value of the key.

Prefix is the prefix to list values for.

Keys is the list of value keys for the prefix.

Prefix is the prefix to list values for.

Values is the list of values for the prefix.

Prefix is the prefix that the event is for.

Value is the value that was added or removed.

EventType is the type of event.

Value is the value to put.

TTL is the time to live for the value.

ID is the id of the server.

PublicKey is the encoded public key of the server. This is not required for demotion or removal RPCs. Not all implementations need to support this.

Address is the address of the server. This is not required for demotion or removal RPCs.

ClusterStatus is the status of the server. This is only applicable during a GetStatus RPC.

Peers is the list of servers that are currently recognized as peers by the storage plugin.

IsWritable is true if the storage can currently be written to.

ClusterStatus is the status of the storage. The definitions applied to each status are implementation specific.

Peers is the list of servers that are currently recognized as peers by the storage plugin. This should include the current server.

Message is an implementation specific message that can be used to provide additional information about the storage status.

Key is the key of the value.

Value is the value of the key.

Prefix is the prefix to subscribe to.

Offer is the offer.

STUNServers is the list of STUN servers to use.

Candidate is an ICE candidate.

NodeID is the ID of the node to send the data to.

Proto is the protocol of the traffic.

Dst is the destination address of the traffic.

Port is the destination port of the traffic. A port of 0 coupled with the udp protocol indicates forwarding to the WireGuard interface.

Answer is the answer to the offer.

Candidate is an ICE candidate.