Virtual machines

Explore this section for comprehensive information on endpoints related to the deployment, management, and operation of virtual machines within our cloud software API environment.

Get a list of virtual machines

GET/api/v1/servers/virtual/GetServers

Query parameters

Response

200400401403500

Success

Body

text/plainapplication/jsontext/json

itemsnullable array of VirtualServerDetailsItem (object)

Request

JavaScriptCurlPython

const response = await fetch('/api/v1/servers/virtual/GetServers', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "items": [
    {
      "username": "text",
      "tenancy_name": "text",
      "rpool": "text",
      "id": "text",
      "configuration": "text",
      "storage": 0,
      "gpu_type": "text",
      "gpus": 0,
      "vcpus": 0,
      "memory": 0,
      "ip": "text",
      "privateIp": "text",
      "image": "text",
      "cluster": "text",
      "status": "ONLINE",
      "storageType": "text"
    }
  ]
}

Get detailed information about a specific virtual machine

GET/api/v1/servers/virtual/GetServer

Query parameters

Response

200400401403500

Success

Body

text/plainapplication/jsontext/json

usernamenullable string

tenancy_namenullable string

rpoolnullable string

idnullable string

configurationnullable string

storagenullable integer (int64)

gpu_typenullable string

gpusnullable integer (int32)

vcpusnullable integer (int32)

memorynullable integer (int64)

ipnullable string

privateIpnullable string

imagenullable string

clusternullable string

statusnullable string

Possible values: PLANNED - VM is in initialization phaseONLINE - VM is up and runningOFFLINE - VM is stoppedCREATE_FAILED - VM creation failedADMIN_WAIT - VM FailedFAILED - VM FailedPENDING - VM is in process of transitioning to another statePENDING_RESOURCES - VM is waiting for resourcesPENDING_READINESS - VM is waiting for IP address to become available

Example: "ONLINE"

storageTypenullable string

Request

JavaScriptCurlPython

const response = await fetch('/api/v1/servers/virtual/GetServer?Id=text&Cluster=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "username": "text",
  "tenancy_name": "text",
  "rpool": "text",
  "id": "text",
  "configuration": "text",
  "storage": 0,
  "gpu_type": "text",
  "gpus": 0,
  "vcpus": 0,
  "memory": 0,
  "ip": "text",
  "privateIp": "text",
  "image": "text",
  "cluster": "text",
  "status": "ONLINE",
  "storageType": "text"
}

Create a new virtual machine using pre-defined configuration

POST/api/v1/servers/virtual/CreateServer

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

namenullable string

Name of virtual server to be created. If not provided, name will be auto-generated.

rpoolnullable string

Name of the pool to be used. If not provided, first pool assigned to a tenant will be used. In case of no pool assigned, 'on-demand' will be used.

configuration*string

Name of the configuration to be used. For possible values, refer to the otput of api/v1/servers/virtual/GetConfigurations, field 'name' DenvrDashboard.Servers.Dtos.ServerConfiguration.Name

Example: "A100_40GB_PCIe_1x"

cluster*string

cluster to be used. For possible values, refer to the otput of api/v1/clusters/GetAll"/>

ssh_keys*array of string

operatingSystemImagenullable string

Name of the Operating System image to be used.

Example: "Ubuntu 22.04.4 LTS"

rootDiskSizeinteger (int32)

Size of root disk to be created.

Response

202400401403500503

Accepted

Body

text/plainapplication/jsontext/json

usernamenullable string

tenancy_namenullable string

rpoolnullable string

idnullable string

configurationnullable string

storagenullable integer (int64)

gpu_typenullable string

gpusnullable integer (int32)

vcpusnullable integer (int32)

memorynullable integer (int64)

ipnullable string

privateIpnullable string

imagenullable string

clusternullable string

statusnullable string

Possible values: PLANNED - VM is in initialization phaseONLINE - VM is up and runningOFFLINE - VM is stoppedCREATE_FAILED - VM creation failedADMIN_WAIT - VM FailedFAILED - VM FailedPENDING - VM is in process of transitioning to another statePENDING_RESOURCES - VM is waiting for resourcesPENDING_READINESS - VM is waiting for IP address to become available

Example: "ONLINE"

storageTypenullable string

Request

JavaScriptCurlPython

const response = await fetch('/api/v1/servers/virtual/CreateServer', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json-patch+json"
    },
    body: JSON.stringify({
      "cluster": "text",
      "configuration": "A100_40GB_PCIe_1x",
      "ssh_keys": [
        "text"
      ]
    }),
});
const data = await response.json();

Response

202

{
  "username": "text",
  "tenancy_name": "text",
  "rpool": "text",
  "id": "text",
  "configuration": "text",
  "storage": 0,
  "gpu_type": "text",
  "gpus": 0,
  "vcpus": 0,
  "memory": 0,
  "ip": "text",
  "privateIp": "text",
  "image": "text",
  "cluster": "text",
  "status": "ONLINE",
  "storageType": "text"
}

Start a virtual machine that has been previously set up and provisioned, but is currently OFFLINE

POST/api/v1/servers/virtual/StartServer

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

id*string

cluster*string

Response

202400401403500503

Accepted

Body

text/plainapplication/jsontext/json

usernamenullable string

tenancy_namenullable string

rpoolnullable string

idnullable string

configurationnullable string

storagenullable integer (int64)

gpu_typenullable string

gpusnullable integer (int32)

vcpusnullable integer (int32)

memorynullable integer (int64)

ipnullable string

privateIpnullable string

imagenullable string

clusternullable string

statusnullable string

Possible values: PLANNED - VM is in initialization phaseONLINE - VM is up and runningOFFLINE - VM is stoppedCREATE_FAILED - VM creation failedADMIN_WAIT - VM FailedFAILED - VM FailedPENDING - VM is in process of transitioning to another statePENDING_RESOURCES - VM is waiting for resourcesPENDING_READINESS - VM is waiting for IP address to become available

Example: "ONLINE"

storageTypenullable string

Request

JavaScriptCurlPython

const response = await fetch('/api/v1/servers/virtual/StartServer', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json-patch+json"
    },
    body: JSON.stringify({
      "cluster": "text",
      "id": "text"
    }),
});
const data = await response.json();

Response

202

{
  "username": "text",
  "tenancy_name": "text",
  "rpool": "text",
  "id": "text",
  "configuration": "text",
  "storage": 0,
  "gpu_type": "text",
  "gpus": 0,
  "vcpus": 0,
  "memory": 0,
  "ip": "text",
  "privateIp": "text",
  "image": "text",
  "cluster": "text",
  "status": "ONLINE",
  "storageType": "text"
}

Stop a virtual machine, ensuring a secure and orderly shutdown of its operations within the cloud environment

POST/api/v1/servers/virtual/StopServer

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

id*string

cluster*string

Response

202400401403500

Accepted

Body

text/plainapplication/jsontext/json

usernamenullable string

tenancy_namenullable string

rpoolnullable string

idnullable string

configurationnullable string

storagenullable integer (int64)

gpu_typenullable string

gpusnullable integer (int32)

vcpusnullable integer (int32)

memorynullable integer (int64)

ipnullable string

privateIpnullable string

imagenullable string

clusternullable string

statusnullable string

Possible values: PLANNED - VM is in initialization phaseONLINE - VM is up and runningOFFLINE - VM is stoppedCREATE_FAILED - VM creation failedADMIN_WAIT - VM FailedFAILED - VM FailedPENDING - VM is in process of transitioning to another statePENDING_RESOURCES - VM is waiting for resourcesPENDING_READINESS - VM is waiting for IP address to become available

Example: "ONLINE"

storageTypenullable string

Request

JavaScriptCurlPython

const response = await fetch('/api/v1/servers/virtual/StopServer', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json-patch+json"
    },
    body: JSON.stringify({
      "cluster": "text",
      "id": "text"
    }),
});
const data = await response.json();

Response

202

{
  "username": "text",
  "tenancy_name": "text",
  "rpool": "text",
  "id": "text",
  "configuration": "text",
  "storage": 0,
  "gpu_type": "text",
  "gpus": 0,
  "vcpus": 0,
  "memory": 0,
  "ip": "text",
  "privateIp": "text",
  "image": "text",
  "cluster": "text",
  "status": "ONLINE",
  "storageType": "text"
}

Permanently delete a specified virtual machine, effectively wiping all its data and freeing up resources for other uses

DELETE/api/v1/servers/virtual/DestroyServer

Query parameters

Response

202400401403500

Accepted

Body

text/plainapplication/jsontext/json

usernamenullable string

tenancy_namenullable string

rpoolnullable string

idnullable string

configurationnullable string

storagenullable integer (int64)

gpu_typenullable string

gpusnullable integer (int32)

vcpusnullable integer (int32)

memorynullable integer (int64)

ipnullable string

privateIpnullable string

imagenullable string

clusternullable string

statusnullable string

Possible values: PLANNED - VM is in initialization phaseONLINE - VM is up and runningOFFLINE - VM is stoppedCREATE_FAILED - VM creation failedADMIN_WAIT - VM FailedFAILED - VM FailedPENDING - VM is in process of transitioning to another statePENDING_RESOURCES - VM is waiting for resourcesPENDING_READINESS - VM is waiting for IP address to become available

Example: "ONLINE"

storageTypenullable string

Request

JavaScriptCurlPython

const response = await fetch('/api/v1/servers/virtual/DestroyServer?Id=text&Cluster=text', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

202

{
  "username": "text",
  "tenancy_name": "text",
  "rpool": "text",
  "id": "text",
  "configuration": "text",
  "storage": 0,
  "gpu_type": "text",
  "gpus": 0,
  "vcpus": 0,
  "memory": 0,
  "ip": "text",
  "privateIp": "text",
  "image": "text",
  "cluster": "text",
  "status": "ONLINE",
  "storageType": "text"
}

Get detailed information on available configurations for virtual machines

GET/api/v1/servers/virtual/GetConfigurations

Response

200400401403500

Success

Body

text/plainapplication/jsontext/json

itemsnullable array of ServerConfiguration (object)

Request

JavaScriptCurlPython

const response = await fetch('/api/v1/servers/virtual/GetConfigurations', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "items": [
    {
      "id": 0,
      "user_friendly_name": "text",
      "name": "text",
      "description": "text",
      "os_version": "text",
      "os_type": "text",
      "storage": 0,
      "type": "text",
      "brand_family": "text",
      "brand": "text",
      "text_name": "text",
      "gpus": 0,
      "vcpus": 0,
      "memory": 0,
      "price": 0,
      "compute_network": "text",
      "is_gpu_platform": false,
      "clusters": [
        "text"
      ]
    }
  ]
}

Get information about the current availability of different virtual machine configurations

GET/api/v1/servers/virtual/GetAvailability

Query parameters

Response

200400401403500

Success

Body

text/plainapplication/jsontext/json

itemsnullable array of ServerAvailability (object)

Request

JavaScriptCurlPython

const response = await fetch('/api/v1/servers/virtual/GetAvailability?cluster=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "items": [
    {
      "configuration": "text",
      "cluster": "text",
      "rpool": "text",
      "price": 0,
      "available": false,
      "count": 0,
      "maxCount": 0
    }
  ]
}