Create IPSec Gateway

The full IPSec Gateway needs to be provided to create the object. Optional data will be filled with defaults or left empty.

To create a IPSec Gateway, perform a POST request.

Endpoint

Use a region-specific endpoint to create IPSec Gateway: https://vpn.{region}.ionos.com/ipsecgateways.

Request

curl --location \
--request POST 'https://vpn.de-fra.ionos.com/ipsecgateways' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJraWQiO' \
--header 'Content-Type: application/json' \
--data-raw '{
  "metadata": {},
  "properties": {
    "name": "My Company Gateway",
    "description": "This gateway connects site A to VDC X.",
    "gatewayIP": "81.173.1.2",
    "connections": [
      {
        "datacenterId": "5a029f4a-72e5-11ec-90d6-0242ac120003",
        "lanId": "2",
        "ipv4CIDR": "192.168.1.100/24",
        "ipv6CIDR": "fd28:5f8d:d9fe:08bd::/64"
      }
    ],
    "version": "IKEv2",
    "tier": "STANDARD",
    "maintenanceWindow": {
      "time": "16:30:59",
      "dayOfTheWeek": "Monday"
    }
  }
}'

Request Body Parameters

Below is the list of mandatory body parameters for creating an IPSec Gateway:

Body Parameters	Required	Type	Description	Example
metadata	no	object	Metadata	{}
properties	yes	object	Properties with all data needed to create a new 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

Request Header Parameters

To make authenticated requests to the API, the following fields are mandatory in the request header:

Header Parameters	Required	Type	Description
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.

Response

201 Successful operation

{
  "id": "66a114c7-2ddd-5119-9ddf-5a789f5a5a44",
  "type": "ipsecgateway",
  "href": "/ipsecgateways/66a114c7-2ddd-5119-9ddf-5a789f5a5a44",
  "metadata": {
    "createdDate": "2020-12-10T13:37:50+01:00",
    "createdBy": "ionos:identity:::users/87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
    "createdByUserId": "87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
    "lastModifiedDate": "2020-12-11T13:37:50+01:00",
    "lastModifiedBy": "ionos:identity:::users/87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
    "lastModifiedByUserId": "87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
    "resourceURN": "ionos:<product>:<location>:<contract>:<resource-path>",
    "status": "AVAILABLE",
    "statusMessage": null
  },
  "properties": {
    "name": "My Company Gateway",
    "description": "This gateway connects site A to VDC X.",
    "gatewayIP": "81.173.1.2",
    "connections": [
      {
        "datacenterId": "5a029f4a-72e5-11ec-90d6-0242ac120003",
        "lanId": "2",
        "ipv4CIDR": "192.168.1.100/24",
        "ipv6CIDR": "fd28:5f8d:d9fe:08bd::/64"
      }
    ],
    "version": "IKEv2",
    "tier": "STANDARD",
    "maintenanceWindow": {
      "time": "16:30:59",
      "dayOfTheWeek": "Monday"
    }
  }
}

Result: The IPSec Gateway is successfully created. the id and other details of the created IPSec Gateway are provided in the response.