POST
Enable a VPN gateway

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

Enable a VPN gateway

kind
enum<string>
required

Terminator to enable: wireguard, cloudflare or tailscale

Available options:
wireguard,
cloudflare,
tailscale
organization
string

Cloudflare Zero Trust team name. Required for cloudflare.

client_id
string

Cloudflare service token client ID. Required for cloudflare.

client_secret
string

Cloudflare service token secret. Stored encrypted and never returned. Required for cloudflare.

auth_key
string

Tailscale auth key. Stored encrypted and never returned. Required for tailscale.

Response

Enable a VPN gateway

Api_V1_Entities_VpnGateway model

uuid
string
required

Unique gateway identifier

kind
string
required

Terminator: wireguard, tailscale, cloudflare or ipsec

status
string
required

Current status (pending, active, failed, disabling)

endpoint
string
required

Address clients dial, once the platform has allocated one. Null for the terminators that dial out instead

external_port
integer<int32>
required

Port on that address, for WireGuard

public_ip
string
required

Public IPv4 held exclusively by this gateway. Only IPsec takes one

vpn_user_count
integer<int32>
required

Devices registered against this gateway

site_connection_count
integer<int32>
required

Site-to-site tunnels terminating on it

created_at
string<date-time>
required

Creation timestamp