API How-Tos

API Privileges

Set API Privileges

Learn how to set user privileges for VPN Gateway via the API.

WireGuard Gateways

Retrieve all WireGuard Gateways

Endpoint to retrieve all WireGuard VPN Gateways using pagination and optional filters.

Create WireGuard Gateway

Creates a new WireGuard VPN Gateway. The full configuration needs to be provided.

Retrieve WireGuard Gateway

Retrieves details of a specific WireGuard VPN Gateway.

Update WireGuard Gateway

Ensures that a WireGuard VPN Gateway with the provided ID is created or modified.

Delete WireGuard Gateway

Deletes the specified WireGuard Gateway.

WireGuard Peers

Retrieve all WireGuard Peers

Endpoint to retrieve all WireGuard Peers associated with a VPN Gateway using pagination and optional filters.

Create WireGuard Peer

Creates a new WireGuard Peer. The full configuration needs to be provided.

Retrieve WireGuard Peer

Retrieves details of a specific WireGuard Peer.

Update WireGuard Peer

Ensures that a WireGuard Peer with the provided ID is created or modified.

Delete WireGuard Peer

Deletes the specified WireGuard Peer.

IPSec Gateways

Retrieve all IPSec Gateways

Endpoint to retrieve all IPSec VPN Gateways using pagination and optional filters.

Create IPSec Gateway

Creates a new IPSec VPN Gateway. The full configuration needs to be provided.

Retrieve IPSec Gateway

Retrieves details of a specific IPSec VPN Gateway.

Update IPSec Gateway

Ensures that an IPSec VPN Gateway with the provided ID is created or modified.

Delete IPSec Gateway

Deletes the specified IPSec Gateway.

IPSec Tunnels

Retrieve all IPSec Tunnels

Endpoint to retrieve all IPSec VPN Tunnels associated with an IPSec VPN Gateway using pagination and optional filters.

Create IPSec Tunnel

Creates a new IPSec VPN Tunnel associated with an IPSec VPN Gateway. The full configuration needs to be provided.

Retrieve IPSec Tunnel

Retrieves details of a specific IPSec VPN Tunnel.

Update IPSec Tunnel

Ensures that an IPSec VPN Tunnel with the provided ID is created or modified.

Delete IPSec Tunnel

Deletes the specified IPSec Tunnel.

Endpoints

A regional endpoint is necessary to interact with the VPN Gateway REST API endpoints. For more information, see the API specification file.

Note: To prevent any failed requests, make sure to use the regional endpoint that corresponds to the location of the VDC where your VPN Gateway has been established.

IONOS supports the following endpoints for various locations:

• Berlin, Germany: https://vpn.de-txl.ionos.com/clusters

• Frankfurt, Germany: https://vpn.de-fra.ionos.com/clusters

• Logroño, Spain: https://vpn.es-vit.ionos.com/clusters

• London, Great Britain: https://vpn.gb-lhr.ionos.com/clusters

• Newark, United States: https://vpn.us-ewr.ionos.com/clusters

• Las Vegas, United States: https://vpn.us-las.ionos.com/clusters

• Lenexa, United States: https://vpn.us-mci.ionos.com/clusters

• Paris, France: https://vpn.fr-par.ionos.com/clusters