POST
Add a VPN device

Authorizations

Authorization
string
header
required

Bearer token for authentication. Format: 'Bearer {token}'

Headers

X-Workspace-Id
string

Workspace ID (uses default workspace if not provided)

Path Parameters

uuid
string
required

VPC UUID

Body

application/json

Add a VPN device

name
string
required

Device name, unique within the gateway. Lowercase letters, numbers and hyphens, 2 to 30 characters. This is the name the daemon identifies the peer by.

Response

Add a VPN device

Api_V1_Entities_VpnUser model

uuid
string
required

Unique device identifier

name
string
required

Device name, unique within the gateway

status
string
required

Current status (pending, active, failed)

public_key
string
required

The device's WireGuard public key. The private half is never stored and is returned only once, by the config endpoint

allocated_v4
string
required

Address the device answers to inside the VPC, allocated from the VPN pool

config_available
boolean
required

Whether the configuration can still be downloaded. It can be read exactly once, and reading it empties the vault

created_at
string<date-time>
required

Creation timestamp