GET
Get a VPC 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

gateway_uuid
string
required

Gateway UUID

Response

Get a VPC 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

organization
string
required

Cloudflare Zero Trust organization (team name) the gateway enrolls into. Null unless the kind is cloudflare. The client secret and the Tailscale auth key are never returned

client_id
string
required

Cloudflare service token client ID. Null unless the kind is cloudflare. The client secret is never returned

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