All URIs are relative to https://rest.compute.cudo.org
| Method | HTTP request | Description |
|---|---|---|
| attach_security_group | PATCH /v1/projects/{projectId}/vm/{id}/security-group/attach | Attach security group to VM |
| connect_vm | GET /v1/projects/{projectId}/vms/{id}/connect | Connect via VNC |
| count_vms | GET /v1/projects/{projectId}/count-vms | Count |
| create_private_vm_image | POST /v1/projects/{projectId}/images | Create private VM image |
| create_vm | POST /v1/projects/{projectId}/vm | Create virtual machine |
| delete_private_vm_image | DELETE /v1/projects/{projectId}/images/{id} | Delete private VM image |
| detach_security_group | PATCH /v1/projects/{projectId}/vm/{id}/security-group/detach | Attach security group to VM |
| get_private_vm_image | GET /v1/projects/{projectId}/images/{id} | Get private VM image |
| get_vm | GET /v1/projects/{projectId}/vms/{id} | Get |
| list_private_vm_images | GET /v1/projects/{projectId}/images | List private VM images |
| list_public_vm_images | GET /v1/vms/public-images | List public VM images |
| list_vm_data_centers | GET /v1/vms/data-centers | List data centers |
| list_vm_disks | GET /v1/projects/{projectId}/vms/{id}/disks | List disks attached to VM |
| list_vm_gpu_models | GET /v1/vms/gpu-models | List GPU models |
| list_vm_machine_types2 | GET /v1/vms/machine-types-2 | List machine types v2 |
| list_vms | GET /v1/projects/{projectId}/vms | List |
| monitor_vm | GET /v1/projects/{projectId}/vms/{id}/monitor | Monitor |
| reboot_vm | POST /v1/projects/{projectId}/vms/{id}/reboot | Reboot |
| resize_vm | POST /v1/projects/{projectId}/vms/{id}/resize | Resize vCPU and memory of VM |
| resize_vm_disk | PATCH /v1/projects/{projectId}/vms/{id}/disks | Resize a VM's disk |
| start_vm | POST /v1/projects/{projectId}/vms/{id}/start | Start |
| stop_vm | POST /v1/projects/{projectId}/vms/{id}/stop | Stop |
| terminate_vm | POST /v1/projects/{projectId}/vms/{id}/terminate | Terminate |
| update_private_vm_image | POST /v1/projects/{projectId}/images/{id} | Update private VM image |
| update_vm_metadata | POST /v1/projects/{projectId}/vm/{id}/metadata | Update VM metadata |
AttachSecurityGroupResponse attach_security_group(project_id, id, security_group_id=security_group_id)
Attach security group to VM
from __future__ import print_function
import time
import src.cudo_compute
from src.cudo_compute.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = src.cudo_compute.VirtualMachinesApi()
project_id = 'project_id_example' # str |
id = 'id_example' # str |
security_group_id = 'security_group_id_example' # str | (optional)
try:
# Attach security group to VM
api_response = api_instance.attach_security_group(project_id, id, security_group_id=security_group_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling VirtualMachinesApi->attach_security_group: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| project_id | str | ||
| id | str | ||
| security_group_id | str | [optional] |
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ConnectVMResponse connect_vm(project_id, id, connection_id=connection_id)
Connect via VNC
from __future__ import print_function
import time
import src.cudo_compute
from src.cudo_compute.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = src.cudo_compute.VirtualMachinesApi()
project_id = 'project_id_example' # str |
id = 'id_example' # str |
connection_id = 'connection_id_example' # str | (optional)
try:
# Connect via VNC
api_response = api_instance.connect_vm(project_id, id, connection_id=connection_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling VirtualMachinesApi->connect_vm: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| project_id | str | ||
| id | str | ||
| connection_id | str | [optional] |
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
CountVMsResponse count_vms(project_id)
Count
from __future__ import print_function
import time
import src.cudo_compute
from src.cudo_compute.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = src.cudo_compute.VirtualMachinesApi()
project_id = 'project_id_example' # str |
try:
# Count
api_response = api_instance.count_vms(project_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling VirtualMachinesApi->count_vms: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| project_id | str |
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
CreatePrivateVMImageResponse create_private_vm_image(project_id, vm_id, id, description=description)
Create private VM image
from __future__ import print_function
import time
import src.cudo_compute
from src.cudo_compute.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = src.cudo_compute.VirtualMachinesApi()
project_id = 'project_id_example' # str |
vm_id = 'vm_id_example' # str |
id = 'id_example' # str |
description = 'description_example' # str | (optional)
try:
# Create private VM image
api_response = api_instance.create_private_vm_image(project_id, vm_id, id, description=description)
pprint(api_response)
except ApiException as e:
print("Exception when calling VirtualMachinesApi->create_private_vm_image: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| project_id | str | ||
| vm_id | str | ||
| id | str | ||
| description | str | [optional] |
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
CreateVMResponse create_vm(project_id, create_vm_body)
Create virtual machine
from __future__ import print_function
import time
import src.cudo_compute
from src.cudo_compute.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = src.cudo_compute.VirtualMachinesApi()
project_id = 'project_id_example' # str |
create_vm_body = src.cudo_compute.CreateVMBody() # CreateVMBody |
try:
# Create virtual machine
api_response = api_instance.create_vm(project_id, create_vm_body)
pprint(api_response)
except ApiException as e:
print("Exception when calling VirtualMachinesApi->create_vm: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| project_id | str | ||
| create_vm_body | CreateVMBody |
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DeletePrivateVMImageResponse delete_private_vm_image(project_id, id)
Delete private VM image
from __future__ import print_function
import time
import src.cudo_compute
from src.cudo_compute.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = src.cudo_compute.VirtualMachinesApi()
project_id = 'project_id_example' # str |
id = 'id_example' # str |
try:
# Delete private VM image
api_response = api_instance.delete_private_vm_image(project_id, id)
pprint(api_response)
except ApiException as e:
print("Exception when calling VirtualMachinesApi->delete_private_vm_image: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| project_id | str | ||
| id | str |
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DetachSecurityGroupResponse detach_security_group(project_id, id, security_group_id=security_group_id)
Attach security group to VM
from __future__ import print_function
import time
import src.cudo_compute
from src.cudo_compute.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = src.cudo_compute.VirtualMachinesApi()
project_id = 'project_id_example' # str |
id = 'id_example' # str |
security_group_id = 'security_group_id_example' # str | (optional)
try:
# Attach security group to VM
api_response = api_instance.detach_security_group(project_id, id, security_group_id=security_group_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling VirtualMachinesApi->detach_security_group: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| project_id | str | ||
| id | str | ||
| security_group_id | str | [optional] |
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetPrivateVMImageResponse get_private_vm_image(project_id, id)
Get private VM image
from __future__ import print_function
import time
import src.cudo_compute
from src.cudo_compute.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = src.cudo_compute.VirtualMachinesApi()
project_id = 'project_id_example' # str |
id = 'id_example' # str |
try:
# Get private VM image
api_response = api_instance.get_private_vm_image(project_id, id)
pprint(api_response)
except ApiException as e:
print("Exception when calling VirtualMachinesApi->get_private_vm_image: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| project_id | str | ||
| id | str |
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetVMResponse get_vm(project_id, id)
Get
from __future__ import print_function
import time
import src.cudo_compute
from src.cudo_compute.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = src.cudo_compute.VirtualMachinesApi()
project_id = 'project_id_example' # str |
id = 'id_example' # str |
try:
# Get
api_response = api_instance.get_vm(project_id, id)
pprint(api_response)
except ApiException as e:
print("Exception when calling VirtualMachinesApi->get_vm: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| project_id | str | ||
| id | str |
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ListPrivateVMImagesResponse list_private_vm_images(project_id, page_number=page_number, page_size=page_size)
List private VM images
from __future__ import print_function
import time
import src.cudo_compute
from src.cudo_compute.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = src.cudo_compute.VirtualMachinesApi()
project_id = 'project_id_example' # str |
page_number = 56 # int | (optional)
page_size = 56 # int | (optional)
try:
# List private VM images
api_response = api_instance.list_private_vm_images(project_id, page_number=page_number, page_size=page_size)
pprint(api_response)
except ApiException as e:
print("Exception when calling VirtualMachinesApi->list_private_vm_images: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| project_id | str | ||
| page_number | int | [optional] | |
| page_size | int | [optional] |
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ListPublicVMImagesResponse list_public_vm_images()
List public VM images
from __future__ import print_function
import time
import src.cudo_compute
from src.cudo_compute.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = src.cudo_compute.VirtualMachinesApi()
try:
# List public VM images
api_response = api_instance.list_public_vm_images()
pprint(api_response)
except ApiException as e:
print("Exception when calling VirtualMachinesApi->list_public_vm_images: %s\n" % e)This endpoint does not need any parameter.
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ListVMDataCentersResponse list_vm_data_centers(region_id=region_id, renewable_energy=renewable_energy)
List data centers
from __future__ import print_function
import time
import src.cudo_compute
from src.cudo_compute.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = src.cudo_compute.VirtualMachinesApi()
region_id = ['region_id_example'] # list[str] | (optional)
renewable_energy = true # bool | (optional)
try:
# List data centers
api_response = api_instance.list_vm_data_centers(region_id=region_id, renewable_energy=renewable_energy)
pprint(api_response)
except ApiException as e:
print("Exception when calling VirtualMachinesApi->list_vm_data_centers: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| region_id | list[str] | [optional] | |
| renewable_energy | bool | [optional] |
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ListVMDisksResponse list_vm_disks(project_id, id)
List disks attached to VM
from __future__ import print_function
import time
import src.cudo_compute
from src.cudo_compute.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = src.cudo_compute.VirtualMachinesApi()
project_id = 'project_id_example' # str |
id = 'id_example' # str |
try:
# List disks attached to VM
api_response = api_instance.list_vm_disks(project_id, id)
pprint(api_response)
except ApiException as e:
print("Exception when calling VirtualMachinesApi->list_vm_disks: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| project_id | str | ||
| id | str |
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ListVMGpuModelsResponse list_vm_gpu_models()
List GPU models
from __future__ import print_function
import time
import src.cudo_compute
from src.cudo_compute.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = src.cudo_compute.VirtualMachinesApi()
try:
# List GPU models
api_response = api_instance.list_vm_gpu_models()
pprint(api_response)
except ApiException as e:
print("Exception when calling VirtualMachinesApi->list_vm_gpu_models: %s\n" % e)This endpoint does not need any parameter.
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ListVMMachineTypes2Response list_vm_machine_types2()
List machine types v2
from __future__ import print_function
import time
import src.cudo_compute
from src.cudo_compute.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = src.cudo_compute.VirtualMachinesApi()
try:
# List machine types v2
api_response = api_instance.list_vm_machine_types2()
pprint(api_response)
except ApiException as e:
print("Exception when calling VirtualMachinesApi->list_vm_machine_types2: %s\n" % e)This endpoint does not need any parameter.
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ListVMsResponse list_vms(project_id, network_id=network_id)
List
from __future__ import print_function
import time
import src.cudo_compute
from src.cudo_compute.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = src.cudo_compute.VirtualMachinesApi()
project_id = 'project_id_example' # str |
network_id = 'network_id_example' # str | (optional)
try:
# List
api_response = api_instance.list_vms(project_id, network_id=network_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling VirtualMachinesApi->list_vms: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| project_id | str | ||
| network_id | str | [optional] |
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
MonitorVMResponse monitor_vm(project_id, id)
Monitor
from __future__ import print_function
import time
import src.cudo_compute
from src.cudo_compute.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = src.cudo_compute.VirtualMachinesApi()
project_id = 'project_id_example' # str |
id = 'id_example' # str |
try:
# Monitor
api_response = api_instance.monitor_vm(project_id, id)
pprint(api_response)
except ApiException as e:
print("Exception when calling VirtualMachinesApi->monitor_vm: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| project_id | str | ||
| id | str |
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
RebootVMResponse reboot_vm(project_id, id)
Reboot
from __future__ import print_function
import time
import src.cudo_compute
from src.cudo_compute.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = src.cudo_compute.VirtualMachinesApi()
project_id = 'project_id_example' # str |
id = 'id_example' # str |
try:
# Reboot
api_response = api_instance.reboot_vm(project_id, id)
pprint(api_response)
except ApiException as e:
print("Exception when calling VirtualMachinesApi->reboot_vm: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| project_id | str | ||
| id | str |
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ResizeVMResponse resize_vm(project_id, id, vcpus=vcpus, memory_gib=memory_gib)
Resize vCPU and memory of VM
from __future__ import print_function
import time
import src.cudo_compute
from src.cudo_compute.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = src.cudo_compute.VirtualMachinesApi()
project_id = 'project_id_example' # str |
id = 'id_example' # str |
vcpus = 789 # int | (optional)
memory_gib = 789 # int | (optional)
try:
# Resize vCPU and memory of VM
api_response = api_instance.resize_vm(project_id, id, vcpus=vcpus, memory_gib=memory_gib)
pprint(api_response)
except ApiException as e:
print("Exception when calling VirtualMachinesApi->resize_vm: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| project_id | str | ||
| id | str | ||
| vcpus | int | [optional] | |
| memory_gib | int | [optional] |
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ResizeVMDiskResponse resize_vm_disk(project_id, id, disk_id=disk_id, size_gib=size_gib)
Resize a VM's disk
from __future__ import print_function
import time
import src.cudo_compute
from src.cudo_compute.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = src.cudo_compute.VirtualMachinesApi()
project_id = 'project_id_example' # str |
id = 'id_example' # str |
disk_id = 'disk_id_example' # str | (optional)
size_gib = 56 # int | (optional)
try:
# Resize a VM's disk
api_response = api_instance.resize_vm_disk(project_id, id, disk_id=disk_id, size_gib=size_gib)
pprint(api_response)
except ApiException as e:
print("Exception when calling VirtualMachinesApi->resize_vm_disk: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| project_id | str | ||
| id | str | ||
| disk_id | str | [optional] | |
| size_gib | int | [optional] |
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
StartVMResponse start_vm(project_id, id)
Start
from __future__ import print_function
import time
import src.cudo_compute
from src.cudo_compute.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = src.cudo_compute.VirtualMachinesApi()
project_id = 'project_id_example' # str |
id = 'id_example' # str |
try:
# Start
api_response = api_instance.start_vm(project_id, id)
pprint(api_response)
except ApiException as e:
print("Exception when calling VirtualMachinesApi->start_vm: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| project_id | str | ||
| id | str |
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
StopVMResponse stop_vm(project_id, id)
Stop
from __future__ import print_function
import time
import src.cudo_compute
from src.cudo_compute.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = src.cudo_compute.VirtualMachinesApi()
project_id = 'project_id_example' # str |
id = 'id_example' # str |
try:
# Stop
api_response = api_instance.stop_vm(project_id, id)
pprint(api_response)
except ApiException as e:
print("Exception when calling VirtualMachinesApi->stop_vm: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| project_id | str | ||
| id | str |
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
TerminateVMResponse terminate_vm(project_id, id)
Terminate
from __future__ import print_function
import time
import src.cudo_compute
from src.cudo_compute.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = src.cudo_compute.VirtualMachinesApi()
project_id = 'project_id_example' # str |
id = 'id_example' # str |
try:
# Terminate
api_response = api_instance.terminate_vm(project_id, id)
pprint(api_response)
except ApiException as e:
print("Exception when calling VirtualMachinesApi->terminate_vm: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| project_id | str | ||
| id | str |
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
UpdatePrivateVMImageResponse update_private_vm_image(project_id, id, description=description)
Update private VM image
from __future__ import print_function
import time
import src.cudo_compute
from src.cudo_compute.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = src.cudo_compute.VirtualMachinesApi()
project_id = 'project_id_example' # str |
id = 'id_example' # str |
description = 'description_example' # str | (optional)
try:
# Update private VM image
api_response = api_instance.update_private_vm_image(project_id, id, description=description)
pprint(api_response)
except ApiException as e:
print("Exception when calling VirtualMachinesApi->update_private_vm_image: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| project_id | str | ||
| id | str | ||
| description | str | [optional] |
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
UpdateVMMetadataResponse update_vm_metadata(project_id, id, update_vm_metadata_body)
Update VM metadata
from __future__ import print_function
import time
import src.cudo_compute
from src.cudo_compute.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = src.cudo_compute.VirtualMachinesApi()
project_id = 'project_id_example' # str |
id = 'id_example' # str |
update_vm_metadata_body = src.cudo_compute.UpdateVMMetadataBody() # UpdateVMMetadataBody |
try:
# Update VM metadata
api_response = api_instance.update_vm_metadata(project_id, id, update_vm_metadata_body)
pprint(api_response)
except ApiException as e:
print("Exception when calling VirtualMachinesApi->update_vm_metadata: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| project_id | str | ||
| id | str | ||
| update_vm_metadata_body | UpdateVMMetadataBody |
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]