Be the first to get access to new connectors. Get early access →
ConnectorBay Early access

NetBird (BYOK) — connector documentation

  • MCP endpoint: https://byok-netbird.connectorbay.com/mcp
  • REST API: POST https://byok-netbird.connectorbay.com/v1/tools/{tool_name}, described by the OpenAPI 3.1 spec at https://byok-netbird.connectorbay.com/openapi.json
  • Transport: Streamable HTTP, stateless, MCP specification 2025-06-18 or later
  • Authentication: your own NetBird NetBird personal access token (nbp_...), sent in the X-Upstream-Key header of every request (never stored, logged or cached)
  • Health: https://byok-netbird.connectorbay.com/health · Tool schemas: https://byok-netbird.connectorbay.com/tools.json
  • Publisher: Unify Dynamics LLC · connectorbay.com/byok-netbird · agent@connectorbay.com

What NetBird (BYOK) is for

NetBird (BYOK) lets an AI assistant read your own NetBird data through the NetBird API with a key you supply (NetBird personal access token (nbp_...)). Read-only: 12 tools (get_current_user, list_peers, get_peer, list_users, list_groups, list_policies, list_routes, list_networks, list_network_resources, list_dns_nameserver_groups, list_posture_checks, list_audit_events). The BYOK key travels with each request, is used for that one call only and is never stored, logged or cached; it is only ever sent to api.netbird.io. Unofficial connector by Unify Dynamics LLC: not affiliated with, endorsed by or sponsored by NetBird. NetBird and its logos are trademarks of their owners and are used only to say which service the connector works with.

Ask your assistant things like:

  • "Which NetBird user is my token connected to?"
  • "Which of my NetBird peers are currently connected?"
  • "Show NetBird peer cmaosc5l2vqs73bkf4q0 in detail"
  • "Who are the NetBird users and which are blocked?"
  • "What NetBird groups exist and how many peers are in each?"
  • "Which NetBird access policies are enabled?"

What it does

  • get_current_user: Show the NetBird user the token belongs to: name, email, role, status and last login.
  • list_peers: List the machines (peers) in the NetBird network with name, IP, connection state, last seen time, OS, client version and groups. Optional filters by name, IP or MAC.
  • get_peer: Get one NetBird peer by id: connection state, IP, OS, version, groups, login expiry and approval flags.
  • list_users: List NetBird users with name, email, role, status (active, invited or blocked), last login and group membership. Service users can be included or selected.
  • list_groups: List NetBird groups with the number of peers and resources in each and the peers they contain.
  • list_policies: List NetBird access policies with enabled flag and their rules: action, protocol, ports, direction, source and destination groups.
  • list_routes: List NetBird network routes with network range or domains, routing peer or peer groups, metric, masquerade and enabled flag.
  • list_networks: List NetBird networks (resource networks) with routers, resources and policies attached to each.
  • list_network_resources: List the resources (hosts, subnets or domains) inside one NetBird network with address, type, groups and enabled flag.
  • list_dns_nameserver_groups: List NetBird DNS nameserver groups with nameserver IPs, domains, target peer groups, primary flag and enabled flag.
  • list_posture_checks: List NetBird posture checks (client version, OS version, location, network range, process and certificate checks).
  • list_audit_events: List NetBird audit events: what was done, when, by whom and to which target.

BYOK key

You bring your own NetBird NetBird personal access token (nbp_...) (https://app.netbird.io/users). Your assistant sends it in the X-Upstream-Key header with each request. ConnectorBay uses it for that one call only: it is never stored, logged or cached, never shown in an answer, and it is only sent to api.netbird.io over https, with no redirects followed. Create a key with the fewest permissions the tools need (read-only if the provider offers it), and revoke it at the provider whenever you like.

Data sources

Live from the NetBird API (api.netbird.io) with a BYOK key; documentation: https://docs.netbird.io/api. Endpoints checked against that documentation on 2026-10-16.

What it is not

Unofficial connector by Unify Dynamics LLC: not affiliated with, endorsed by or sponsored by NetBird. NetBird and its logos are trademarks of their owners and are used only to say which service the connector works with. It is read-only: it never creates, changes, sends or deletes anything in your NetBird account.

Built for: Worldwide. Languages: English.