How do I document VPN connections?

Requires Basic

Quick answer

In the Network module, switch to the VPN tab and add a VPN tunnel. Only the name is required. Optionally, you can document the type (e.g. IPSec, WireGuard, OpenVPN), the peer address, a tunnel group, and a description.

Prerequisites

Included in all plans from Basic onward.

Open the “VPN” tab. Choose Network, then the VPN tab. Click Add.

Screenshot pending netzwerk-vpn-01 The 'VPN' tab in the Network module with the form for a new VPN tunnel

The 'VPN' tab — this is where you document tunnels and tunnel groups.
Fill in the tunnel.
- Name — e.g. “Site link Berlin ↔ Munich”
- Type (optional) — free text, e.g. IPSec, WireGuard, OpenVPN
- Peer address (optional) — the remote endpoint, e.g. 203.0.113.7
- Tunnel group (optional) — choose an existing group
- Description (optional)
To bundle tunnels, first create a tunnel group via Add (only a name is required).
Save. The tunnel appears in the list, sorted by name.

Via the REST API: a POST to /api/v1/network/vpn. Only name is required.

curl -X POST https://demo.notory.io/api/v1/network/vpn \
  -H "Authorization: Bearer inv_dein_token" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Standort-Kopplung Berlin-Muenchen",
    "vpn_type": "IPSec",
    "peer_address": "203.0.113.7",
    "description": "Site-to-Site zwischen den Standorten"
  }'

{
  "id": "0190f3a2-a055-7fcd-d4e6-5a8b9c0d1e24",
  "tenant_id": "3d9b0c12-4e5a-4f88-b1c7-2a9e6d4f0011",
  "name": "Standort-Kopplung Berlin-Muenchen",
  "vpn_type": "IPSec",
  "peer_address": "203.0.113.7",
  "group_id": null,
  "description": "Site-to-Site zwischen den Standorten",
  "created_at": "2026-07-08T09:40:00Z",
  "updated_at": "2026-07-08T09:40:00Z"
}

You create a tunnel group separately (POST /api/v1/network/vpn-groups, name required) and reference its id via group_id.

Possible errors: 401, 403 (permissions/role), 422 (empty name).

What happens behind the scenes?

Tenant assignment: The tunnel and the tunnel group belong to your current tenant.
Type is free text: The type field isn’t restricted to fixed values — enter whatever designation is customary in your environment.
Group reference: If the linked tunnel group is deleted, Notory sets group_id to null (SET NULL); the tunnel remains.
Documentation only: No VPN connections are actually established or monitored — the entries exist purely to document your VPN landscape.