NetBird
NetBird is an Open-Source Zero Trust Networking platform that allows you to create secure private networks for your organization or home. We designed NetBird to be simple and fast, requiring near-zero configuration effort and leaving behind the hassle of opening ports, complex firewall rules, VPN gateways, etc.
1 APIs
0 Features
NetworkingVPNZero TrustOpen SourceWireGuardSecurity
APIs
NetBird
NetBird is an Open-Source Zero Trust Networking platform that allows you to create secure private networks for your organization or home. We designed NetBird to be simple and fa...
Collections
NetBird REST API
OPENPricing Plans
Rate Limits
FinOps
Netbird Finops
FINOPSResources
🔗
LinkedIn
LinkedIn
🔗
Website
Website
🔗
Documentation
Documentation
🔗
API Documentation
API Documentation
👥
GitHub
GitHub
📰
Blog
Blog
🔗
LlmsText
LlmsText
Sources
opencollection: 1.0.0
info:
name: NetBird REST API
version: 0.0.1
request:
auth:
type: bearer
token: '{{bearerToken}}'
items:
- info:
name: Instance
type: folder
items:
- info:
name: Get Instance Status
type: http
http:
method: GET
url: https://api.netbird.io/api/instance
docs: Returns the instance status including whether initial setup is required. This endpoint does not require authentication.
- info:
name: Get Version Info
type: http
http:
method: GET
url: https://api.netbird.io/api/instance/version
auth:
type: bearer
token: '{{bearerToken}}'
docs: Returns version information for NetBird components including the current management server version and latest available
versions from GitHub.
- info:
name: Setup Instance
type: http
http:
method: POST
url: https://api.netbird.io/api/setup
body:
type: json
data: '{}'
docs: 'Creates the initial admin user for the instance. This endpoint does not require authentication but only works when
setup is required (no accounts exist and embedded IDP is enabled).
When the management server is started with `NB_SETUP_PAT_ENABLED=true` and the request includes `create_pat: true`,
the endpoint also provisions the NetBird account for the new owner user and returns the plain text Personal Access Token
in `personal_access_token`. The optional `pat_expire_in` value applies only when'
- info:
name: Jobs
type: folder
items:
- info:
name: List Jobs
type: http
http:
method: GET
url: https://api.netbird.io/api/peers/:peerId/jobs
params:
- name: peerId
value: ''
type: path
description: The unique identifier of a peer
auth:
type: bearer
token: '{{bearerToken}}'
docs: Retrieve all jobs for a given peer
- info:
name: Create Job
type: http
http:
method: POST
url: https://api.netbird.io/api/peers/:peerId/jobs
params:
- name: peerId
value: ''
type: path
description: The unique identifier of a peer
body:
type: json
data: '{}'
auth:
type: bearer
token: '{{bearerToken}}'
docs: Create a new job for a given peer
- info:
name: Get Job
type: http
http:
method: GET
url: https://api.netbird.io/api/peers/:peerId/jobs/:jobId
params:
- name: peerId
value: ''
type: path
description: The unique identifier of a peer
- name: jobId
value: ''
type: path
description: The unique identifier of a job
auth:
type: bearer
token: '{{bearerToken}}'
docs: Retrieve details of a specific job
- info:
name: Accounts
type: folder
items:
- info:
name: List all Accounts
type: http
http:
method: GET
url: https://api.netbird.io/api/accounts
auth:
type: bearer
token: '{{bearerToken}}'
docs: Returns a list of accounts of a user. Always returns a list of one account.
- info:
name: Update an Account
type: http
http:
method: PUT
url: https://api.netbird.io/api/accounts/:accountId
params:
- name: accountId
value: ''
type: path
description: The unique identifier of an account
body:
type: json
data: '{}'
auth:
type: bearer
token: '{{bearerToken}}'
docs: Update information about an account
- info:
name: Delete an Account
type: http
http:
method: DELETE
url: https://api.netbird.io/api/accounts/:accountId
params:
- name: accountId
value: ''
type: path
description: The unique identifier of an account
auth:
type: bearer
token: '{{bearerToken}}'
docs: Deletes an account and all its resources. Only account owners can delete accounts.
- info:
name: Users
type: folder
items:
- info:
name: List all Users
type: http
http:
method: GET
url: https://api.netbird.io/api/users
params:
- name: service_user
value: ''
type: query
description: Filters users and returns either regular users or service users
auth:
type: bearer
token: '{{bearerToken}}'
docs: Returns a list of all users
- info:
name: Create a User
type: http
http:
method: POST
url: https://api.netbird.io/api/users
body:
type: json
data: '{}'
auth:
type: bearer
token: '{{bearerToken}}'
docs: Creates a new service user or sends an invite to a regular user
- info:
name: Update a User
type: http
http:
method: PUT
url: https://api.netbird.io/api/users/:userId
params:
- name: userId
value: ''
type: path
description: The unique identifier of a user
body:
type: json
data: '{}'
auth:
type: bearer
token: '{{bearerToken}}'
docs: Update information about a User
- info:
name: Delete a User
type: http
http:
method: DELETE
url: https://api.netbird.io/api/users/:userId
params:
- name: userId
value: ''
type: path
description: The unique identifier of a user
auth:
type: bearer
token: '{{bearerToken}}'
docs: This method removes a user from accessing the system. For this leaves the IDP user intact unless the `--user-delete-from-idp`
is passed to management startup.
- info:
name: Resend user invitation
type: http
http:
method: POST
url: https://api.netbird.io/api/users/:userId/invite
params:
- name: userId
value: ''
type: path
description: The unique identifier of a user
auth:
type: bearer
token: '{{bearerToken}}'
docs: Resend user invitation
- info:
name: Approve user
type: http
http:
method: POST
url: https://api.netbird.io/api/users/:userId/approve
params:
- name: userId
value: ''
type: path
description: The unique identifier of a user
auth:
type: bearer
token: '{{bearerToken}}'
docs: Approve a user that is pending approval
- info:
name: Reject user
type: http
http:
method: DELETE
url: https://api.netbird.io/api/users/:userId/reject
params:
- name: userId
value: ''
type: path
description: The unique identifier of a user
auth:
type: bearer
token: '{{bearerToken}}'
docs: Reject a user that is pending approval by removing them from the account
- info:
name: Change user password
type: http
http:
method: PUT
url: https://api.netbird.io/api/users/:userId/password
params:
- name: userId
value: ''
type: path
description: The unique identifier of a user
body:
type: json
data: '{}'
auth:
type: bearer
token: '{{bearerToken}}'
docs: Change the password for a user. Only available when embedded IdP is enabled. Users can only change their own password.
- info:
name: Retrieve current user
type: http
http:
method: GET
url: https://api.netbird.io/api/users/current
auth:
type: bearer
token: '{{bearerToken}}'
docs: Get information about the current user
- info:
name: List user invites
type: http
http:
method: GET
url: https://api.netbird.io/api/users/invites
auth:
type: bearer
token: '{{bearerToken}}'
docs: Lists all pending invites for the account. Only available when embedded IdP is enabled.
- info:
name: Create a user invite
type: http
http:
method: POST
url: https://api.netbird.io/api/users/invites
body:
type: json
data: '{}'
auth:
type: bearer
token: '{{bearerToken}}'
docs: Creates an invite link for a new user. Only available when embedded IdP is enabled. The user is not created until
they accept the invite.
- info:
name: Delete a user invite
type: http
http:
method: DELETE
url: https://api.netbird.io/api/users/invites/:inviteId
params:
- name: inviteId
value: ''
type: path
description: The ID of the invite to delete
auth:
type: bearer
token: '{{bearerToken}}'
docs: Deletes a pending invite. Only available when embedded IdP is enabled.
- info:
name: Regenerate a user invite
type: http
http:
method: POST
url: https://api.netbird.io/api/users/invites/:inviteId/regenerate
params:
- name: inviteId
value: ''
type: path
description: The ID of the invite to regenerate
body:
type: json
data: '{}'
auth:
type: bearer
token: '{{bearerToken}}'
docs: Regenerates an invite link for an existing invite. Invalidates the previous token and creates a new one.
- info:
name: Get invite information
type: http
http:
method: GET
url: https://api.netbird.io/api/users/invites/:token
params:
- name: token
value: ''
type: path
description: The invite token
docs: Retrieves public information about an invite. This endpoint is unauthenticated and protected by the token itself.
- info:
name: Accept an invite
type: http
http:
method: POST
url: https://api.netbird.io/api/users/invites/:token/accept
params:
- name: token
value: ''
type: path
description: The invite token
body:
type: json
data: '{}'
docs: Accepts an invite and creates the user with the provided password. This endpoint is unauthenticated and protected
by the token itself.
- info:
name: Tokens
type: folder
items:
- info:
name: List all Tokens
type: http
http:
method: GET
url: https://api.netbird.io/api/users/:userId/tokens
params:
- name: userId
value: ''
type: path
description: The unique identifier of a user
auth:
type: bearer
token: '{{bearerToken}}'
docs: Returns a list of all tokens for a user
- info:
name: Create a Token
type: http
http:
method: POST
url: https://api.netbird.io/api/users/:userId/tokens
params:
- name: userId
value: ''
type: path
description: The unique identifier of a user
body:
type: json
data: '{}'
auth:
type: bearer
token: '{{bearerToken}}'
docs: Create a new token for a user
- info:
name: Retrieve a Token
type: http
http:
method: GET
url: https://api.netbird.io/api/users/:userId/tokens/:tokenId
params:
- name: userId
value: ''
type: path
description: The unique identifier of a user
- name: tokenId
value: ''
type: path
description: The unique identifier of a token
auth:
type: bearer
token: '{{bearerToken}}'
docs: Returns a specific token for a user
- info:
name: Delete a Token
type: http
http:
method: DELETE
url: https://api.netbird.io/api/users/:userId/tokens/:tokenId
params:
- name: userId
value: ''
type: path
description: The unique identifier of a user
- name: tokenId
value: ''
type: path
description: The unique identifier of a token
auth:
type: bearer
token: '{{bearerToken}}'
docs: Delete a token for a user
- info:
name: Peers
type: folder
items:
- info:
name: List all Peers
type: http
http:
method: GET
url: https://api.netbird.io/api/peers
params:
- name: name
value: ''
type: query
description: Filter peers by name
- name: ip
value: ''
type: query
description: Filter peers by IP address
auth:
type: bearer
token: '{{bearerToken}}'
docs: Returns a list of all peers
- info:
name: Retrieve a Peer
type: http
http:
method: GET
url: https://api.netbird.io/api/peers/:peerId
params:
- name: peerId
value: ''
type: path
description: The unique identifier of a peer
auth:
type: bearer
token: '{{bearerToken}}'
docs: Get information about a peer
- info:
name: Update a Peer
type: http
http:
method: PUT
url: https://api.netbird.io/api/peers/:peerId
params:
- name: peerId
value: ''
type: path
description: The unique identifier of a peer
body:
type: json
data: '{}'
auth:
type: bearer
token: '{{bearerToken}}'
docs: Update information about a peer
- info:
name: Delete a Peer
type: http
http:
method: DELETE
url: https://api.netbird.io/api/peers/:peerId
params:
- name: peerId
value: ''
type: path
description: The unique identifier of a peer
auth:
type: bearer
token: '{{bearerToken}}'
docs: Delete a peer
- info:
name: List accessible Peers
type: http
http:
method: GET
url: https://api.netbird.io/api/peers/:peerId/accessible-peers
params:
- name: peerId
value: ''
type: path
description: The unique identifier of a peer
auth:
type: bearer
token: '{{bearerToken}}'
docs: Returns a list of peers that the specified peer can connect to within the network.
- info:
name: Create a Temporary Access Peer
type: http
http:
method: POST
url: https://api.netbird.io/api/peers/:peerId/temporary-access
params:
- name: peerId
value: ''
type: path
description: The unique identifier of a peer
body:
type: json
data: '{}'
auth:
type: bearer
token: '{{bearerToken}}'
docs: Creates a temporary access peer that can be used to access this peer and this peer only. The temporary access peer
and its access policies will be automatically deleted after it disconnects.
- info:
name: Ingress Ports
type: folder
items:
- info:
name: List all Port Allocations
type: http
http:
method: GET
url: https://api.netbird.io/api/peers/:peerId/ingress/ports
params:
- name: peerId
value: ''
type: path
description: The unique identifier of a peer
- name: name
value: ''
type: query
description: Filters ingress port allocations by name
auth:
type: bearer
token: '{{bearerToken}}'
docs: Returns a list of all ingress port allocations for a peer
- info:
name: Create a Port Allocation
type: http
http:
method: POST
url: https://api.netbird.io/api/peers/:peerId/ingress/ports
params:
- name: peerId
value: ''
type: path
description: The unique identifier of a peer
body:
type: json
data: '{}'
auth:
type: bearer
token: '{{bearerToken}}'
docs: Creates a new ingress port allocation for a peer
- info:
name: Retrieve a Port Allocation
type: http
http:
method: GET
url: https://api.netbird.io/api/peers/:peerId/ingress/ports/:allocationId
params:
- name: peerId
value: ''
type: path
description: The unique identifier of a peer
- name: allocationId
value: ''
type: path
description: The unique identifier of an ingress port allocation
auth:
type: bearer
token: '{{bearerToken}}'
docs: Get information about an ingress port allocation
- info:
name: Update a Port Allocation
type: http
http:
method: PUT
url: https://api.netbird.io/api/peers/:peerId/ingress/ports/:allocationId
params:
- name: peerId
value: ''
type: path
description: The unique identifier of a peer
- name: allocationId
value: ''
type: path
description: The unique identifier of an ingress port allocation
body:
type: json
data: '{}'
auth:
type: bearer
token: '{{bearerToken}}'
docs: Update information about an ingress port allocation
- info:
name: Delete a Port Allocation
type: http
http:
method: DELETE
url: https://api.netbird.io/api/peers/:peerId/ingress/ports/:allocationId
params:
- name: peerId
value: ''
type: path
description: The unique identifier of a peer
- name: allocationId
value: ''
type: path
description: The unique identifier of an ingress port allocation
auth:
type: bearer
token: '{{bearerToken}}'
docs: Delete an ingress port allocation
- info:
name: List all Ingress Peers
type: http
http:
method: GET
url: https://api.netbird.io/api/ingress/peers
auth:
type: bearer
token: '{{bearerToken}}'
docs: Returns a list of all ingress peers
- info:
name: Create a Ingress Peer
type: http
http:
method: POST
url: https://api.netbird.io/api/ingress/peers
body:
type: json
data: '{}'
auth:
type: bearer
token: '{{bearerToken}}'
docs: Creates a new ingress peer
- info:
name: Retrieve a Ingress Peer
type: http
http:
method: GET
url: https://api.netbird.io/api/ingress/peers/:ingressPeerId
params:
- name: ingressPeerId
value: ''
type: path
description: The unique identifier of an ingress peer
auth:
type: bearer
token: '{{bearerToken}}'
docs: Get information about an ingress peer
- info:
name: Update a Ingress Peer
type: http
http:
method: PUT
url: https://api.netbird.io/api/ingress/peers/:ingressPeerId
params:
- name: ingressPeerId
value: ''
type: path
description: The unique identifier of an ingress peer
body:
type: json
data: '{}'
auth:
type: bearer
token: '{{bearerToken}}'
docs: Update information about an ingress peer
- info:
name: Delete a Ingress Peer
type: http
http:
method: DELETE
url: https://api.netbird.io/api/ingress/peers/:ingressPeerId
params:
- name: ingressPeerId
value: ''
type: path
description: The unique identifier of an ingress peer
auth:
type: bearer
token: '{{bearerToken}}'
docs: Delete an ingress peer
- info:
name: Setup Keys
type: folder
items:
- info:
name: List all Setup Keys
type: http
http:
method: GET
url: https://api.netbird.io/api/setup-keys
auth:
type: bearer
token: '{{bearerToken}}'
docs: Returns a list of all Setup Keys
- info:
name: Create a Setup Key
type: http
http:
method: POST
url: https://api.netbird.io/api/setup-keys
body:
type: json
data: '{}'
auth:
type: bearer
token: '{{bearerToken}}'
docs: Creates a setup key
- info:
name: Retrieve a Setup Key
type: http
http:
method: GET
url: https://api.netbird.io/api/setup-keys/:keyId
params:
- name: keyId
value: ''
type: path
description: The unique identifier of a setup key
auth:
type: bearer
token: '{{bearerToken}}'
docs: Get information about a setup key
- info:
name: Update a Setup Key
type: http
http:
method: PUT
url: https://api.netbird.io/api/setup-keys/:keyId
params:
- name: keyId
value: ''
type: path
description: The unique identifier of a setup key
body:
type: json
data: '{}'
auth:
type: bearer
token: '{{bearerToken}}'
docs: Update information about a setup key
- info:
name: Delete a Setup Key
type: http
http:
method: DELETE
url: https://api.netbird.io/api/setup-keys/:keyId
params:
- name: keyId
value: ''
type: path
description: The unique identifier of a setup key
auth:
type: bearer
token: '{{bearerToken}}'
docs: Delete a Setup Key
- info:
name: Groups
type: folder
items:
- info:
name: List all Groups
type: http
http:
method: GET
url: https://api.netbird.io/api/groups
params:
- name: name
value: devs
type: query
description: Filter groups by name (exact match)
auth:
type: bearer
token: '{{bearerToken}}'
docs: Returns a list of all groups
- info:
name: Create a Group
type: http
http:
method: POST
url: https://api.netbird.io/api/groups
body:
type: json
data: '{}'
auth:
type: bearer
token: '{{bearerToken}}'
docs: Creates a group
- info:
name: Retrieve a Group
type: http
http:
method: GET
url: https://api.netbird.io/api/groups/:groupId
params:
- name: groupId
value: ''
type: path
description: The unique identifier of a group
auth:
type: bearer
token: '{{bearerToken}}'
docs: Get information about a group
- info:
name: Update a Group
type: http
http:
method: PUT
url: https://api.netbird.io/api/groups/:groupId
params:
- name: groupId
value: ''
type: path
description: The unique identifier of a group
body:
type: json
data: '{}'
auth:
type: bearer
token: '{{bearerToken}}'
docs: Update/Replace a group
- info:
name: Delete a Group
type: http
http:
method: DELETE
url: https://api.netbird.io/api/groups/:groupId
params:
- name: groupId
value: ''
type: path
description: The unique identifier of a group
auth:
type: bearer
token: '{{bearerToken}}'
docs: Delete a group
- info:
name: Policies
type: folder
items:
- info:
name: List all Policies
type: http
http:
method: GET
url: https://api.netbird.io/api/policies
auth:
type: bearer
token: '{{bearerToken}}'
docs: Returns a list of all policies
- info:
name: Create a Policy
type: http
http:
method: POST
url: https://api.netbird.io/api/policies
body:
type: json
data: '{}'
auth:
type: bearer
token: '{{bearerToken}}'
docs: Creates a policy
- info:
name: Retrieve a Policy
type: http
http:
method: GET
url: https://api.netbird.io/api/policies/:policyId
params:
- name: policyId
value: ''
type: path
description: The unique identifier of a policy
auth:
type: bearer
token: '{{bearerToken}}'
docs: Get information about a Policies
- info:
name: Update a Policy
type: http
http:
method: PUT
url: https://api.netbird.io/api/policies/:policyId
params:
- name: policyId
value: ''
type: path
description: The unique identifier of a policy
body:
type: json
data: '{}'
auth:
type: bearer
token: '{{bearerToken}}'
docs: Update/Replace a Policy
- info:
name: Delete a Policy
type: http
http:
method: DELETE
url: https://api.netbird.io/api/policies/:policyId
params:
- name: policyId
value: ''
type: path
description: The unique identifier of a policy
auth:
type: bearer
token: '{{bearerToken}}'
docs: Delete a policy
- info:
name: Routes
type: folder
items:
- info:
name: List all Routes
type: http
http:
method: GET
url: https://api.netbird.io/api/routes
auth:
type: bearer
token: '{{bearerToken}}'
docs: Returns a list of all routes
- info:
name: Create a Route
type: http
http:
method: POST
url: https://api.netbird.io/api/routes
body:
type: json
data: '{}'
auth:
type: bearer
token: '{{bearerToken}}'
docs: Creates a Route
- info:
name: Retrieve a Route
type: http
http:
method: GET
url: https://api.netbird.io/api/routes/:routeId
params:
- name: routeId
value: ''
type: path
description: The unique identifier of a route
auth:
type: bearer
token: '{{bearerToken}}'
docs: Get information about a Routes
- info:
name: Update a Route
type: http
http:
method: PUT
url: https://api.netbird.io/api/routes/:routeId
params:
- name: routeId
value: ''
type: path
description: The unique identifier of a route
body:
type: json
data: '{}'
auth:
type: bearer
token: '{{bearerToken}}'
docs: Update/Replace a Route
- info:
name: Delete a Route
type: http
http:
method: DELETE
url: https://api.netbird.io/api/routes/:routeId
params:
- name: routeId
value: ''
type: path
description: The unique identifier of a route
auth:
type: bearer
token: '{{bearerToken}}'
docs: Delete a route
- info:
name: Networks
type: folder
items:
- info:
name: List all Networks
type: http
http:
method: GET
url: https://api.netbird.io/api/networks
auth:
type: bearer
token: '{{bearerToken}}'
docs: Returns a list of all networks
- info:
name: Create a Network
type: http
http:
method: POST
url: https://api.netbird.io/api/networks
body:
type: json
data: '{}'
auth:
type: bearer
token: '{{bearerToken}}'
docs: Creates a Network
- info:
name: Retrieve a Network
type: http
http:
method: GET
url: https://api.netbird.io/api/networks/:networkId
params:
- name: networkId
value: ''
type: path
description: The unique identifier of a network
auth:
type: bearer
token: '{{bearerToken}}'
docs: Get information about a Network
- info:
name: Update a Network
type: http
http:
method: PUT
url: https://api.netbird.io/api/networks/:networkId
params:
- name: networkId
value: ''
type: path
description: The unique identifier of a network
body:
type: json
data: '{}'
auth:
type: bearer
token: '{{bearerToken}}'
docs: Update/Replace a Network
- info:
name: Delete a Network
type: http
http:
method: DELETE
url: https://api.netbird.io/api/networks/:networkId
params:
- name: networkId
value: ''
type: path
description: The unique identifier of a network
auth:
type: bearer
token: '{{bearerToken}}'
docs: Delete a network
- info:
name: List all Network Resources
type: http
http:
method: GET
url: https://api.netbird.io/api/networks/:networkId/resources
params:
- name: networkId
value: ''
type: path
description: The unique identifier of a network
auth:
type: bearer
token: '{{bearerToken}}'
docs: Returns a list of all resources in a network
- info:
name: Create a Network Resource
type: http
http:
method: POST
url: https://api.netbird.io/api/networks/:networkId/resources
params:
- name: networkId
value: ''
type: path
description: The unique identifier of a network
body:
type: json
data: '{}'
auth:
type: bearer
token: '{{bearerToken}}'
docs: Creates a Network Resource
- info:
name: Retrieve a Network Resource
type: http
http:
method: GET
url: https://api.netbird.io/api/networks/:networkId/resources/:resourceId
params:
- name: networkId
value: ''
type: path
description: The unique identifier of a network
- name: resourceId
value: ''
type: path
description: The unique identifier of a network resource
auth:
type: bearer
token: '{{bearerToken}}'
docs: Get information about a Network Resource
- info:
name: Update a Network Resource
type: http
http:
method: PUT
url: https://api.netbird.io/api/networks/:networkId/resources/:resourceId
params:
- name: networkId
value: ''
type: path
description: The unique identifier of a network
- name: resourceId
value: ''
type: path
description: The unique identifier of a resource
body:
type: json
data: '{}'
auth:
type: bearer
token: '{{bearerToken}}'
docs: Update a Network Resource
- info:
name: Delete a Network Resource
type: http
http:
method: DELETE
url: https://api.netbird.io/api/networks/:networkId/resources/:resourceId
params:
- name: networkId
value: ''
type: path
- name: resourceId
value: ''
type: path
auth:
type: bearer
token: '{{bearerToken}}'
docs: Delete a network resource
- info:
name: List all Network Routers
type: http
http:
method: GET
url: https://api.netbird.io/api/networks/:networkId/routers
params:
- name: networkId
value: ''
type: path
description: The unique identifier of a network
auth:
type: bearer
token: '{{bearerToken}}'
docs: Returns a list of all routers in a network
- info:
name: Create a Network Router
type: http
http:
method: POST
url: https://api.netbird.io/api/networks/:networkId/routers
params:
- name: networkId
value: ''
type: path
description: The unique identifier of a network
body:
type: json
data: '{}'
auth:
type: bearer
token: '{{bearerToken}}'
docs: Creates a Network Router
- info:
name: Retrieve a Network Router
type: http
http:
method: GET
url: https://api.netbird.io/api/networks/:networkId/routers/:routerId
params:
- name: networkId
value: ''
type: path
description: The unique identifier of a network
- name: routerId
value: ''
type: path
description: The unique identifier of a router
auth:
type: bearer
token: '{{bearerToken}}'
docs: Get information about a Network Router
- info:
name: Update a Network Router
type: http
http:
method: PUT
url: https://api.netbird.io/api/networks/:networkId/routers/:routerId
params:
- name: networkId
value: ''
type: path
description: The unique identifier of a network
- name: routerId
value: ''
type: path
description: The unique identifier of a router
body:
type: json
data: '{}'
auth:
type: bearer
token: '{{bearerToken}}'
docs: Update a Network Router
- info:
name: Delete a Network Router
type: http
http:
method: DELETE
url: https://api.netbird.io/api/networks/:networkId/routers/:routerId
params:
- name: networkId
value: ''
type: path
- name: routerId
value: ''
type: path
auth:
typ
# --- truncated at 32 KB (77 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/netbird/refs/heads/main/apis.yml