IP Address

Public IP addresses that can be acquired, released, and used for static NAT and remote VPN access.

Resource base path: /restapi/ipaddress

Method	Path	Description
`GET`	`/restapi/ipaddress/acquireIpAddress`	Acquire IP Address
`GET`	`/restapi/ipaddress/ipAddressList`	IP Address List
`DELETE`	`/restapi/ipaddress/releaseIpAddress`	Release IP Address
`POST`	`/restapi/ipaddress/enableStaticNat`	Enable Static NAT
`DELETE`	`/restapi/ipaddress/disableStaticNat`	Disable Static NAT
`GET`	`/restapi/ipaddress/enableremotevpnaccess`	Enable Remote VPN Access
`DELETE`	`/restapi/ipaddress/disableremotevpnaccess`	Disable Remote VPN Access

note

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

Acquire IP Address

Acquire IP Address.

GET /restapi/ipaddress/acquireIpAddress

Parameters

Parameter	In	Type	Required	Description
`networkUuid`	query	string	✅ Yes	UUID of the network.
`networkType`	query	string	✅ Yes	networkType (NETWORK, VPC).

Example request

curl -X GET \
  "https://portal.your-domain.com/restapi/ipaddress/acquireIpAddress?networkUuid=a1b2c3d4-e5f6-7890-abcd-ef1234567890&networkType=VALUE" \
  -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,
  "listIpAddressResponse": [
    {
      "publicIpAddress": "string",
      "zoneUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "zoneName": "example-name",
      "state": "Running",
      "isActive": true,
      "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "networkUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "isSourcenat": true,
      "status": "Active"
    }
  ]
}

IP Address List

IP Address List.

GET /restapi/ipaddress/ipAddressList

Parameters

Parameter	In	Type	Required	Description
`zoneUuid`	query	string	✅ Yes	UUID of the zone the resource belongs to.
`networkUuid`	query	string	No	UUID of the network.

Example request

curl -X GET \
  "https://portal.your-domain.com/restapi/ipaddress/ipAddressList?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,
  "listIpAddressResponse": [
    {
      "publicIpAddress": "string",
      "zoneUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "zoneName": "example-name",
      "state": "Running",
      "isActive": true,
      "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "networkUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "isSourcenat": true,
      "status": "Active"
    }
  ]
}

Release IP Address

Release IP Address.

DELETE /restapi/ipaddress/releaseIpAddress

Parameters

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

Example request

curl -X DELETE \
  "https://portal.your-domain.com/restapi/ipaddress/releaseIpAddress?uuid=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

Enable Static NAT

Enable Static NAT.

POST /restapi/ipaddress/enableStaticNat

Request body

Field	Type	Required	Description
`ipAddressUuid`	string	No	UUID of the public IP address.
`vmUuid`	string	No	UUID of the virtual-machine instance.
`networkUuid`	string	No	UUID of the network.

{
  "ipAddressUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "vmUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "networkUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}

Example request

curl -X POST \
  "https://portal.your-domain.com/restapi/ipaddress/enableStaticNat" \
  -H "apikey: YOUR_API_KEY" \
  -H "secretkey: YOUR_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "ipAddressUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "vmUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "networkUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}'

Responses

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

{
  "count": 1,
  "kongAttachStaticNatResponse": [
    {
      "ipAddressUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "vmName": "example-name",
      "vmUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "isActive": true,
      "networkUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "status": "Active"
    }
  ]
}

Disable Static NAT

Disable Static NAT.

DELETE /restapi/ipaddress/disableStaticNat

Parameters

Parameter	In	Type	Required	Description
`ipAddressUuid`	query	string	✅ Yes	UUID of the public IP address.

Example request

curl -X DELETE \
  "https://portal.your-domain.com/restapi/ipaddress/disableStaticNat?ipAddressUuid=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

Enable Remote VPN Access

Enable Remote VPN Access.

GET /restapi/ipaddress/enableremotevpnaccess

Parameters

Parameter	In	Type	Required	Description
`ipAddressUuid`	query	string	✅ Yes	UUID of the public IP address.

Example request

curl -X GET \
  "https://portal.your-domain.com/restapi/ipaddress/enableremotevpnaccess?ipAddressUuid=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,
  "listIpAddressResponse": [
    {
      "publicIpAddress": "string",
      "zoneUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "zoneName": "example-name",
      "state": "Running",
      "isActive": true,
      "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "networkUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "isSourcenat": true,
      "status": "Active"
    }
  ]
}

Disable Remote VPN Access

Disable Remote VPN Access.

DELETE /restapi/ipaddress/disableremotevpnaccess

Parameters

Parameter	In	Type	Required	Description
`ipAddressUuid`	query	string	✅ Yes	UUID of the public IP address.

Example request

curl -X DELETE \
  "https://portal.your-domain.com/restapi/ipaddress/disableremotevpnaccess?ipAddressUuid=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,
  "listIpAddressResponse": [
    {
      "publicIpAddress": "string",
      "zoneUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "zoneName": "example-name",
      "state": "Running",
      "isActive": true,
      "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "networkUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "isSourcenat": true,
      "status": "Active"
    }
  ]
}

Acquire IP Address​

Parameters​

Example request​

Responses​

IP Address List​

Parameters​

Example request​

Responses​

Release IP Address​

Parameters​

Example request​

Responses​

Enable Static NAT​

Request body​

Example request​

Responses​

Disable Static NAT​

Parameters​

Example request​

Responses​

Enable Remote VPN Access​

Parameters​

Example request​

Responses​

Disable Remote VPN Access​

Parameters​

Example request​

Responses​

Acquire IP Address

Parameters

Example request

Responses

IP Address List

Parameters

Example request

Responses

Release IP Address

Parameters

Example request

Responses

Enable Static NAT

Request body

Example request

Responses

Disable Static NAT

Parameters

Example request

Responses

Enable Remote VPN Access

Parameters

Example request

Responses

Disable Remote VPN Access

Parameters

Example request

Responses