Models

Pydantic models provide type-safe input validation for API requests. All models inherit from BaseModel with extra="allow" for forward compatibility.

Base Model

class netbird.models.common.BaseModel(**data)

Bases: BaseModel

Base model for all NetBird API models.

model_config: ClassVar[ConfigDict] = {'extra': 'allow', 'populate_by_name': True, 'use_enum_values': True, 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

All models use these configurations:

• extra="allow" - Accepts unknown fields from newer API versions

• validate_assignment=True - Validates field assignments after creation

• use_enum_values=True - Uses enum values instead of enum instances

• populate_by_name=True - Allows populating by field name or alias

Enumerations

class netbird.models.common.UserRole(value)

User role enumeration.

Values: admin, user, owner

ADMIN = 'admin'

USER = 'user'

OWNER = 'owner'

class netbird.models.common.UserStatus(value)

User status enumeration.

Values: active, disabled, invited

ACTIVE = 'active'

DISABLED = 'disabled'

INVITED = 'invited'

class netbird.models.common.SetupKeyType(value)

Setup key type enumeration.

Values: reusable, one-off

REUSABLE = 'reusable'

ONE_OFF = 'one-off'

class netbird.models.common.NetworkType(value)

Network type enumeration.

Values: ipv4, ipv6, domain

IPV4 = 'ipv4'

IPV6 = 'ipv6'

DOMAIN = 'domain'

class netbird.models.common.Protocol(value)

Network protocol enumeration.

Values: tcp, udp, icmp, all

TCP = 'tcp'

UDP = 'udp'

ICMP = 'icmp'

ALL = 'all'

class netbird.models.common.PolicyAction(value)

Policy action enumeration.

Values: accept, drop

ACCEPT = 'accept'

DROP = 'drop'

class netbird.models.common.TrafficDirection(value)

Traffic direction enumeration.

Values: sent, received

SENT = 'sent'

RECEIVED = 'received'

class netbird.models.common.ConnectionType(value)

Connection type enumeration.

Values: relay, p2p

RELAY = 'relay'

P2P = 'p2p'

Account Models

class netbird.models.account.Account(**data)

NetBird account model.

id

Unique account identifier

domain

Account domain

domain_category

Domain category

created_at

Account creation timestamp

created_by

User who created the account

settings

Account settings

id: ResourceId

domain: str

domain_category: str | None

created_at: str | None

created_by: str | None

settings: Dict[str, Any] | None

onboarding: Dict[str, Any] | None

model_config: ClassVar[ConfigDict] = {'extra': 'allow', 'populate_by_name': True, 'use_enum_values': True, 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class netbird.models.account.AccountSettings(**data)

Account settings configuration.

peer_login_expiration

Peer login expiration settings

peer_login_expiration_enabled

Whether peer login expiration is enabled

peer_inactivity_expiration_enabled

Whether peer inactivity expiration is enabled

user_view_restrictions

User view restriction settings

group_propagation_enabled

Whether group propagation is enabled

jwt_groups_enabled

Whether JWT groups are enabled

jwt_groups_claim_name

JWT groups claim name

dns_resolution_enabled

Whether DNS resolution is enabled

network_traffic_logging_enabled

Whether network traffic logging is enabled

lazy_connection_enabled

Whether lazy connection is enabled

peer_login_expiration: int | None

peer_login_expiration_enabled: bool

peer_inactivity_expiration_enabled: bool

user_view_restrictions: Dict[str, bool] | None

group_propagation_enabled: bool

jwt_groups_enabled: bool

jwt_groups_claim_name: str | None

dns_resolution_enabled: bool

network_traffic_logging_enabled: bool

lazy_connection_enabled: bool

peer_inactivity_expiration: int | None

routing_peer_dns_resolution_enabled: bool | None

network_range: str | None

peer_expose_enabled: bool | None

peer_expose_groups: List[str] | None

auto_update_version: str | None

embedded_idp_enabled: bool | None

local_auth_disabled: bool | None

extra_settings: Dict[str, Any] | None

model_config: ClassVar[ConfigDict] = {'extra': 'allow', 'populate_by_name': True, 'use_enum_values': True, 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

User Models

class netbird.models.user.User(**data)

NetBird user model.

id

Unique user identifier

email

User email address

name

User display name

role

User role

status

User status (active, disabled, invited)

auto_groups

List of auto-assigned group IDs

is_service_user

Whether this is a service user

is_blocked

Whether the user is blocked

issued

When the user was created

permissions

User permissions

is_current

Whether this is the current user (from get_current endpoint)

last_login

Last login timestamp

id: ResourceId

email: str | None

name: str | None

role: UserRole

status: UserStatus

auto_groups: List[ResourceId] | None

is_service_user: bool

is_blocked: bool

issued: str | None

permissions: Dict[str, Any] | None

is_current: bool | None

last_login: str | None

model_config: ClassVar[ConfigDict] = {'extra': 'allow', 'populate_by_name': True, 'use_enum_values': True, 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class netbird.models.user.UserCreate(**data)

Model for creating a new user.

email

User email address

name

User display name

role

User role (admin, user, owner)

auto_groups

List of group IDs to auto-assign

is_service_user

Whether this is a service user

is_blocked

Whether the user is blocked

from netbird.models import UserCreate

user = UserCreate(
    email="alice@company.com",
    name="Alice",
    role="admin",           # or UserRole.ADMIN
    is_service_user=False,
    auto_groups=["default-group"]
)

email: EmailStr

name: str | None

role: UserRole

auto_groups: List[ResourceId] | None

is_service_user: bool

is_blocked: bool

model_config: ClassVar[ConfigDict] = {'extra': 'allow', 'populate_by_name': True, 'use_enum_values': True, 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class netbird.models.user.UserUpdate(**data)

Model for updating an existing user.

name

User display name

role

User role

auto_groups

List of group IDs to auto-assign

is_blocked

Whether the user is blocked

name: str | None

role: UserRole | None

auto_groups: List[ResourceId] | None

is_blocked: bool | None

model_config: ClassVar[ConfigDict] = {'extra': 'allow', 'populate_by_name': True, 'use_enum_values': True, 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class netbird.models.user.UserInvite(**data)

User invite model.

id: ResourceId

email: str

name: str

role: UserRole

expires_at: str | None

token: str | None

invited_by: str | None

valid: bool | None

model_config: ClassVar[ConfigDict] = {'extra': 'allow', 'populate_by_name': True, 'use_enum_values': True, 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class netbird.models.user.UserInviteCreate(**data)

Model for creating a user invite.

email: str

name: str

role: UserRole

auto_groups: List[ResourceId]

expires_in: int | None

model_config: ClassVar[ConfigDict] = {'extra': 'allow', 'populate_by_name': True, 'use_enum_values': True, 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

Token Models

class netbird.models.token.Token(**data)

NetBird token model.

id

Unique token identifier

name

Token name

creation_date

When the token was created

expiration_date

When the token expires

created_by

User ID who created the token

last_used

When the token was last used

id: ResourceId

name: str

creation_date: datetime

expiration_date: datetime

created_by: ResourceId

last_used: datetime | None

model_config: ClassVar[ConfigDict] = {'extra': 'allow', 'populate_by_name': True, 'use_enum_values': True, 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class netbird.models.token.TokenCreate(**data)

Model for creating a new token.

name

Token name

expires_in

Token expiration in days (1-365)

expires_in must be between 1 and 365 days.

name: str

expires_in: int

model_config: ClassVar[ConfigDict] = {'extra': 'allow', 'populate_by_name': True, 'use_enum_values': True, 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

Peer Models

class netbird.models.peer.Peer(**data)

NetBird peer model.

id

Unique peer identifier

name

Peer name

ip

Peer IP address

connection_ip

Connection IP address

connected

Whether peer is connected

last_seen

Last seen timestamp

os

Operating system

version

NetBird version

groups

List of group objects with details

user_id

Associated user ID

hostname

Peer hostname

ui_version

UI version

dns_label

DNS label

ssh_enabled

Whether SSH is enabled

login_expiration_enabled

Whether login expiration is enabled

login_expired

Whether login has expired

approval_required

Whether approval is required

accessible_peers_count

Number of accessible peers

city_name

Geographic city name

country_code

Geographic country code

ephemeral

Whether peer is ephemeral

extra_dns_labels

Additional DNS labels

geoname_id

Geographic name ID

inactivity_expiration_enabled

Whether inactivity expiration is enabled

kernel_version

OS kernel version

last_login

Last login timestamp

serial_number

Device serial number

id: ResourceId

name: str

ip: IPvAnyAddress

connection_ip: str | None

connected: bool

last_seen: str | None

os: str | None

version: str | None

groups: List[Dict[str, Any]] | None

user_id: ResourceId | None

hostname: str | None

ui_version: str | None

dns_label: str | None

ssh_enabled: bool

login_expiration_enabled: bool

login_expired: bool

approval_required: bool

accessible_peers_count: int | None

city_name: str | None

country_code: str | None

ephemeral: bool | None

extra_dns_labels: List[str] | None

geoname_id: int | None

inactivity_expiration_enabled: bool | None

kernel_version: str | None

last_login: str | None

serial_number: str | None

model_config: ClassVar[ConfigDict] = {'extra': 'allow', 'populate_by_name': True, 'use_enum_values': True, 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class netbird.models.peer.PeerUpdate(**data)

Model for updating a peer.

name

Peer name

ssh_enabled

Whether SSH is enabled

login_expiration_enabled

Whether login expiration is enabled

inactivity_expiration_enabled

Whether inactivity expiration is enabled

approval_required

Whether approval is required (cloud-only)

name: str | None

ssh_enabled: bool | None

login_expiration_enabled: bool | None

inactivity_expiration_enabled: bool | None

approval_required: bool | None

ip: str | None

model_config: ClassVar[ConfigDict] = {'extra': 'allow', 'populate_by_name': True, 'use_enum_values': True, 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

Setup Key Models

class netbird.models.setup_key.SetupKey(**data)

NetBird setup key model.

id

Unique setup key identifier

key

The actual setup key value

name

Setup key name

expires

Expiration timestamp

type

Key type

valid

Whether the key is valid

revoked

Whether the key is revoked

used_times

Number of times the key has been used

last_used

When the key was last used

state

Key state

auto_groups

Auto-assigned group IDs

updated_at

Last update timestamp

usage_limit

Usage limit

ephemeral

Whether peers are ephemeral

allow_extra_dns_labels

Whether extra DNS labels are allowed

id: ResourceId

key: str

name: str

expires: str | None

type: SetupKeyType

valid: bool

revoked: bool

used_times: int

last_used: str | None

state: str

auto_groups: List[ResourceId] | None

updated_at: str | None

usage_limit: int | None

ephemeral: bool

allow_extra_dns_labels: bool | None

model_config: ClassVar[ConfigDict] = {'extra': 'allow', 'populate_by_name': True, 'use_enum_values': True, 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class netbird.models.setup_key.SetupKeyCreate(**data)

Model for creating a setup key.

name

Setup key name

type

Key type (reusable or one-off)

expires_in

Expiration time in seconds

auto_groups

Group IDs to auto-assign

usage_limit

Maximum number of uses

ephemeral

Whether peers using this key are ephemeral

allow_extra_dns_labels

Allow extra DNS labels

name: str

type: SetupKeyType

expires_in: int

auto_groups: List[ResourceId] | None

usage_limit: int | None

ephemeral: bool

allow_extra_dns_labels: bool

model_config: ClassVar[ConfigDict] = {'extra': 'allow', 'populate_by_name': True, 'use_enum_values': True, 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class netbird.models.setup_key.SetupKeyUpdate(**data)

Model for updating a setup key.

revoked

Whether the key is revoked

auto_groups

Group IDs to auto-assign

revoked: bool | None

auto_groups: List[ResourceId] | None

model_config: ClassVar[ConfigDict] = {'extra': 'allow', 'populate_by_name': True, 'use_enum_values': True, 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

Group Models

class netbird.models.group.Group(**data)

NetBird group model.

id

Unique group identifier

name

Group name

peers_count

Number of peers in group

peers

List of peer objects with details

resources

List of network resource objects

resources_count

Number of resources in group

issued

Creation timestamp

id: ResourceId

name: str

peers_count: int

peers: List[Dict[str, Any]] | None

resources: List[Dict[str, Any]] | None

resources_count: int | None

issued: str | None

model_config: ClassVar[ConfigDict] = {'extra': 'allow', 'populate_by_name': True, 'use_enum_values': True, 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class netbird.models.group.GroupCreate(**data)

Model for creating a group.

name

Group name

peers

List of peer IDs to include

resources

List of network resources

name: str

peers: List[ResourceId] | None

resources: List[Dict[str, Any]] | None

model_config: ClassVar[ConfigDict] = {'extra': 'allow', 'populate_by_name': True, 'use_enum_values': True, 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class netbird.models.group.GroupUpdate(**data)

Model for updating a group.

name

Group name

peers

List of peer IDs to include

resources

List of network resources

name: str | None

peers: List[ResourceId] | None

resources: List[Dict[str, Any]] | None

model_config: ClassVar[ConfigDict] = {'extra': 'allow', 'populate_by_name': True, 'use_enum_values': True, 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

Network Models

class netbird.models.network.Network(**data)

NetBird network model.

id

Unique network identifier

name

Network name

description

Network description

routers

List of router IDs

resources

List of resource IDs

policies

List of associated policy IDs

routing_peers_count

Number of routing peers

id: ResourceId

name: str

description: str | None

routers: List[str] | None

resources: List[str] | None

policies: List[ResourceId] | None

routing_peers_count: int | None

model_config: ClassVar[ConfigDict] = {'extra': 'allow', 'populate_by_name': True, 'use_enum_values': True, 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class netbird.models.network.NetworkCreate(**data)

Model for creating a network.

name

Network name

description

Network description

name: str

description: str | None

model_config: ClassVar[ConfigDict] = {'extra': 'allow', 'populate_by_name': True, 'use_enum_values': True, 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class netbird.models.network.NetworkUpdate(**data)

Model for updating a network.

name

Network name

description

Network description

name: str | None

description: str | None

model_config: ClassVar[ConfigDict] = {'extra': 'allow', 'populate_by_name': True, 'use_enum_values': True, 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class netbird.models.network.NetworkResource(**data)

Network resource model.

id

Resource identifier

name

Resource name

description

Resource description

address

Resource address

enabled

Whether resource is enabled

groups

Associated group IDs

id: ResourceId

name: str

description: str | None

address: str

enabled: bool

groups: List[ResourceId] | None

model_config: ClassVar[ConfigDict] = {'extra': 'allow', 'populate_by_name': True, 'use_enum_values': True, 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class netbird.models.network.NetworkRouter(**data)

Network router model.

id

Router identifier

name

Router name

description

Router description

peer

Associated peer ID

peer_groups

Associated peer group IDs

metric

Router metric

masquerade

Whether masquerading is enabled

enabled

Whether router is enabled

id: ResourceId

name: str

description: str | None

peer: ResourceId | None

peer_groups: List[ResourceId] | None

metric: int

masquerade: bool

enabled: bool

model_config: ClassVar[ConfigDict] = {'extra': 'allow', 'populate_by_name': True, 'use_enum_values': True, 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

Policy Models

class netbird.models.policy.Policy(**data)

NetBird policy model.

id

Unique policy identifier

name

Policy name

description

Policy description

enabled

Whether policy is enabled

source_posture_checks

Source posture check IDs

rules

List of policy rules

id: ResourceId

name: str

description: str | None

enabled: bool

source_posture_checks: List[ResourceId] | None

rules: List[PolicyRule]

model_config: ClassVar[ConfigDict] = {'extra': 'allow', 'populate_by_name': True, 'use_enum_values': True, 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class netbird.models.policy.PolicyCreate(**data)

Model for creating a policy.

name

Policy name

description

Policy description

enabled

Whether policy is enabled

source_posture_checks

Source posture check IDs

rules

List of policy rules

name: str

description: str | None

enabled: bool

source_posture_checks: List[ResourceId] | None

rules: List[PolicyRule]

model_config: ClassVar[ConfigDict] = {'extra': 'allow', 'populate_by_name': True, 'use_enum_values': True, 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class netbird.models.policy.PolicyRule(**data)

Policy rule model.

id

Rule identifier

name

Rule name

description

Rule description

enabled

Whether rule is enabled

action

Policy action (accept/drop)

protocol

Network protocol

ports

List of ports

sources

Source groups

destinations

Destination groups

bidirectional

Whether rule is bidirectional

id: ResourceId | None

name: str

description: str | None

enabled: bool

action: PolicyAction

protocol: Protocol

ports: List[str] | None

sources: List[str | Dict[str, Any]] | None

destinations: List[str | Dict[str, Any]] | None

bidirectional: bool

port_ranges: List[Dict[str, Any]] | None

authorized_groups: Dict[str, Any] | None

source_resource: Dict[str, Any] | None

destination_resource: Dict[str, Any] | None

model_config: ClassVar[ConfigDict] = {'extra': 'allow', 'populate_by_name': True, 'use_enum_values': True, 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class netbird.models.policy.PolicyUpdate(**data)

Model for updating a policy.

name

Policy name

description

Policy description

enabled

Whether policy is enabled

source_posture_checks

Source posture check IDs

rules

List of policy rules

name: str | None

description: str | None

enabled: bool | None

source_posture_checks: List[ResourceId] | None

rules: List[PolicyRule] | None

model_config: ClassVar[ConfigDict] = {'extra': 'allow', 'populate_by_name': True, 'use_enum_values': True, 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

Route Models

Deprecated since version Routes: are deprecated. Use Networks API instead.

class netbird.models.route.Route(**data)

NetBird route model.

id

Unique route identifier

description

Route description

network_id

Network identifier

enabled

Whether route is enabled

peer

Peer ID for the route

peer_groups

Peer group IDs for the route

network

Network address

network_type

Network type

domains

Domain list for domain routes

metric

Route metric

masquerade

Whether masquerading is enabled

groups

Group IDs that can access this route

keep_route

Whether to keep route on disconnect

access_control_groups

Access control group IDs

id: ResourceId

description: str | None

network_id: str

enabled: bool

peer: ResourceId | None

peer_groups: List[ResourceId] | None

network: str | None

network_type: NetworkType

domains: List[str] | None

metric: int

masquerade: bool

groups: List[ResourceId] | None

keep_route: bool

access_control_groups: List[ResourceId] | None

model_config: ClassVar[ConfigDict] = {'extra': 'allow', 'populate_by_name': True, 'use_enum_values': True, 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class netbird.models.route.RouteCreate(**data)

Model for creating a route.

description

Route description

network_id

Network identifier

enabled

Whether route is enabled

peer

Peer ID for the route

peer_groups

Peer group IDs for the route

network

Network address

network_type

Network type (ipv4, ipv6, domain)

domains

Domain list for domain routes

metric

Route metric

masquerade

Whether masquerading is enabled

groups

Group IDs that can access this route

keep_route

Whether to keep route on disconnect

access_control_groups

Access control group IDs

description: str | None

network_id: str

enabled: bool

peer: ResourceId | None

peer_groups: List[ResourceId] | None

network: str | None

network_type: NetworkType

domains: List[str] | None

metric: int

masquerade: bool

groups: List[ResourceId] | None

keep_route: bool

access_control_groups: List[ResourceId] | None

model_config: ClassVar[ConfigDict] = {'extra': 'allow', 'populate_by_name': True, 'use_enum_values': True, 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class netbird.models.route.RouteUpdate(**data)

Model for updating a route.

description

Route description

enabled

Whether route is enabled

peer

Peer ID for the route

peer_groups

Peer group IDs for the route

network

Network address

domains

Domain list for domain routes

metric

Route metric

masquerade

Whether masquerading is enabled

groups

Group IDs that can access this route

keep_route

Whether to keep route on disconnect

access_control_groups

Access control group IDs

description: str | None

enabled: bool | None

peer: ResourceId | None

peer_groups: List[ResourceId] | None

network: str | None

domains: List[str] | None

metric: int | None

masquerade: bool | None

groups: List[ResourceId] | None

keep_route: bool | None

access_control_groups: List[ResourceId] | None

model_config: ClassVar[ConfigDict] = {'extra': 'allow', 'populate_by_name': True, 'use_enum_values': True, 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

DNS Models

class netbird.models.dns.DNSNameserverGroup(**data)

DNS nameserver group model.

id

Unique nameserver group identifier

name

Nameserver group name

description

Nameserver group description

nameservers

List of nameserver IP addresses

enabled

Whether the nameserver group is enabled

groups

Group IDs that use this nameserver group

domains

Domain list for this nameserver group

search_domains_enabled

Whether search domains are enabled

id: ResourceId

name: str

description: str | None

nameservers: List[IPvAnyAddress]

enabled: bool

groups: List[ResourceId] | None

domains: List[str] | None

search_domains_enabled: bool

model_config: ClassVar[ConfigDict] = {'extra': 'allow', 'populate_by_name': True, 'use_enum_values': True, 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class netbird.models.dns.DNSSettings(**data)

DNS settings model.

disabled_management_groups

Groups with disabled DNS management

disabled_management_groups: List[ResourceId] | None

model_config: ClassVar[ConfigDict] = {'extra': 'allow', 'populate_by_name': True, 'use_enum_values': True, 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

DNS Zone Models

class netbird.models.dns_zone.DNSZone(**data)

NetBird DNS zone model.

id: ResourceId

name: str

domain: str

enabled: bool | None

enable_search_domain: bool | None

distribution_groups: List[str] | None

model_config: ClassVar[ConfigDict] = {'extra': 'allow', 'populate_by_name': True, 'use_enum_values': True, 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class netbird.models.dns_zone.DNSZoneCreate(**data)

Model for creating a DNS zone.

name: str

domain: str

enabled: bool | None

enable_search_domain: bool

distribution_groups: List[str]

model_config: ClassVar[ConfigDict] = {'extra': 'allow', 'populate_by_name': True, 'use_enum_values': True, 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class netbird.models.dns_zone.DNSZoneUpdate(**data)

Model for updating a DNS zone.

name: str | None

domain: str | None

enabled: bool | None

enable_search_domain: bool | None

distribution_groups: List[str] | None

model_config: ClassVar[ConfigDict] = {'extra': 'allow', 'populate_by_name': True, 'use_enum_values': True, 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class netbird.models.dns_zone.DNSRecord(**data)

NetBird DNS record model.

id: ResourceId

name: str

type: str

content: str

ttl: int

model_config: ClassVar[ConfigDict] = {'extra': 'allow', 'populate_by_name': True, 'use_enum_values': True, 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class netbird.models.dns_zone.DNSRecordCreate(**data)

Model for creating a DNS record.

name: str

type: str

content: str

ttl: int

model_config: ClassVar[ConfigDict] = {'extra': 'allow', 'populate_by_name': True, 'use_enum_values': True, 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class netbird.models.dns_zone.DNSRecordUpdate(**data)

Model for updating a DNS record.

name: str | None

type: str | None

content: str | None

ttl: int | None

model_config: ClassVar[ConfigDict] = {'extra': 'allow', 'populate_by_name': True, 'use_enum_values': True, 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

Event Models

class netbird.models.event.AuditEvent(**data)

Audit event model.

timestamp

Event timestamp

activity

Activity description

activity_code

Activity code

id

Event ID

initiator_id

ID of the initiator

initiator_email

Email of the initiator

initiator_name

Name of the initiator

target_id

ID of the target

meta

Additional event metadata

timestamp: str

activity: str

activity_code: str | None

id: str | None

initiator_id: ResourceId

initiator_email: str | None

initiator_name: str | None

target_id: ResourceId | None

meta: Dict[str, Any] | None

model_config: ClassVar[ConfigDict] = {'extra': 'allow', 'populate_by_name': True, 'use_enum_values': True, 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class netbird.models.event.NetworkTrafficEvent(**data)

Network traffic event model.

timestamp

Event timestamp

source_ip

Source IP address

destination_ip

Destination IP address

source_port

Source port

destination_port

Destination port

protocol

Network protocol

bytes_sent

Number of bytes sent

bytes_received

Number of bytes received

user_id

Associated user ID

peer_id

Associated peer ID

reporter_id

Reporter peer ID

policy_id

Applied policy ID

direction

Traffic direction

connection_type

Connection type (relay/p2p)

allowed

Whether traffic was allowed

timestamp: datetime

source_ip: IPvAnyAddress

destination_ip: IPvAnyAddress

source_port: int

destination_port: int

protocol: Protocol

bytes_sent: int

bytes_received: int

user_id: ResourceId | None

peer_id: ResourceId

reporter_id: ResourceId

policy_id: ResourceId | None

direction: TrafficDirection

connection_type: ConnectionType

allowed: bool

model_config: ClassVar[ConfigDict] = {'extra': 'allow', 'populate_by_name': True, 'use_enum_values': True, 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

Posture Check Models

class netbird.models.posture_check.PostureCheck(**data)

NetBird posture check model.

id: ResourceId

name: str

description: str | None

checks: Dict[str, Any] | None

model_config: ClassVar[ConfigDict] = {'extra': 'allow', 'populate_by_name': True, 'use_enum_values': True, 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class netbird.models.posture_check.PostureCheckCreate(**data)

Model for creating a posture check.

name: str

description: str

checks: Dict[str, Any] | None

model_config: ClassVar[ConfigDict] = {'extra': 'allow', 'populate_by_name': True, 'use_enum_values': True, 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class netbird.models.posture_check.PostureCheckUpdate(**data)

Model for updating a posture check.

name: str | None

description: str | None

checks: Dict[str, Any] | None

model_config: ClassVar[ConfigDict] = {'extra': 'allow', 'populate_by_name': True, 'use_enum_values': True, 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

Identity Provider Models

class netbird.models.identity_provider.IdentityProvider(**data)

NetBird identity provider model.

id: ResourceId

type: str

name: str

issuer: str | None

client_id: str | None

model_config: ClassVar[ConfigDict] = {'extra': 'allow', 'populate_by_name': True, 'use_enum_values': True, 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class netbird.models.identity_provider.IdentityProviderCreate(**data)

Model for creating an identity provider.

type: str

name: str

issuer: str

client_id: str

client_secret: str

model_config: ClassVar[ConfigDict] = {'extra': 'allow', 'populate_by_name': True, 'use_enum_values': True, 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class netbird.models.identity_provider.IdentityProviderUpdate(**data)

Model for updating an identity provider.

type: str | None

name: str | None

issuer: str | None

client_id: str | None

client_secret: str | None

model_config: ClassVar[ConfigDict] = {'extra': 'allow', 'populate_by_name': True, 'use_enum_values': True, 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

Job Models

class netbird.models.job.Job(**data)

NetBird job model.

id: ResourceId

workload: Dict[str, Any] | None

status: str | None

model_config: ClassVar[ConfigDict] = {'extra': 'allow', 'populate_by_name': True, 'use_enum_values': True, 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class netbird.models.job.JobCreate(**data)

Model for creating a job.

workload: Dict[str, Any]

model_config: ClassVar[ConfigDict] = {'extra': 'allow', 'populate_by_name': True, 'use_enum_values': True, 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

Type Aliases

• ResourceId - String type for resource identifiers

• Timestamp - Datetime type for timestamps