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 /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 /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"
}
Name of virtual server to be created. If not provided, name will be auto-generated.
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.
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
A100_40GB_PCIe_1x
cluster to be used. For possible values, refer to the otput of api/v1/clusters/GetAll"/>
Name of the Operating System image to be used.
Ubuntu 22.04.4 LTS
Size of root disk to be created.
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 /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 /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"
}
Permanently delete a specified virtual machine, effectively wiping all its data and freeing up resources for other uses
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 /api/v1/servers/virtual/GetConfigurations HTTP/1.1
Host:
Accept: */*
{
"items": [
{
"id": 1,
"user_friendly_name": "text",
"name": "text",
"description": "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"
]
}
]
}
Hou1
reserved-denvr
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.
true
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
}
]
}
Last updated