VPN Gateway

Site-to-site VPN gateways created on a VPC.

Resource base path: /restapi/vpngateway

Method	Path	Description
POST	/restapi/vpngateway/addVpnGateway	Add VPN Gateway
GET	/restapi/vpngateway/vpnGatewayList	VPN Gateway List
DELETE	/restapi/vpngateway/deleteVpnGateway/{uuid}	Delete VPN Gateway

note

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

---

Add VPN Gateway

Add VPN Gateway.

POST /restapi/vpngateway/addVpnGateway

Request body

Field	Type	Required	Description
vpcUuid	string	No	UUID of the VPC.

{
  "vpcUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}

Example request

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

Responses

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

{
  "count": 1,
  "listVpnGatewayResponse": [
    {
      "publicIpAddress": "string",
      "domainName": "example-name",
      "zoneUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "isActive": true,
      "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "vpcUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "status": "Active"
    }
  ]
}

---

VPN Gateway List

VPN Gateway List.

GET /restapi/vpngateway/vpnGatewayList

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/vpngateway/vpnGatewayList?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,
  "listVpnGatewayResponse": [
    {
      "publicIpAddress": "string",
      "domainName": "example-name",
      "zoneUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "isActive": true,
      "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "vpcUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "status": "Active"
    }
  ]
}

---

Delete VPN Gateway

Delete VPN Gateway.

DELETE /restapi/vpngateway/deleteVpnGateway/{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/vpngateway/deleteVpnGateway/a1b2c3d4-e5f6-7890-abcd-ef1234567890" \
  -H "apikey: YOUR_API_KEY" \
  -H "secretkey: YOUR_SECRET_KEY"

Responses

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

true