TunnelGroup

TunnelGroup

A logical group of VPN tunnels.

API Endpoint

/api/vpn/tunnel-groups/

Identifier

name - Unique name.

Properties

Property	Type	Required	Description
name	string	Yes	Unique name.
slug	string	No	URL-friendly identifier (auto-generated from name if omitted, e.g. 'my-datacenter').
description	string	No	A brief description.
comments	string	No	Free-text comments (markdown supported).

Output Properties

Property	Type	Description
id	string	NetBox internal ID (read-only, returned after create/update).
url	string	API URL for this resource.
display	string	Display name.

Bicep Example

resource siteToSiteTunnels 'TunnelGroup' = {
  name: 'Site-to-Site VPNs'
  description: 'IPSec tunnels between datacenter sites'
}