Network

Guest networks that instances attach to.

Resource base path: /restapi/network

Method	Path	Description
`POST`	`/restapi/network/createNetwork`	Create Network
`GET`	`/restapi/network/networkList`	Network List
`GET`	`/restapi/network/networkId`	Read Network
`PUT`	`/restapi/network/updateNetwork`	Update Network
`GET`	`/restapi/network/restartNetwork`	Restart Network
`GET`	`/restapi/network/replaceAcl`	Replace Network ACL
`GET`	`/restapi/network/changeSecurityGroup`	Change Network Security Group
`DELETE`	`/restapi/network/deleteNetwork/{uuid}`	Delete Network

note

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

Create Network

Create Network.

POST /restapi/network/createNetwork

Parameters

Parameter	In	Type	Required	Description
`isPublic`	query	boolean	No
`securityGroupUuid`	query	string	No	UUID of the security group.

Request body

Field	Type	Required	Description
`name`	string	No	Name of the resource.
`zoneUuid`	string	No	UUID of the zone the resource belongs to.
`virtualmachineUuid`	string	No	UUID of the virtual-machine instance.
`networkOfferingUuid`	string	No	UUID of the network offering.

{
  "name": "example-name",
  "zoneUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "virtualmachineUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "networkOfferingUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}

Example request

curl -X POST \
  "https://portal.your-domain.com/restapi/network/createNetwork" \
  -H "apikey: YOUR_API_KEY" \
  -H "secretkey: YOUR_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "example-name",
  "zoneUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "virtualmachineUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "networkOfferingUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}'

Responses

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

{
  "listNetworkResponse": [
    {
      "cleanUpNetwork": true,
      "getcIDR": "0.0.0.0/0",
      "zoneUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "networkOfferingUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "isActive": true,
      "networkAclList": "string",
      "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "domainName": "example-name",
      "name": "example-name",
      "networkType": "string",
      "gateway": "string",
      "networkDomain": "string",
      "status": "Active"
    }
  ],
  "count": 1
}

Network List

Network List.

GET /restapi/network/networkList

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.

Example request

curl -X GET \
  "https://portal.your-domain.com/restapi/network/networkList?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.

{
  "listNetworkResponse": [
    {
      "cleanUpNetwork": true,
      "getcIDR": "0.0.0.0/0",
      "zoneUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "networkOfferingUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "isActive": true,
      "networkAclList": "string",
      "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "domainName": "example-name",
      "name": "example-name",
      "networkType": "string",
      "gateway": "string",
      "networkDomain": "string",
      "status": "Active"
    }
  ],
  "count": 1
}

Read Network

Read a single network by UUID.

GET /restapi/network/networkId

Parameters

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

Example request

curl -X GET \
  "https://portal.your-domain.com/restapi/network/networkId?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.

{
  "listNetworkResponse": [
    {
      "cleanUpNetwork": true,
      "getcIDR": "0.0.0.0/0",
      "zoneUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "networkOfferingUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "isActive": true,
      "networkAclList": "string",
      "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "domainName": "example-name",
      "name": "example-name",
      "networkType": "string",
      "gateway": "string",
      "networkDomain": "string",
      "status": "Active"
    }
  ],
  "count": 1
}

Update Network

Update Network.

PUT /restapi/network/updateNetwork

Request body

Field	Type	Required	Description
`getcIDR`	string	No
`name`	string	No	Name of the resource.
`description`	string	No	Human-readable description.
`uuid`	string	No	UUID of the resource.
`networkDomain`	string	No

{
  "getcIDR": "0.0.0.0/0",
  "name": "example-name",
  "description": "string",
  "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "networkDomain": "string"
}

Example request

curl -X PUT \
  "https://portal.your-domain.com/restapi/network/updateNetwork" \
  -H "apikey: YOUR_API_KEY" \
  -H "secretkey: YOUR_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "getcIDR": "0.0.0.0/0",
  "name": "example-name",
  "description": "string",
  "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "networkDomain": "string"
}'

Responses

Code	Description
`200`	Successful operation.
`202`	Accepted — processed asynchronously (poll via the Resource API Status endpoint).
`401`	Invalid authentication credentials.
`550`	Permission denied.

{
  "listNetworkResponse": [
    {
      "cleanUpNetwork": true,
      "getcIDR": "0.0.0.0/0",
      "zoneUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "networkOfferingUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "isActive": true,
      "networkAclList": "string",
      "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "domainName": "example-name",
      "name": "example-name",
      "networkType": "string",
      "gateway": "string",
      "networkDomain": "string",
      "status": "Active"
    }
  ],
  "count": 1
}

Restart Network

Restart Network.

GET /restapi/network/restartNetwork

Parameters

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

Example request

curl -X GET \
  "https://portal.your-domain.com/restapi/network/restartNetwork?uuid=a1b2c3d4-e5f6-7890-abcd-ef1234567890&cleanUpNetwork=VALUE" \
  -H "apikey: YOUR_API_KEY" \
  -H "secretkey: YOUR_SECRET_KEY"

Responses

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

{
  "listNetworkResponse": [
    {
      "cleanUpNetwork": true,
      "getcIDR": "0.0.0.0/0",
      "zoneUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "networkOfferingUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "isActive": true,
      "networkAclList": "string",
      "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "domainName": "example-name",
      "name": "example-name",
      "networkType": "string",
      "gateway": "string",
      "networkDomain": "string",
      "status": "Active"
    }
  ],
  "count": 1
}

Replace Network ACL

Replace Network ACL.

GET /restapi/network/replaceAcl

Parameters

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

Example request

curl -X GET \
  "https://portal.your-domain.com/restapi/network/replaceAcl?uuid=a1b2c3d4-e5f6-7890-abcd-ef1234567890&aclUuid=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.

{
  "listNetworkResponse": [
    {
      "cleanUpNetwork": true,
      "getcIDR": "0.0.0.0/0",
      "zoneUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "networkOfferingUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "isActive": true,
      "networkAclList": "string",
      "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "domainName": "example-name",
      "name": "example-name",
      "networkType": "string",
      "gateway": "string",
      "networkDomain": "string",
      "status": "Active"
    }
  ],
  "count": 1
}

Change Network Security Group

Change Network Security Group.

GET /restapi/network/changeSecurityGroup

Parameters

Parameter	In	Type	Required	Description
`uuid`	query	string	✅ Yes	UUID of the resource.
`securityGroupId`	query	integer (int64)	✅ Yes

Example request

curl -X GET \
  "https://portal.your-domain.com/restapi/network/changeSecurityGroup?uuid=a1b2c3d4-e5f6-7890-abcd-ef1234567890&securityGroupId=VALUE" \
  -H "apikey: YOUR_API_KEY" \
  -H "secretkey: YOUR_SECRET_KEY"

Responses

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

{
  "listNetworkResponse": [
    {
      "cleanUpNetwork": true,
      "getcIDR": "0.0.0.0/0",
      "zoneUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "networkOfferingUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "isActive": true,
      "networkAclList": "string",
      "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "domainName": "example-name",
      "name": "example-name",
      "networkType": "string",
      "gateway": "string",
      "networkDomain": "string",
      "status": "Active"
    }
  ],
  "count": 1
}

Delete Network

Delete Network.

DELETE /restapi/network/deleteNetwork/{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/network/deleteNetwork/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

Create Network​

Parameters​

Request body​

Example request​

Responses​

Network List​

Parameters​

Example request​

Responses​

Read Network​

Parameters​

Example request​

Responses​

Update Network​

Request body​

Example request​

Responses​

Restart Network​

Parameters​

Example request​

Responses​

Replace Network ACL​

Parameters​

Example request​

Responses​

Change Network Security Group​

Parameters​

Example request​

Responses​

Delete Network​

Parameters​

Example request​

Responses​

Create Network

Parameters

Request body

Example request

Responses

Network List

Parameters

Example request

Responses

Read Network

Parameters

Example request

Responses

Update Network

Request body

Example request

Responses

Restart Network

Parameters

Example request

Responses

Replace Network ACL

Parameters

Example request

Responses

Change Network Security Group

Parameters

Example request

Responses

Delete Network

Parameters

Example request

Responses