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

Defined Networking (BYOK) — connector documentation

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

What Defined Networking (BYOK) is for

Defined Networking (BYOK) lets an AI assistant read your own Defined Networking data through the Defined Networking API with a key you supply (Defined Networking API key (give it list and read scopes only)). Read-only: 8 tools (get_current_api_key, list_hosts, get_host, list_roles, list_tags, list_networks, list_routes, list_audit_logs). 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.defined.net. Unofficial connector by Unify Dynamics LLC: not affiliated with, endorsed by or sponsored by Defined Networking. Defined Networking 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 Defined Networking organization is this API key for?"
  • "Which of my Nebula hosts are blocked or have not been seen recently?"
  • "Show details of Nebula host host-abc123"
  • "What Nebula roles exist and how many hosts use each?"
  • "Which Nebula host tags are in use?"
  • "What CIDR ranges do my Defined Networking networks use?"

What it does

  • get_current_api_key: Show which organization and API key the key belongs to: key name, organization name and plan. Works with any scope.
  • list_hosts: List the hosts of the overlay network with name, Nebula IP addresses, role, tags, lighthouse and relay flags, blocked state and last seen time. Needs the hosts:list scope.
  • get_host: Get one host by id: name, IP addresses, role, tags, flags, version, platform and last seen time. Needs the hosts:read scope.
  • list_roles: List the roles (firewall rule sets) with name, number of firewall rules and number of hosts. Needs the roles:list scope.
  • list_tags: List the host tags with name, priority, number of hosts, number of firewall rules and route subscriptions. Needs the tags:list scope.
  • list_networks: List the Nebula networks with name, CIDR ranges, certificate version, curve and host count. Needs the networks:list scope.
  • list_routes: List the unsafe routes (subnets reachable through a router host) with name, router host id and CIDRs. Needs the routes:list scope.
  • list_audit_logs: List audit log entries (who changed what and when) newest or oldest first, optionally for one target type or id. Needs the audit-logs:list scope.

BYOK key

You bring your own Defined Networking Defined Networking API key (give it list and read scopes only) (https://admin.defined.net/settings/api-keys). 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.defined.net 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 Defined Networking API (api.defined.net) with a BYOK key; documentation: https://docs.defined.net/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 Defined Networking. Defined Networking 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 Defined Networking account.

Built for: Worldwide. Languages: English.