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.

PreviousApplications NextVPCs

Last updated 1 month ago

Get a list of virtual machines

get

Query parameters

ClusterstringOptional

Responses

objectOptional

get

GET /api/v1/servers/virtual/GetServers HTTP/1.1
Host: 
Accept: */*

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

Get detailed information about a specific virtual machine

get

Query parameters

IdstringRequired

ClusterstringRequired

Responses

objectOptional

get

GET /api/v1/servers/virtual/GetServer?Id=text&Cluster=text HTTP/1.1
Host: 
Accept: */*

{
  "username": "text",
  "tenancy_name": "text",
  "rpool": "text",
  "id": "text",
  "configuration": "text",
  "storage": 1,
  "gpu_type": "text",
  "gpus": 1,
  "vcpus": 1,
  "memory": 1,
  "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

Query parameters

IdstringRequired

ClusterstringRequired

Responses

objectOptional

delete

DELETE /api/v1/servers/virtual/DestroyServer?Id=text&Cluster=text HTTP/1.1
Host: 
Accept: */*

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

Get detailed information on available configurations for virtual machines

get

Responses

objectOptional

get

GET /api/v1/servers/virtual/GetConfigurations HTTP/1.1
Host: 
Accept: */*

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

Create a new virtual machine using pre-defined configuration

post

Body

namestring | nullableOptional

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

rpoolstring | nullableOptional

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.

configurationstring · min: 1Required

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

clusterstring · min: 1Required

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

ssh_keysstring[] · min: 1Required

operatingSystemImagestring | nullableOptional

Name of the Operating System image to be used.

Example: Ubuntu 22.04.4 LTS

rootDiskSizeinteger · int32Optional

Size of root disk to be created.

Responses

objectOptional

post

POST /api/v1/servers/virtual/CreateServer HTTP/1.1
Host: 
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 164

{
  "name": "text",
  "rpool": "text",
  "configuration": "A100_40GB_PCIe_1x",
  "cluster": "text",
  "ssh_keys": [
    "text"
  ],
  "operatingSystemImage": "Ubuntu 22.04.4 LTS",
  "rootDiskSize": 1
}

{
  "username": "text",
  "tenancy_name": "text",
  "rpool": "text",
  "id": "text",
  "configuration": "text",
  "storage": 1,
  "gpu_type": "text",
  "gpus": 1,
  "vcpus": 1,
  "memory": 1,
  "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

Body

idstring · min: 1Required

clusterstring · min: 1Required

Responses

objectOptional

post

POST /api/v1/servers/virtual/StartServer HTTP/1.1
Host: 
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 30

{
  "id": "text",
  "cluster": "text"
}

{
  "username": "text",
  "tenancy_name": "text",
  "rpool": "text",
  "id": "text",
  "configuration": "text",
  "storage": 1,
  "gpu_type": "text",
  "gpus": 1,
  "vcpus": 1,
  "memory": 1,
  "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

Body

idstring · min: 1Required

clusterstring · min: 1Required

Responses

objectOptional

post

POST /api/v1/servers/virtual/StopServer HTTP/1.1
Host: 
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 30

{
  "id": "text",
  "cluster": "text"
}

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

Get information about the current availability of different virtual machine configurations

get

Query parameters

clusterstringRequiredExample: Hou1

resourcePoolstringOptionalExample: reserved-denvr

reportNodesbooleanOptional

controls if Count and MaxCount is calculated and returned in the response. If they are not needed, use 'false' to improve response time of the endpoint.

Default: true

Responses

objectOptional

get

GET /api/v1/servers/virtual/GetAvailability?cluster=text HTTP/1.1
Host: 
Accept: */*

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