api

Reference the NetBird Public API for network management and configuration.

Updated Mar 6, 2026
One-click install
npx skills add https://github.com/renne/skills --skill api-renne
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: api
Source: https://github.com/renne/skills/tree/main/netbird/api
Command: npx skills add https://github.com/renne/skills --skill api-renne

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill provides comprehensive reference documentation for the NetBird Public API, enabling users to automate network management tasks through programmatic interaction.

Core Features & Use Cases

  • API Reference: Detailed information on endpoints for authentication, users, peers, groups, networks, policies, routes, DNS, and events.
  • Automation: Facilitates scripting and automation for setting up and managing NetBird networks.
  • Use Case: Automate the creation of new users and assign them to specific groups upon onboarding by using the API to interact with the NetBird control plane.

Quick Start

Use the api skill to list all peers in your NetBird account.

Frequently Asked Questions about api

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I automate NetBird network management using the REST API?

You can automate NetBird network management by making RESTful API calls to programmatically control authentication, users, peers, groups, networks, policies, routes, DNS settings, and event logs.

Can I automate user onboarding and group assignment via the NetBird API?

Yes, you can automate user onboarding by using the NetBird API to interact with the control plane, programmatically creating new users and assigning them to specific groups.

What network resources can I configure through the NetBird Public API?

The NetBird Public API allows you to configure and manage authentication, users, peers, groups, networks, policies, routes, DNS settings, and event logs across your mesh network.

How do I list all peers in my NetBird account using the API?

You can list all peers in your NetBird account by sending a request to the peers endpoint provided by the NetBird Public API reference.

Does the NetBird API support setting up mesh networks programmatically?

Yes, the NetBird API supports the automation of mesh network setup and administration through detailed RESTful API calls for comprehensive network configuration.

What is the best way to retrieve event logs from a NetBird network?

The best way to retrieve event logs is by using the events endpoint in the NetBird Public API, which enables programmatic access to network event data.