API referenceNetworkingVpn gateways
Download the VPN client profile
Requires the vpn_gateways:read permission.
Renders the client-side configuration for the gateway's protocol: a ready wg0.conf (wireguard, includes the generated client keypair), a client.ovpn with the shared static key (openvpn), or IKEv2 connection details + PSK.
AuthorizationBearer <token>
An access token from this zone's POST /oauth/token, or a session token from POST /api/v1/auth/login. Send it as Authorization: Bearer <token>.
In: header
Path Parameters
id*string
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/api/v1/vpn-gateways/string/config"{ "config": "string", "filename": "string", "protocol": "string"}