Instance

Instances are the virtual machines you launch, operate and scale. This is the core compute resource.

Resource base path: /restapi/instance

Method	Path	Description
`POST`	`/restapi/instance/createInstance`	Create Instance
`GET`	`/restapi/instance/instanceList`	Instance List
`GET`	`/restapi/instance/vmStatus`	VM Status
`GET`	`/restapi/instance/startInstance`	Start Instance
`GET`	`/restapi/instance/stopInstance`	Stop Instance
`GET`	`/restapi/instance/resizeVm`	Resize VM Instance
`GET`	`/restapi/instance/recoverVm`	Recover VM Instance
`GET`	`/restapi/instance/destroyInstance`	Destroy Instance
`PUT`	`/restapi/instance/updateInstanceName`	Update Instance Name
`GET`	`/restapi/instance/instanceNetworkList`	Instance Network List
`POST`	`/restapi/instance/attachNetwork`	Attach Network to Instance
`POST`	`/restapi/instance/detachNetwork`	Detach Network from Instance
`GET`	`/restapi/instance/attachIso`	Attach ISO to Instance
`GET`	`/restapi/instance/detachIso`	Detach ISO
`GET`	`/restapi/instance/resetSSHkey`	Reset Instance SSH Key
`GET`	`/restapi/instance/instancePasswordList`	Instance Password List

note

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

Create Instance

Provision a new virtual-machine instance.

POST /restapi/instance/createInstance

Request body

Field	Type	Required	Description
`templateUuid`	string	No	UUID of the template.
`memory`	string	No
`rootDiskSize`	integer (int64)	No
`zoneUuid`	string	No	UUID of the zone the resource belongs to.
`computeOfferingUuid`	string	No	UUID of the compute offering.
`diskSize`	integer (int64)	No	Disk size in GB.
`sshKeyName`	string	No	Name of the SSH key pair.
`securitygroupName`	string	No
`hypervisorName`	string	No
`name`	string	No	Name of the resource.
`networkUuid`	string	No	UUID of the network.
`storageOfferingUuid`	string	No	UUID of the storage offering.
`cpuCore`	string	No

{
  "templateUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "memory": "string",
  "rootDiskSize": 1,
  "zoneUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "computeOfferingUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "diskSize": 1,
  "sshKeyName": "example-name",
  "securitygroupName": "example-name",
  "hypervisorName": "example-name",
  "name": "example-name",
  "networkUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "storageOfferingUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "cpuCore": "string"
}

Example request

curl -X POST \
  "https://portal.your-domain.com/restapi/instance/createInstance" \
  -H "apikey: YOUR_API_KEY" \
  -H "secretkey: YOUR_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "templateUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "memory": "string",
  "rootDiskSize": 1,
  "zoneUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "computeOfferingUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "diskSize": 1,
  "sshKeyName": "example-name",
  "securitygroupName": "example-name",
  "hypervisorName": "example-name",
  "name": "example-name",
  "networkUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "storageOfferingUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "cpuCore": "string"
}'

Responses

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

{
  "listInstanceResponse": [
    {
      "templateUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "instanceOwnerName": "example-name",
      "memory": "string",
      "displayName": "example-name",
      "rootDiskSize": 1,
      "networkName": "example-name",
      "zoneUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "sshUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "description": "string",
      "computeOfferingUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "isActive": true,
      "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "volumeSize": "string",
      "diskSize": 1,
      "templateName": "example-name",
      "name": "example-name",
      "state": "Running",
      "instancePrivateIp": "string",
      "networkUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "storageOfferingUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "cpuCore": "string",
      "status": "Active"
    }
  ],
  "count": 1
}

Instance List

Instance List.

GET /restapi/instance/instanceList

Parameters

Parameter	In	Type	Required	Description
`zoneUuid`	query	string	✅ Yes	UUID of the zone the resource belongs to.
`vmUuid`	query	string	No	UUID of the virtual-machine instance.

Example request

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

{
  "listInstanceResponse": [
    {
      "templateUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "instanceOwnerName": "example-name",
      "memory": "string",
      "displayName": "example-name",
      "rootDiskSize": 1,
      "networkName": "example-name",
      "zoneUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "sshUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "description": "string",
      "computeOfferingUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "isActive": true,
      "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "volumeSize": "string",
      "diskSize": 1,
      "templateName": "example-name",
      "name": "example-name",
      "state": "Running",
      "instancePrivateIp": "string",
      "networkUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "storageOfferingUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "cpuCore": "string",
      "status": "Active"
    }
  ],
  "count": 1
}

VM Status

Get the current status of an instance.

GET /restapi/instance/vmStatus

Parameters

Parameter	In	Type	Required	Description
`uuid`	query	string	✅ Yes	Instance UUID.

Example request

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

{
  "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "status": "Active"
}

Start Instance

Start Instance.

GET /restapi/instance/startInstance

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/instance/startInstance?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.

{
  "listInstanceResponse": [
    {
      "templateUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "instanceOwnerName": "example-name",
      "memory": "string",
      "displayName": "example-name",
      "rootDiskSize": 1,
      "networkName": "example-name",
      "zoneUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "sshUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "description": "string",
      "computeOfferingUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "isActive": true,
      "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "volumeSize": "string",
      "diskSize": 1,
      "templateName": "example-name",
      "name": "example-name",
      "state": "Running",
      "instancePrivateIp": "string",
      "networkUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "storageOfferingUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "cpuCore": "string",
      "status": "Active"
    }
  ],
  "count": 1
}

Stop Instance

Stop Instance.

GET /restapi/instance/stopInstance

Parameters

Parameter	In	Type	Required	Description
`uuid`	query	string	✅ Yes	UUID of the resource.
`forceStop`	query	boolean	✅ Yes	Force stop the instance.

Example request

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

Responses

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

{
  "listInstanceResponse": [
    {
      "templateUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "instanceOwnerName": "example-name",
      "memory": "string",
      "displayName": "example-name",
      "rootDiskSize": 1,
      "networkName": "example-name",
      "zoneUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "sshUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "description": "string",
      "computeOfferingUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "isActive": true,
      "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "volumeSize": "string",
      "diskSize": 1,
      "templateName": "example-name",
      "name": "example-name",
      "state": "Running",
      "instancePrivateIp": "string",
      "networkUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "storageOfferingUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "cpuCore": "string",
      "status": "Active"
    }
  ],
  "count": 1
}

Resize VM Instance

Resize VM Instance.

GET /restapi/instance/resizeVm

Parameters

Parameter	In	Type	Required	Description
`uuid`	query	string	✅ Yes	UUID of the resource.
`offeringUuid`	query	string	✅ Yes
`cpuCore`	query	integer (int64)	No	CPU core — custom offering only.
`memory`	query	integer (int64)	No	Memory — custom offering only.

Example request

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

{
  "listInstanceResponse": [
    {
      "templateUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "instanceOwnerName": "example-name",
      "memory": "string",
      "displayName": "example-name",
      "rootDiskSize": 1,
      "networkName": "example-name",
      "zoneUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "sshUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "description": "string",
      "computeOfferingUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "isActive": true,
      "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "volumeSize": "string",
      "diskSize": 1,
      "templateName": "example-name",
      "name": "example-name",
      "state": "Running",
      "instancePrivateIp": "string",
      "networkUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "storageOfferingUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "cpuCore": "string",
      "status": "Active"
    }
  ],
  "count": 1
}

Recover VM Instance

Recover VM Instance.

GET /restapi/instance/recoverVm

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/instance/recoverVm?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.

{
  "listInstanceResponse": [
    {
      "templateUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "instanceOwnerName": "example-name",
      "memory": "string",
      "displayName": "example-name",
      "rootDiskSize": 1,
      "networkName": "example-name",
      "zoneUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "sshUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "description": "string",
      "computeOfferingUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "isActive": true,
      "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "volumeSize": "string",
      "diskSize": 1,
      "templateName": "example-name",
      "name": "example-name",
      "state": "Running",
      "instancePrivateIp": "string",
      "networkUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "storageOfferingUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "cpuCore": "string",
      "status": "Active"
    }
  ],
  "count": 1
}

Destroy Instance

Destroy Instance.

GET /restapi/instance/destroyInstance

Parameters

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

Example request

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

Responses

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

{
  "listInstanceResponse": [
    {
      "templateUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "instanceOwnerName": "example-name",
      "memory": "string",
      "displayName": "example-name",
      "rootDiskSize": 1,
      "networkName": "example-name",
      "zoneUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "sshUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "description": "string",
      "computeOfferingUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "isActive": true,
      "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "volumeSize": "string",
      "diskSize": 1,
      "templateName": "example-name",
      "name": "example-name",
      "state": "Running",
      "instancePrivateIp": "string",
      "networkUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "storageOfferingUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "cpuCore": "string",
      "status": "Active"
    }
  ],
  "count": 1
}

Update Instance Name

Update Instance Name.

PUT /restapi/instance/updateInstanceName

Request body

Field	Type	Required	Description
`displayName`	string	No
`uuid`	string	No	UUID of the resource.

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

Example request

curl -X PUT \
  "https://portal.your-domain.com/restapi/instance/updateInstanceName" \
  -H "apikey: YOUR_API_KEY" \
  -H "secretkey: YOUR_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "displayName": "example-name",
  "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.

{
  "listInstanceResponse": [
    {
      "templateUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "instanceOwnerName": "example-name",
      "memory": "string",
      "displayName": "example-name",
      "rootDiskSize": 1,
      "networkName": "example-name",
      "zoneUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "sshUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "description": "string",
      "computeOfferingUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "isActive": true,
      "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "volumeSize": "string",
      "diskSize": 1,
      "templateName": "example-name",
      "name": "example-name",
      "state": "Running",
      "instancePrivateIp": "string",
      "networkUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "storageOfferingUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "cpuCore": "string",
      "status": "Active"
    }
  ],
  "count": 1
}

Instance Network List

Instance Network List.

GET /restapi/instance/instanceNetworkList

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/instance/instanceNetworkList?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,
  "kongInstanceNetworkResponses": [
    {
      "netmask": "string",
      "privateIp": "string",
      "name": "example-name",
      "defaultNetwork": true,
      "publicIp": "string",
      "type": "string",
      "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "gateway": "string"
    }
  ]
}

Attach Network to Instance

Attach Network to Instance.

POST /restapi/instance/attachNetwork

Request body

Field	Type	Required	Description
`uuid`	string	No	UUID of the resource.
`networkUuid`	string	No	UUID of the network.

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

Example request

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

Responses

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

{
  "listInstanceResponse": [
    {
      "templateUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "instanceOwnerName": "example-name",
      "memory": "string",
      "displayName": "example-name",
      "rootDiskSize": 1,
      "networkName": "example-name",
      "zoneUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "sshUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "description": "string",
      "computeOfferingUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "isActive": true,
      "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "volumeSize": "string",
      "diskSize": 1,
      "templateName": "example-name",
      "name": "example-name",
      "state": "Running",
      "instancePrivateIp": "string",
      "networkUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "storageOfferingUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "cpuCore": "string",
      "status": "Active"
    }
  ],
  "count": 1
}

Detach Network from Instance

Detach Network from Instance.

POST /restapi/instance/detachNetwork

Request body

Field	Type	Required	Description
`uuid`	string	No	UUID of the resource.
`networkUuid`	string	No	UUID of the network.

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

Example request

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

Responses

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

{
  "listInstanceResponse": [
    {
      "templateUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "instanceOwnerName": "example-name",
      "memory": "string",
      "displayName": "example-name",
      "rootDiskSize": 1,
      "networkName": "example-name",
      "zoneUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "sshUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "description": "string",
      "computeOfferingUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "isActive": true,
      "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "volumeSize": "string",
      "diskSize": 1,
      "templateName": "example-name",
      "name": "example-name",
      "state": "Running",
      "instancePrivateIp": "string",
      "networkUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "storageOfferingUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "cpuCore": "string",
      "status": "Active"
    }
  ],
  "count": 1
}

Attach ISO to Instance

Attach ISO to Instance.

GET /restapi/instance/attachIso

Parameters

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

Example request

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

{
  "listInstanceResponse": [
    {
      "templateUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "instanceOwnerName": "example-name",
      "memory": "string",
      "displayName": "example-name",
      "rootDiskSize": 1,
      "networkName": "example-name",
      "zoneUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "sshUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "description": "string",
      "computeOfferingUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "isActive": true,
      "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "volumeSize": "string",
      "diskSize": 1,
      "templateName": "example-name",
      "name": "example-name",
      "state": "Running",
      "instancePrivateIp": "string",
      "networkUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "storageOfferingUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "cpuCore": "string",
      "status": "Active"
    }
  ],
  "count": 1
}

Detach ISO

Detach ISO.

GET /restapi/instance/detachIso

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/instance/detachIso?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.

{
  "listInstanceResponse": [
    {
      "templateUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "instanceOwnerName": "example-name",
      "memory": "string",
      "displayName": "example-name",
      "rootDiskSize": 1,
      "networkName": "example-name",
      "zoneUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "sshUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "description": "string",
      "computeOfferingUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "isActive": true,
      "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "volumeSize": "string",
      "diskSize": 1,
      "templateName": "example-name",
      "name": "example-name",
      "state": "Running",
      "instancePrivateIp": "string",
      "networkUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "storageOfferingUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "cpuCore": "string",
      "status": "Active"
    }
  ],
  "count": 1
}

Reset Instance SSH Key

Reset Instance SSH Key.

GET /restapi/instance/resetSSHkey

Parameters

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

Example request

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

{
  "listInstanceResponse": [
    {
      "templateUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "instanceOwnerName": "example-name",
      "memory": "string",
      "displayName": "example-name",
      "rootDiskSize": 1,
      "networkName": "example-name",
      "zoneUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "sshUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "description": "string",
      "computeOfferingUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "isActive": true,
      "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "volumeSize": "string",
      "diskSize": 1,
      "templateName": "example-name",
      "name": "example-name",
      "state": "Running",
      "instancePrivateIp": "string",
      "networkUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "storageOfferingUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "cpuCore": "string",
      "status": "Active"
    }
  ],
  "count": 1
}

Instance Password List

Instance Password List.

GET /restapi/instance/instancePasswordList

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/instance/instancePasswordList?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,
  "listInstancePasswordResponse": [
    {
      "password": "string",
      "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
    }
  ]
}

Create Instance​

Request body​

Example request​

Responses​

Instance List​

Parameters​

Example request​

Responses​

VM Status​

Parameters​

Example request​

Responses​

Start Instance​

Parameters​

Example request​

Responses​

Stop Instance​

Parameters​

Example request​

Responses​

Resize VM Instance​

Parameters​

Example request​

Responses​

Recover VM Instance​

Parameters​

Example request​

Responses​

Destroy Instance​

Parameters​

Example request​

Responses​

Update Instance Name​

Request body​

Example request​

Responses​

Instance Network List​

Parameters​

Example request​

Responses​

Attach Network to Instance​

Request body​

Example request​

Responses​

Detach Network from Instance​

Request body​

Example request​

Responses​

Attach ISO to Instance​

Parameters​

Example request​

Responses​

Detach ISO​

Parameters​

Example request​

Responses​

Reset Instance SSH Key​

Parameters​

Example request​

Responses​

Instance Password List​

Parameters​

Example request​

Responses​

Create Instance

Request body

Example request

Responses

Instance List

Parameters

Example request

Responses

VM Status

Parameters

Example request

Responses

Start Instance

Parameters

Example request

Responses

Stop Instance

Parameters

Example request

Responses

Resize VM Instance

Parameters

Example request

Responses

Recover VM Instance

Parameters

Example request

Responses

Destroy Instance

Parameters

Example request

Responses

Update Instance Name

Request body

Example request

Responses

Instance Network List

Parameters

Example request

Responses

Attach Network to Instance

Request body

Example request

Responses

Detach Network from Instance

Request body

Example request

Responses

Attach ISO to Instance

Parameters

Example request

Responses

Detach ISO

Parameters

Example request

Responses

Reset Instance SSH Key

Parameters

Example request

Responses

Instance Password List

Parameters

Example request

Responses