VPN Connection

Site-to-site VPN connections between a VPN gateway and a customer gateway.

Resource base path: /restapi/vpnconnection

Method	Path	Description
POST	/restapi/vpnconnection/addVpnConnection	Add VPN Connection
GET	/restapi/vpnconnection/vpnConnectionList	VPN Connection List
PUT	/restapi/vpnconnection/resetVpnConnection/{uuid}	Reset VPN Connection
DELETE	/restapi/vpnconnection/deleteVpnConnection/{uuid}	Delete VPN Connection

note

apikey and secretkey are required HTTP headers on every request and are omitted from the parameter tables below. See Authentication.

---

Add VPN Connection

Add VPN Connection.

POST /restapi/vpnconnection/addVpnConnection

Request body

Field	Type	Required	Description
vpcUuid	string	No	UUID of the VPC.
passive	boolean	No
customerGatewayUuid	string	No	UUID of the VPN customer gateway.

{
  "vpcUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "passive": true,
  "customerGatewayUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}

Example request

curl -X POST \
  "https://portal.your-domain.com/restapi/vpnconnection/addVpnConnection" \
  -H "apikey: YOUR_API_KEY" \
  -H "secretkey: YOUR_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "vpcUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "passive": true,
  "customerGatewayUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}'

Responses

Code	Description
200	Successful operation.
401	Invalid authentication credentials.
550	Permission denied.

{
  "count": 1,
  "listVpnConnectionResponse": [
    {
      "ikePolicy": "string",
      "publicIpAddress": "string",
      "espPolicy": "string",
      "ipsecPresharedKey": "string",
      "zoneUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "isActive": true,
      "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "customerGatewayUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "vpnGatewayUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "state": "Running",
      "vpcUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "gateway": "string",
      "status": "Active"
    }
  ]
}

---

VPN Connection List

VPN Connection List.

GET /restapi/vpnconnection/vpnConnectionList

Parameters

Parameter	In	Type	Required	Description
zoneUuid	query	string	✅ Yes	UUID of the zone the resource belongs to.
uuid	query	string	No	UUID of the resource.
vpcUuid	query	string	No	UUID of the VPC.

Example request

curl -X GET \
  "https://portal.your-domain.com/restapi/vpnconnection/vpnConnectionList?zoneUuid=a1b2c3d4-e5f6-7890-abcd-ef1234567890" \
  -H "apikey: YOUR_API_KEY" \
  -H "secretkey: YOUR_SECRET_KEY"

Responses

Code	Description
200	Successful operation.
401	Invalid authentication credentials.
550	Permission denied.

{
  "count": 1,
  "listVpnConnectionResponse": [
    {
      "ikePolicy": "string",
      "publicIpAddress": "string",
      "espPolicy": "string",
      "ipsecPresharedKey": "string",
      "zoneUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "isActive": true,
      "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "customerGatewayUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "vpnGatewayUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "state": "Running",
      "vpcUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "gateway": "string",
      "status": "Active"
    }
  ]
}

---

Reset VPN Connection

Reset VPN Connection.

PUT /restapi/vpnconnection/resetVpnConnection/{uuid}

Parameters

Parameter	In	Type	Required	Description
uuid	path	string	✅ Yes	UUID of the resource.

Example request

curl -X PUT \
  "https://portal.your-domain.com/restapi/vpnconnection/resetVpnConnection/a1b2c3d4-e5f6-7890-abcd-ef1234567890" \
  -H "apikey: YOUR_API_KEY" \
  -H "secretkey: YOUR_SECRET_KEY"

Responses

Code	Description
200	Successful operation.
401	Invalid authentication credentials.
550	Permission denied.

{
  "count": 1,
  "listVpnConnectionResponse": [
    {
      "ikePolicy": "string",
      "publicIpAddress": "string",
      "espPolicy": "string",
      "ipsecPresharedKey": "string",
      "zoneUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "isActive": true,
      "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "customerGatewayUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "vpnGatewayUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "state": "Running",
      "vpcUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "gateway": "string",
      "status": "Active"
    }
  ]
}

---

Delete VPN Connection

Delete VPN Connection.

DELETE /restapi/vpnconnection/deleteVpnConnection/{uuid}

Parameters

Parameter	In	Type	Required	Description
uuid	path	string	✅ Yes	UUID of the resource.

Example request

curl -X DELETE \
  "https://portal.your-domain.com/restapi/vpnconnection/deleteVpnConnection/a1b2c3d4-e5f6-7890-abcd-ef1234567890" \
  -H "apikey: YOUR_API_KEY" \
  -H "secretkey: YOUR_SECRET_KEY"

Responses

Code	Description
200	Successful operation.
401	Invalid authentication credentials.
550	Permission denied.

true