VPC

Virtual private clouds that contain tiered networks.

Resource base path: /restapi/vpc

Method	Path	Description
`POST`	`/restapi/vpc/createVpc`	Create VPC
`GET`	`/restapi/vpc/vpcList`	VPC List
`GET`	`/restapi/vpc/vpcId`	Read VPC
`PUT`	`/restapi/vpc/updateVpc`	Update VPC
`GET`	`/restapi/vpc/restartVpc`	Restart VPC
`POST`	`/restapi/vpc/createVpcNetwork`	Create VPC Network
`PUT`	`/restapi/vpc/updateVpcNetwork`	Update VPC Network
`DELETE`	`/restapi/vpc/deleteVpc/{uuid}`	Delete VPC

note

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

Create VPC

Create VPC.

POST /restapi/vpc/createVpc

Request body

Field	Type	Required	Description
`publicLoadBalancerProvider`	string	No
`vpcOfferingUuid`	string	No
`getcIDR`	string	No
`name`	string	No	Name of the resource.
`zoneUuid`	string	No	UUID of the zone the resource belongs to.
`description`	string	No	Human-readable description.
`networkDomain`	string	No

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

Example request

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

Responses

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

{
  "count": 1,
  "listVpcResponse": [
    {
      "getcIDR": "0.0.0.0/0",
      "domainName": "example-name",
      "name": "example-name",
      "zoneUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "description": "string",
      "zoneName": "example-name",
      "isActive": true,
      "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "status": "Active"
    }
  ]
}

VPC List

VPC List.

GET /restapi/vpc/vpcList

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/vpc/vpcList?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,
  "listVpcResponse": [
    {
      "getcIDR": "0.0.0.0/0",
      "domainName": "example-name",
      "name": "example-name",
      "zoneUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "description": "string",
      "zoneName": "example-name",
      "isActive": true,
      "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "status": "Active"
    }
  ]
}

Read VPC

Read a single VPC by UUID.

GET /restapi/vpc/vpcId

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/vpc/vpcId?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.

{
  "count": 1,
  "listVpcResponse": [
    {
      "getcIDR": "0.0.0.0/0",
      "domainName": "example-name",
      "name": "example-name",
      "zoneUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "description": "string",
      "zoneName": "example-name",
      "isActive": true,
      "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "status": "Active"
    }
  ]
}

Update VPC

Update VPC.

PUT /restapi/vpc/updateVpc

Request body

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

{
  "name": "example-name",
  "description": "string",
  "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}

Example request

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

Responses

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

{
  "count": 1,
  "listVpcResponse": [
    {
      "getcIDR": "0.0.0.0/0",
      "domainName": "example-name",
      "name": "example-name",
      "zoneUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "description": "string",
      "zoneName": "example-name",
      "isActive": true,
      "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "status": "Active"
    }
  ]
}

Restart VPC

Restart VPC.

GET /restapi/vpc/restartVpc

Parameters

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

Example request

curl -X GET \
  "https://portal.your-domain.com/restapi/vpc/restartVpc?uuid=a1b2c3d4-e5f6-7890-abcd-ef1234567890&cleanUpVPC=VALUE&redundantVpcRouter=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,
  "listVpcResponse": [
    {
      "getcIDR": "0.0.0.0/0",
      "domainName": "example-name",
      "name": "example-name",
      "zoneUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "description": "string",
      "zoneName": "example-name",
      "isActive": true,
      "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "status": "Active"
    }
  ]
}

Create VPC Network

Create a network (tier) inside a VPC.

POST /restapi/vpc/createVpcNetwork

Request body

Field	Type	Required	Description
`aclUuid`	string	No
`netmask`	string	No
`name`	string	No	Name of the resource.
`zoneUuid`	string	No	UUID of the zone the resource belongs to.
`networkOfferingUuid`	string	No	UUID of the network offering.
`vpcUuid`	string	No	UUID of the VPC.
`gateway`	string	No

{
  "aclUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "netmask": "string",
  "name": "example-name",
  "zoneUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "networkOfferingUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "vpcUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "gateway": "string"
}

Example request

curl -X POST \
  "https://portal.your-domain.com/restapi/vpc/createVpcNetwork" \
  -H "apikey: YOUR_API_KEY" \
  -H "secretkey: YOUR_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "aclUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "netmask": "string",
  "name": "example-name",
  "zoneUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "networkOfferingUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "vpcUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "gateway": "string"
}'

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 VPC Network

Update a network (tier) inside a VPC.

PUT /restapi/vpc/updateVpcNetwork

Request body

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

{
  "name": "example-name",
  "description": "string",
  "networkOfferingUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "networkDomain": "string"
}

Example request

curl -X PUT \
  "https://portal.your-domain.com/restapi/vpc/updateVpcNetwork" \
  -H "apikey: YOUR_API_KEY" \
  -H "secretkey: YOUR_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "example-name",
  "description": "string",
  "networkOfferingUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "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
}

Delete VPC

Delete VPC.

DELETE /restapi/vpc/deleteVpc/{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/vpc/deleteVpc/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

Create VPC​

Request body​

Example request​

Responses​

VPC List​

Parameters​

Example request​

Responses​

Read VPC​

Parameters​

Example request​

Responses​

Update VPC​

Request body​

Example request​

Responses​

Restart VPC​

Parameters​

Example request​

Responses​

Create VPC Network​

Request body​

Example request​

Responses​

Update VPC Network​

Request body​

Example request​

Responses​

Delete VPC​

Parameters​

Example request​

Responses​

Create VPC

Request body

Example request

Responses

VPC List

Parameters

Example request

Responses

Read VPC

Parameters

Example request

Responses

Update VPC

Request body

Example request

Responses

Restart VPC

Parameters

Example request

Responses

Create VPC Network

Request body

Example request

Responses

Update VPC Network

Request body

Example request

Responses

Delete VPC

Parameters

Example request

Responses