Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

CUDO Compute Virtual Machines API

The Virtual Machines API from CUDO Compute — 10 operation(s) for virtual machines.

CUDO Compute Virtual Machines API is one of 8 APIs that CUDO Compute publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Virtual Machines. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 10 operations across 10 paths, and defines 6 schemas. It is described by OpenAPI 3.0.1, at version 1.0.0.

Requests are made against a single base URL, https://rest.compute.cudo.org.

10 operations 10 paths 6 schemas 4 GET6 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.0.0
Base URL
https://rest.compute.cudo.org
Authentication
HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 1

CUDO Compute Virtual Machines API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — A CUDO Compute API key passed as a Bearer token in the Authorization header, e.g. Authorization: Bearer $CUDOAPIKEY. Create keys in the CUDO Compute dashboard.…

Paths & Operations 10

Across 10 paths, the API surfaces 10 operations — 4 GET, 6 POST. Each is listed below with its method, path, parameters, and response codes.

Virtual Machines 10
POST
/v1/projects/{projectId}/vm
Create a virtual machine
createVM 1 param body → 200401
GET
/v1/projects/{projectId}/vms
List virtual machines
listVMs 3 params → 200401
GET
/v1/projects/{projectId}/vms/{id}
Get a virtual machine
getVM 2 params → 200401
POST
/v1/projects/{projectId}/vms/{id}/start
Start a virtual machine
startVM 2 params → 200401
POST
/v1/projects/{projectId}/vms/{id}/stop
Stop a virtual machine
stopVM 2 params → 200401
POST
/v1/projects/{projectId}/vms/{id}/reboot
Reboot a virtual machine
rebootVM 2 params → 200401
POST
/v1/projects/{projectId}/vms/{id}/resize
Resize a virtual machine
resizeVM 2 params body → 200401
POST
/v1/projects/{projectId}/vms/{id}/terminate
Terminate a virtual machine
terminateVM 2 params → 200401
GET
/v1/projects/{projectId}/vms/{id}/connect
Get virtual machine connection details
connectVM 2 params → 200401
GET
/v1/projects/{projectId}/vms/{id}/monitor
Get virtual machine monitoring metrics
monitorVM 2 params → 200401

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are VM (14 properties), CreateVMBody (13 properties), Disk (8 properties), Error (3 properties). Each schema is shown below with its type and property counts.

ListVMsResponse
object
1 property
CreateVMResponse
object
2 properties
Disk
object
8 properties
VM
object
14 properties
Error
object
3 properties
CreateVMBody
object
13 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cudo-compute-virtual-machines-api-openapi.yml Raw ↑

Other APIs CUDO Compute publishes across the network.

CUDO Compute Billing API
CUDO Compute Data Centers API
CUDO Compute Disks API
CUDO Compute Images API
CUDO Compute Machine Types API
CUDO Compute Networks API
CUDO Compute SSH Keys API