NetBird.ApiClient 1.0.1

.NET 10.0 This package targets .NET 10.0. The package is compatible with this framework or higher. 
dotnet add package NetBird.ApiClient --version 1.0.1
                    


                    

                
NuGet\Install-Package NetBird.ApiClient -Version 1.0.1
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="NetBird.ApiClient" Version="1.0.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="NetBird.ApiClient" Version="1.0.1" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="NetBird.ApiClient" />
                    


                            Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package. 
paket add NetBird.ApiClient --version 1.0.1
                    


                    

                
#r "nuget: NetBird.ApiClient, 1.0.1"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
#:package NetBird.ApiClient@1.0.1
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package. 
#addin nuget:?package=NetBird.ApiClient&version=1.0.1
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=NetBird.ApiClient&version=1.0.1
                    


                            Install as a Cake Tool

NetBird.ApiClient - C# Client for the NetBird API

API to manipulate groups, rules, policies and retrieve information about peers and users

This Client was originally created using OpenAPI Generator, but has been heavily adjusted to fit better for modern C# Development.

I am not affiliated with NetBird in any way. I simply needed a NetBird API in C# for my personal and work related projects, which is why I created this library. If you encounter any issues, please feel free to open an issue.

AI-generated slop issues will be closed without any comment.

Thank you.

Installation

dotnet add package NetBird.ApiClient

Dependencies

Usage

To use the API client

NetBirdApiClientOptions c = new NetBirdApiClientOptions()
{
    AccessToken = "nbp_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
    BaseUrl = "https://api.netbird.io/api"
};
var client = new NetBirdApiClient(c);
var peers = await client.PeersApi.ApiPeersGetAsync();
foreach (PeerBatch peer in peers)
{
    Console.WriteLine(peer.ToString());
}

Documentation for API Endpoints

All URIs are relative to https://api.netbird.io/api

Class Method HTTP request Description
AWSMarketplaceApi ApiIntegrationsBillingAwsMarketplaceActivatePost POST integrations/billing/aws/marketplace/activate Activate AWS Marketplace subscription.
AWSMarketplaceApi ApiIntegrationsBillingAwsMarketplaceEnrichPost POST integrations/billing/aws/marketplace/enrich Enrich AWS Marketplace subscription with Account ID.
AccountsApi ApiAccountsAccountIdDelete DELETE accounts/{accountId} Delete an Account
AccountsApi ApiAccountsAccountIdPut PUT accounts/{accountId} Update an Account
AccountsApi ApiAccountsGet GET accounts List all Accounts
CheckoutApi ApiIntegrationsBillingCheckoutPost POST integrations/billing/checkout Create checkout session
DNSApi ApiDnsNameserversGet GET dns/nameservers List all Nameserver Groups
DNSApi ApiDnsNameserversNsgroupIdDelete DELETE dns/nameservers/{nsgroupId} Delete a Nameserver Group
DNSApi ApiDnsNameserversNsgroupIdGet GET dns/nameservers/{nsgroupId} Retrieve a Nameserver Group
DNSApi ApiDnsNameserversNsgroupIdPut PUT dns/nameservers/{nsgroupId} Update a Nameserver Group
DNSApi ApiDnsNameserversPost POST dns/nameservers Create a Nameserver Group
DNSApi ApiDnsSettingsGet GET dns/settings Retrieve DNS settings
DNSApi ApiDnsSettingsPut PUT dns/settings Update DNS Settings
DNSZonesApi ApiDnsZonesGet GET dns/zones List all DNS Zones
DNSZonesApi ApiDnsZonesPost POST dns/zones Create a DNS Zone
DNSZonesApi ApiDnsZonesZoneIdDelete DELETE dns/zones/{zoneId} Delete a DNS Zone
DNSZonesApi ApiDnsZonesZoneIdGet GET dns/zones/{zoneId} Retrieve a DNS Zone
DNSZonesApi ApiDnsZonesZoneIdPut PUT dns/zones/{zoneId} Update a DNS Zone
DNSZonesApi ApiDnsZonesZoneIdRecordsGet GET dns/zones/{zoneId}/records List all DNS Records
DNSZonesApi ApiDnsZonesZoneIdRecordsPost POST dns/zones/{zoneId}/records Create a DNS Record
DNSZonesApi ApiDnsZonesZoneIdRecordsRecordIdDelete DELETE dns/zones/{zoneId}/records/{recordId} Delete a DNS Record
DNSZonesApi ApiDnsZonesZoneIdRecordsRecordIdGet GET dns/zones/{zoneId}/records/{recordId} Retrieve a DNS Record
DNSZonesApi ApiDnsZonesZoneIdRecordsRecordIdPut PUT dns/zones/{zoneId}/records/{recordId} Update a DNS Record
EDRFalconIntegrationsApi ApiIntegrationsEdrFalconDelete DELETE integrations/edr/falcon Delete EDR Falcon Integration
EDRFalconIntegrationsApi ApiIntegrationsEdrFalconGet GET integrations/edr/falcon Get EDR Falcon Integration
EDRFalconIntegrationsApi CreateFalconEDRIntegration POST integrations/edr/falcon Create EDR Falcon Integration
EDRFalconIntegrationsApi UpdateFalconEDRIntegration PUT integrations/edr/falcon Update EDR Falcon Integration
EDRHuntressIntegrationsApi ApiIntegrationsEdrHuntressDelete DELETE integrations/edr/huntress Delete EDR Huntress Integration
EDRHuntressIntegrationsApi ApiIntegrationsEdrHuntressGet GET integrations/edr/huntress Get EDR Huntress Integration
EDRHuntressIntegrationsApi CreateHuntressEDRIntegration POST integrations/edr/huntress Create EDR Huntress Integration
EDRHuntressIntegrationsApi UpdateHuntressEDRIntegration PUT integrations/edr/huntress Update EDR Huntress Integration
EDRIntuneIntegrationsApi CreateEDRIntegration POST integrations/edr/intune Create EDR Intune Integration
EDRIntuneIntegrationsApi DeleteIntegration DELETE integrations/edr/intune Delete EDR Intune Integration
EDRIntuneIntegrationsApi GetEDRIntegration GET integrations/edr/intune Get EDR Intune Integration
EDRIntuneIntegrationsApi UpdateEDRIntegration PUT integrations/edr/intune Update EDR Intune Integration
EDRPeersApi BypassCompliance POST peers/{peer-id}/edr/bypass Bypass compliance for a non-compliant peer
EDRPeersApi ListBypassedPeers GET peers/edr/bypassed List all bypassed peers
EDRPeersApi RevokeBypass DELETE peers/{peer-id}/edr/bypass Revoke compliance bypass for a peer
EDRSentinelOneIntegrationsApi ApiIntegrationsEdrSentineloneDelete DELETE integrations/edr/sentinelone Delete EDR SentinelOne Integration
EDRSentinelOneIntegrationsApi ApiIntegrationsEdrSentineloneGet GET integrations/edr/sentinelone Get EDR SentinelOne Integration
EDRSentinelOneIntegrationsApi CreateSentinelOneEDRIntegration POST integrations/edr/sentinelone Create EDR SentinelOne Integration
EDRSentinelOneIntegrationsApi UpdateSentinelOneEDRIntegration PUT integrations/edr/sentinelone Update EDR SentinelOne Integration
EventStreamingIntegrationsApi CreateIntegration POST event-streaming Create Event Streaming Integration
EventStreamingIntegrationsApi DeleteIntegration DELETE event-streaming/{id} Delete Event Streaming Integration
EventStreamingIntegrationsApi GetAllIntegrations GET event-streaming List Event Streaming Integrations
EventStreamingIntegrationsApi GetIntegration GET event-streaming/{id} Get Event Streaming Integration
EventStreamingIntegrationsApi UpdateIntegration PUT event-streaming/{id} Update Event Streaming Integration
EventsApi ApiEventsAuditGet GET events/audit List all Audit Events
EventsApi ApiEventsNetworkTrafficGet GET events/network-traffic List all Traffic Events
EventsApi ApiEventsProxyGet GET events/proxy List all Reverse Proxy Access Logs
GeoLocationsApi ApiLocationsCountriesCountryCitiesGet GET locations/countries/{country}/cities List all city names by country
GeoLocationsApi ApiLocationsCountriesGet GET locations/countries List all country codes
GroupsApi ApiGroupsGet GET groups List all Groups
GroupsApi ApiGroupsGroupIdDelete DELETE groups/{groupId} Delete a Group
GroupsApi ApiGroupsGroupIdGet GET groups/{groupId} Retrieve a Group
GroupsApi ApiGroupsGroupIdPut PUT groups/{groupId} Update a Group
GroupsApi ApiGroupsPost POST groups Create a Group
IDPApi CreateSCIMIntegration POST integrations/scim-idp Create SCIM IDP Integration
IDPApi DeleteSCIMIntegration DELETE integrations/scim-idp/{id} Delete SCIM IDP Integration
IDPApi GetAllSCIMIntegrations GET integrations/scim-idp Get All SCIM IDP Integrations
IDPApi GetSCIMIntegration GET integrations/scim-idp/{id} Get SCIM IDP Integration
IDPApi GetSCIMIntegrationLogs GET integrations/scim-idp/{id}/logs Get SCIM Integration Sync Logs
IDPApi RegenerateSCIMToken POST integrations/scim-idp/{id}/token Regenerate SCIM Token
IDPApi UpdateSCIMIntegration PUT integrations/scim-idp/{id} Update SCIM IDP Integration
IdentityProvidersApi ApiIdentityProvidersGet GET identity-providers List all Identity Providers
IdentityProvidersApi ApiIdentityProvidersIdpIdDelete DELETE identity-providers/{idpId} Delete an Identity Provider
IdentityProvidersApi ApiIdentityProvidersIdpIdGet GET identity-providers/{idpId} Retrieve an Identity Provider
IdentityProvidersApi ApiIdentityProvidersIdpIdPut PUT identity-providers/{idpId} Update an Identity Provider
IdentityProvidersApi ApiIdentityProvidersPost POST identity-providers Create an Identity Provider
IngressPortsApi ApiIngressPeersGet GET ingress/peers List all Ingress Peers
IngressPortsApi ApiIngressPeersIngressPeerIdDelete DELETE ingress/peers/{ingressPeerId} Delete a Ingress Peer
IngressPortsApi ApiIngressPeersIngressPeerIdGet GET ingress/peers/{ingressPeerId} Retrieve a Ingress Peer
IngressPortsApi ApiIngressPeersIngressPeerIdPut PUT ingress/peers/{ingressPeerId} Update a Ingress Peer
IngressPortsApi ApiIngressPeersPost POST ingress/peers Create a Ingress Peer
IngressPortsApi ApiPeersPeerIdIngressPortsAllocationIdDelete DELETE peers/{peerId}/ingress/ports/{allocationId} Delete a Port Allocation
IngressPortsApi ApiPeersPeerIdIngressPortsAllocationIdGet GET peers/{peerId}/ingress/ports/{allocationId} Retrieve a Port Allocation
IngressPortsApi ApiPeersPeerIdIngressPortsAllocationIdPut PUT peers/{peerId}/ingress/ports/{allocationId} Update a Port Allocation
IngressPortsApi ApiPeersPeerIdIngressPortsGet GET peers/{peerId}/ingress/ports List all Port Allocations
IngressPortsApi ApiPeersPeerIdIngressPortsPost POST peers/{peerId}/ingress/ports Create a Port Allocation
InstanceApi ApiInstanceGet GET instance Get Instance Status
InstanceApi ApiInstanceVersionGet GET instance/version Get Version Info
InstanceApi ApiSetupPost POST setup Setup Instance
InvoiceApi ApiIntegrationsBillingInvoicesGet GET integrations/billing/invoices Get account's paid invoices
InvoiceApi ApiIntegrationsBillingInvoicesIdCsvGet GET integrations/billing/invoices/{id}/csv Get account invoice CSV.
InvoiceApi ApiIntegrationsBillingInvoicesIdPdfGet GET integrations/billing/invoices/{id}/pdf Get account invoice URL to Stripe.
JobsApi ApiPeersPeerIdJobsGet GET peers/{peerId}/jobs List Jobs
JobsApi ApiPeersPeerIdJobsJobIdGet GET peers/{peerId}/jobs/{jobId} Get Job
JobsApi ApiPeersPeerIdJobsPost POST peers/{peerId}/jobs Create Job
MSPApi ApiIntegrationsMspTenantsGet GET integrations/msp/tenants Get MSP tenants
MSPApi ApiIntegrationsMspTenantsIdDnsPost POST integrations/msp/tenants/{id}/dns Verify a tenant domain DNS challenge
MSPApi ApiIntegrationsMspTenantsIdInvitePost POST integrations/msp/tenants/{id}/invite Invite existing account as a Tenant to the MSP account
MSPApi ApiIntegrationsMspTenantsIdInvitePut PUT integrations/msp/tenants/{id}/invite Response by the invited Tenant account owner
MSPApi ApiIntegrationsMspTenantsIdPut PUT integrations/msp/tenants/{id} Update MSP tenant
MSPApi ApiIntegrationsMspTenantsIdSubscriptionPost POST integrations/msp/tenants/{id}/subscription Create subscription for Tenant
MSPApi ApiIntegrationsMspTenantsIdUnlinkPost POST integrations/msp/tenants/{id}/unlink Unlink a tenant
MSPApi ApiIntegrationsMspTenantsPost POST integrations/msp/tenants Create MSP tenant
NetworksApi ApiNetworksGet GET networks List all Networks
NetworksApi ApiNetworksNetworkIdDelete DELETE networks/{networkId} Delete a Network
NetworksApi ApiNetworksNetworkIdGet GET networks/{networkId} Retrieve a Network
NetworksApi ApiNetworksNetworkIdPut PUT networks/{networkId} Update a Network
NetworksApi ApiNetworksNetworkIdResourcesGet GET networks/{networkId}/resources List all Network Resources
NetworksApi ApiNetworksNetworkIdResourcesPost POST networks/{networkId}/resources Create a Network Resource
NetworksApi ApiNetworksNetworkIdResourcesResourceIdDelete DELETE networks/{networkId}/resources/{resourceId} Delete a Network Resource
NetworksApi ApiNetworksNetworkIdResourcesResourceIdGet GET networks/{networkId}/resources/{resourceId} Retrieve a Network Resource
NetworksApi ApiNetworksNetworkIdResourcesResourceIdPut PUT networks/{networkId}/resources/{resourceId} Update a Network Resource
NetworksApi ApiNetworksNetworkIdRoutersGet GET networks/{networkId}/routers List all Network Routers
NetworksApi ApiNetworksNetworkIdRoutersPost POST networks/{networkId}/routers Create a Network Router
NetworksApi ApiNetworksNetworkIdRoutersRouterIdDelete DELETE networks/{networkId}/routers/{routerId} Delete a Network Router
NetworksApi ApiNetworksNetworkIdRoutersRouterIdGet GET networks/{networkId}/routers/{routerId} Retrieve a Network Router
NetworksApi ApiNetworksNetworkIdRoutersRouterIdPut PUT networks/{networkId}/routers/{routerId} Update a Network Router
NetworksApi ApiNetworksPost POST networks Create a Network
NetworksApi ApiNetworksRoutersGet GET networks/routers List all Network Routers
PeersApi ApiPeersGet GET peers List all Peers
PeersApi ApiPeersPeerIdAccessiblePeersGet GET peers/{peerId}/accessible-peers List accessible Peers
PeersApi ApiPeersPeerIdDelete DELETE peers/{peerId} Delete a Peer
PeersApi ApiPeersPeerIdGet GET peers/{peerId} Retrieve a Peer
PeersApi ApiPeersPeerIdPut PUT peers/{peerId} Update a Peer
PeersApi ApiPeersPeerIdTemporaryAccessPost POST peers/{peerId}/temporary-access Create a Temporary Access Peer
PlansApi ApiIntegrationsBillingPlansGet GET integrations/billing/plans Get available plans
PoliciesApi ApiPoliciesGet GET policies List all Policies
PoliciesApi ApiPoliciesPolicyIdDelete DELETE policies/{policyId} Delete a Policy
PoliciesApi ApiPoliciesPolicyIdGet GET policies/{policyId} Retrieve a Policy
PoliciesApi ApiPoliciesPolicyIdPut PUT policies/{policyId} Update a Policy
PoliciesApi ApiPoliciesPost POST policies Create a Policy
PortalApi ApiIntegrationsBillingPortalGet GET integrations/billing/portal Get customer portal URL
PostureChecksApi ApiPostureChecksGet GET posture-checks List all Posture Checks
PostureChecksApi ApiPostureChecksPost POST posture-checks Create a Posture Check
PostureChecksApi ApiPostureChecksPostureCheckIdDelete DELETE posture-checks/{postureCheckId} Delete a Posture Check
PostureChecksApi ApiPostureChecksPostureCheckIdGet GET posture-checks/{postureCheckId} Retrieve a Posture Check
PostureChecksApi ApiPostureChecksPostureCheckIdPut PUT posture-checks/{postureCheckId} Update a Posture Check
RoutesApi ApiRoutesGet GET routes List all Routes
RoutesApi ApiRoutesPost POST routes Create a Route
RoutesApi ApiRoutesRouteIdDelete DELETE routes/{routeId} Delete a Route
RoutesApi ApiRoutesRouteIdGet GET routes/{routeId} Retrieve a Route
RoutesApi ApiRoutesRouteIdPut PUT routes/{routeId} Update a Route
ServicesApi ApiReverseProxiesClustersGet GET reverse-proxies/clusters List available proxy clusters
ServicesApi ApiReverseProxiesDomainsDomainIdDelete DELETE reverse-proxies/domains/{domainId} Delete a Custom domain
ServicesApi ApiReverseProxiesDomainsDomainIdValidateGet GET reverse-proxies/domains/{domainId}/validate Validate a custom domain
ServicesApi ApiReverseProxiesDomainsGet GET reverse-proxies/domains Retrieve Service Domains
ServicesApi ApiReverseProxiesDomainsPost POST reverse-proxies/domains Create a Custom domain
ServicesApi ApiReverseProxiesServicesGet GET reverse-proxies/services List all Services
ServicesApi ApiReverseProxiesServicesPost POST reverse-proxies/services Create a Service
ServicesApi ApiReverseProxiesServicesServiceIdDelete DELETE reverse-proxies/services/{serviceId} Delete a Service
ServicesApi ApiReverseProxiesServicesServiceIdGet GET reverse-proxies/services/{serviceId} Retrieve a Service
ServicesApi ApiReverseProxiesServicesServiceIdPut PUT reverse-proxies/services/{serviceId} Update a Service
SetupKeysApi ApiSetupKeysGet GET setup-keys List all Setup Keys
SetupKeysApi ApiSetupKeysKeyIdDelete DELETE setup-keys/{keyId} Delete a Setup Key
SetupKeysApi ApiSetupKeysKeyIdGet GET setup-keys/{keyId} Retrieve a Setup Key
SetupKeysApi ApiSetupKeysKeyIdPut PUT setup-keys/{keyId} Update a Setup Key
SetupKeysApi ApiSetupKeysPost POST setup-keys Create a Setup Key
SubscriptionApi ApiIntegrationsBillingSubscriptionGet GET integrations/billing/subscription Get current subscription
SubscriptionApi ApiIntegrationsBillingSubscriptionPut PUT integrations/billing/subscription Change subscription
TokensApi ApiUsersUserIdTokensGet GET users/{userId}/tokens List all Tokens
TokensApi ApiUsersUserIdTokensPost POST users/{userId}/tokens Create a Token
TokensApi ApiUsersUserIdTokensTokenIdDelete DELETE users/{userId}/tokens/{tokenId} Delete a Token
TokensApi ApiUsersUserIdTokensTokenIdGet GET users/{userId}/tokens/{tokenId} Retrieve a Token
UsageApi ApiIntegrationsBillingUsageGet GET integrations/billing/usage Get current usage
UsersApi ApiUsersCurrentGet GET users/current Retrieve current user
UsersApi ApiUsersGet GET users List all Users
UsersApi ApiUsersInvitesGet GET users/invites List user invites
UsersApi ApiUsersInvitesInviteIdDelete DELETE users/invites/{inviteId} Delete a user invite
UsersApi ApiUsersInvitesInviteIdRegeneratePost POST users/invites/{inviteId}/regenerate Regenerate a user invite
UsersApi ApiUsersInvitesPost POST users/invites Create a user invite
UsersApi ApiUsersInvitesTokenAcceptPost POST users/invites/{token}/accept Accept an invite
UsersApi ApiUsersInvitesTokenGet GET users/invites/{token} Get invite information
UsersApi ApiUsersPost POST users Create a User
UsersApi ApiUsersUserIdApprovePost POST users/{userId}/approve Approve user
UsersApi ApiUsersUserIdDelete DELETE users/{userId} Delete a User
UsersApi ApiUsersUserIdInvitePost POST users/{userId}/invite Resend user invitation
UsersApi ApiUsersUserIdPasswordPut PUT users/{userId}/password Change user password
UsersApi ApiUsersUserIdPut PUT users/{userId} Update a User
UsersApi ApiUsersUserIdRejectDelete DELETE users/{userId}/reject Reject user

<a id="documentation-for-models"></a>

Documentation for Models

Product Compatible and additional computed target framework versions.
.NET net10.0 is compatible.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
1.0.1 205 3/14/2026
1.0.0 122 3/14/2026
0.0.1-preview002 117 3/14/2026
0.0.1-preview001 116 3/14/2026