88 lines
2.4 KiB
Markdown
88 lines
2.4 KiB
Markdown
---
|
|
name: netbird
|
|
description: Manage NetBird private mesh networks via the REST API. Use when Steve wants to interact with his self-hosted NetBird instance at https://net.dcglab.co.uk for tasks like listing peers, managing groups, creating setup keys, configuring policies, managing routes, or checking network status. Triggers on phrases like "netbird", "check my netbird", "list peers", "create setup key", "manage netbird groups", "netbird policy", "netbird routes".
|
|
author: Steve Cliff
|
|
email: me@stevecliff.com
|
|
last_updated: 2026-04-01 14:46:50
|
|
---
|
|
|
|
# NetBird Skill
|
|
|
|
Manage your self-hosted NetBird mesh network via the REST API.
|
|
|
|
## Configuration
|
|
|
|
The skill expects a `NETBIRD_API_TOKEN` environment variable containing your Personal Access Token (PAT). Create one in your NetBird dashboard under User settings.
|
|
|
|
Base URL: `https://net.dcglab.co.uk/api`
|
|
|
|
## Quick Start
|
|
|
|
Use the provided Python script for common operations:
|
|
|
|
```bash
|
|
# List all peers
|
|
python3 scripts/netbird_cli.py peers list
|
|
|
|
# List all groups
|
|
python3 scripts/netbird_cli.py groups list
|
|
|
|
# Create a setup key
|
|
python3 scripts/netbird_cli.py setup-keys create --name "server-key" --type reusable --expires 86400
|
|
|
|
# List policies
|
|
python3 scripts/netbird_cli.py policies list
|
|
```
|
|
|
|
## Available Resources
|
|
|
|
- **API Reference**: See [references/api-reference.md](references/api-reference.md) for detailed endpoint documentation
|
|
|
|
## Common Operations
|
|
|
|
### Peers
|
|
- List, get details, update, delete peers
|
|
- Check connection status, IP addresses, groups
|
|
|
|
### Groups
|
|
- Create, list, update, delete groups
|
|
- Manage peer memberships
|
|
|
|
### Setup Keys
|
|
- Create reusable or one-off keys
|
|
- Set expiration and auto-assign groups
|
|
- Revoke keys
|
|
|
|
### Policies
|
|
- Create network access policies
|
|
- Define rules with sources, destinations, ports, protocols
|
|
- Enable/disable policies
|
|
|
|
### Routes
|
|
- Create network routes
|
|
- Assign to peer groups
|
|
|
|
### DNS
|
|
- Manage nameserver groups
|
|
- Configure DNS settings
|
|
|
|
### Users
|
|
- List users and service users
|
|
- Manage user roles and groups
|
|
|
|
## Authentication
|
|
|
|
All API requests require a Bearer token header:
|
|
```
|
|
Authorization: Bearer <token>
|
|
```
|
|
|
|
For self-hosted instances, create a Personal Access Token (PAT) in the NetBird dashboard under User settings → Personal Access Tokens.
|
|
|
|
## API Patterns
|
|
|
|
- All endpoints return JSON
|
|
- IDs are string-based (e.g., `chacbco6lnnbn6cg5s90`)
|
|
- Dates are ISO 8601 format
|
|
- Boolean fields use JSON true/false
|