Ensures that the IPSecGateway with the provided ID is created or modified. The full IPSecGateway needs to be provided to ensure (either update or create) the IPSecGateway. Non present data will only be filled with defaults or left empty, but not take previous values into consideration.
To ensure that the IPSecGateway with the provided ID is created or modified, perform PUT request.
Note: If IPSecGateway for a given gatewayId does not exist, a new one is created instead.
Use the following endpoint to ensure IPSecGateway is created or modified: https://vpn.de-fra.ionos.com/ipsecgateways/{gatewayId}.
Note: The following request contains a sample gatewayId. Replace them with the gatewayId value whose information you want to update.
Below is the list of mandatory path parameters for updating an IPSecGateway:
Below is the list of mandatory body parameters for updating an IPSecGateway:
To make authenticated requests to the API, the following fields are mandatory in the request header:
200 Successful operation
Result: The IPSec Gateway is successfully updated or created.
| Path Parameters | Type | Description | Example |
|---|---|---|---|
| Body Parameters | Required | Type | Description | Example |
|---|---|---|---|---|
| Header Parameters | Required | Type | Description |
|---|---|---|---|
gatewayId
string
The ID (UUID) of the IPSecGateway.
66a114c7-2ddd-5119-9ddf-5a789f5a5a44
id
yes
string
The ID (UUID) of the IPSec Gateway.
66a114c7-2ddd-5119-9ddf-5a789f5a5a44
metadata
no
object
Metadata
{}
properties
yes
object
Properties with all data needed to update the IPSec Gateway.
properties.name
yes
string
The human readable name of your IPSec Gateway.
My Company IPSec Gateway
properties.description
no
string
Human readable description of the IPSec Gateway.
This gateway connects site A to VDC X.
properties.gatewayIP
yes
string
Public IP address to be assigned to the gateway.
192.0.2.0
properties.connections
yes
array
The network connection for your gateway.
[ { "datacenterId": "5a029f4a-72e5-11ec-90d6-0242ac120003", "lanId": "2", "ipv4CIDR": "192.168.1.100/24", "ipv6CIDR": "2001:0db8:85a3::/24" } ]
properties.version
no
string
The IKE version that is permitted for the VPN tunnels. Default: "IKEv2".
IKEv2
Authorization
yes
string
The Bearer token enables requests to authenticate using a JSON Web Token (JWT).
Content-Type
yes
string
Set this to application/json.