Cudo Compute logoDocumentation

Virtual Machines

These are the endpoints for Virtual Machines. More information coming soon.

GET/v1/projects/{projectId}/count-vms

Count

Description for this endpoint is coming soon.

Path attributes

  • Name
    projectId
    Type
    string
    Description

Request

GET
/v1/projects/{projectId}/count-vms
curl 'https://rest.compute.cudo.org/v1/projects/{projectId}/count-vms' \
-H 'Accept: application/json'

Response

{
    "count": "integer"
}
GET/v1/projects/{projectId}/images

List private VM images

Description for this endpoint is coming soon.

Path attributes

  • Name
    projectId
    Type
    string
    Description
  • Name
    pageNumber
    Type
    integer
    Description
  • Name
    pageSize
    Type
    integer
    Description

Request

GET
/v1/projects/{projectId}/images
curl 'https://rest.compute.cudo.org/v1/projects/{projectId}/images' \
-H 'Accept: application/json'

Response

{
    "images": "array",
    "pageNumber": "integer",
    "pageSize": "integer",
    "totalCount": "integer"
}
POST/v1/projects/{projectId}/images

Create private VM image

Description for this endpoint is coming soon.

Path attributes

  • Name
    projectId
    Type
    string
    Description
  • Name
    vmId
    Type
    string
    Description
  • Name
    id
    Type
    string
    Description
  • Name
    description
    Type
    string
    Description

Request

POST
/v1/projects/{projectId}/images
curl 'https://rest.compute.cudo.org/v1/projects/{projectId}/images' \
-H 'Accept: application/json'
POST/v1/projects/{projectId}/images/{id}

Update private VM image

Description for this endpoint is coming soon.

Path attributes

  • Name
    projectId
    Type
    string
    Description
  • Name
    id
    Type
    string
    Description
  • Name
    description
    Type
    string
    Description

Request

POST
/v1/projects/{projectId}/images/{id}
curl 'https://rest.compute.cudo.org/v1/projects/{projectId}/images/{id}' \
-H 'Accept: application/json'
DELETE/v1/projects/{projectId}/images/{id}

Delete private VM image

Description for this endpoint is coming soon.

Path attributes

  • Name
    projectId
    Type
    string
    Description
  • Name
    id
    Type
    string
    Description

Request

DELETE
/v1/projects/{projectId}/images/{id}
curl 'https://rest.compute.cudo.org/v1/projects/{projectId}/images/{id}' \
-H 'Accept: application/json'
POST/v1/projects/{projectId}/vm

Create virtual machine

Description for this endpoint is coming soon.

Body attributes

  • Name
    bootDisk
    Type
    object
    Description
  • Name
    bootDiskImageId
    Type
    string
    Description
  • Name
    cpuModel
    Type
    string
    Description
  • Name
    customSshKeys
    Type
    array
    Description
  • Name
    dataCenterId
    Type
    string
    Description
  • Name
    gpuModel
    Type
    string
    Description
  • Name
    gpus
    Type
    integer
    Description
  • Name
    machineType
    Type
    string
    Description
  • Name
    maxPriceHr
    Type
    object
    Description
  • Name
    memoryGib
    Type
    integer
    Description
  • Name
    nics
    Type
    array
    Description
  • Name
    password
    Type
    string
    Description
  • Name
    securityGroupIds
    Type
    array
    Description
  • Name
    sshKeySource
    Type
    string
    Description
  • Name
    startScript
    Type
    string
    Description
  • Name
    vcpus
    Type
    integer
    Description
  • Name
    vmId
    Type
    string
    Description

Path attributes

  • Name
    projectId
    Type
    string
    Description

Request

POST
/v1/projects/{projectId}/vm
curl 'https://rest.compute.cudo.org/v1/projects/{projectId}/vm' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
    "bootDisk": "object",
    "bootDiskImageId": "string",
    "cpuModel": "string",
    "customSshKeys": "array",
    "dataCenterId": "string",
    "gpuModel": "string",
    "gpus": "integer",
    "machineType": "string",
    "maxPriceHr": "object",
    "memoryGib": "integer",
    "nics": "array",
    "password": "string",
    "securityGroupIds": "array",
    "sshKeySource": "string",
    "startScript": "string",
    "vcpus": "integer",
    "vmId": "string"
}'

Response

{
    "id": "string",
    "vm": "object"
}
GET/v1/projects/{projectId}/vms

List

Description for this endpoint is coming soon.

Path attributes

  • Name
    projectId
    Type
    string
    Description
  • Name
    status
    Type
    string
    Description
  • Name
    networkId
    Type
    string
    Description

Request

GET
/v1/projects/{projectId}/vms
curl 'https://rest.compute.cudo.org/v1/projects/{projectId}/vms' \
-H 'Accept: application/json'

Response

{
    "VMs": "array"
}
GET/v1/projects/{projectId}/vms/{id}

Get

Description for this endpoint is coming soon.

Path attributes

  • Name
    projectId
    Type
    string
    Description
  • Name
    id
    Type
    string
    Description

Request

GET
/v1/projects/{projectId}/vms/{id}
curl 'https://rest.compute.cudo.org/v1/projects/{projectId}/vms/{id}' \
-H 'Accept: application/json'

Response

{
    "VM": "object"
}
GET/v1/projects/{projectId}/vms/{id}/connect

Connect via VNC

Description for this endpoint is coming soon.

Path attributes

  • Name
    projectId
    Type
    string
    Description
  • Name
    id
    Type
    string
    Description
  • Name
    connectionId
    Type
    string
    Description

Request

GET
/v1/projects/{projectId}/vms/{id}/connect
curl 'https://rest.compute.cudo.org/v1/projects/{projectId}/vms/{id}/connect' \
-H 'Accept: application/json'

Response

{
    "connectUrl": "string",
    "token": "string"
}
GET/v1/projects/{projectId}/vms/{id}/monitor

Monitor

Description for this endpoint is coming soon.

Path attributes

  • Name
    projectId
    Type
    string
    Description
  • Name
    id
    Type
    string
    Description

Request

GET
/v1/projects/{projectId}/vms/{id}/monitor
curl 'https://rest.compute.cudo.org/v1/projects/{projectId}/vms/{id}/monitor' \
-H 'Accept: application/json'

Response

{
    "items": "array"
}
POST/v1/projects/{projectId}/vms/{id}/reboot

Reboot

Description for this endpoint is coming soon.

Path attributes

  • Name
    projectId
    Type
    string
    Description
  • Name
    id
    Type
    string
    Description

Request

POST
/v1/projects/{projectId}/vms/{id}/reboot
curl 'https://rest.compute.cudo.org/v1/projects/{projectId}/vms/{id}/reboot' \
-H 'Accept: application/json'
POST/v1/projects/{projectId}/vms/{id}/start

Start

Description for this endpoint is coming soon.

Path attributes

  • Name
    projectId
    Type
    string
    Description
  • Name
    id
    Type
    string
    Description

Request

POST
/v1/projects/{projectId}/vms/{id}/start
curl 'https://rest.compute.cudo.org/v1/projects/{projectId}/vms/{id}/start' \
-H 'Accept: application/json'
POST/v1/projects/{projectId}/vms/{id}/stop

Stop

Description for this endpoint is coming soon.

Path attributes

  • Name
    projectId
    Type
    string
    Description
  • Name
    id
    Type
    string
    Description

Request

POST
/v1/projects/{projectId}/vms/{id}/stop
curl 'https://rest.compute.cudo.org/v1/projects/{projectId}/vms/{id}/stop' \
-H 'Accept: application/json'
POST/v1/projects/{projectId}/vms/{id}/terminate

Terminate

Description for this endpoint is coming soon.

Path attributes

  • Name
    projectId
    Type
    string
    Description
  • Name
    id
    Type
    string
    Description

Request

POST
/v1/projects/{projectId}/vms/{id}/terminate
curl 'https://rest.compute.cudo.org/v1/projects/{projectId}/vms/{id}/terminate' \
-H 'Accept: application/json'
GET/v1/vms/data-centers

List data centers

Description for this endpoint is coming soon.

Path attributes

  • Name
    regionId
    Type
    array
    Description
  • Name
    renewableEnergy
    Type
    boolean
    Description

Request

GET
/v1/vms/data-centers
curl 'https://rest.compute.cudo.org/v1/vms/data-centers' \
-H 'Accept: application/json'

Response

{
    "dataCenters": "array"
}
GET/v1/vms/machine-types

List machine types

Description for this endpoint is coming soon.

Path attributes

  • Name
    cpuModel
    Type
    string
    Description
  • Name
    gpu
    Type
    integer
    Description
  • Name
    gpuModel
    Type
    string
    Description
  • Name
    memoryGib
    Type
    integer
    Description
  • Name
    orderBy
    Type
    string
    Description
  • Name
    pageNumber
    Type
    integer
    Description
  • Name
    pageSize
    Type
    integer
    Description
  • Name
    regionId
    Type
    string
    Description
  • Name
    storageGib
    Type
    integer
    Description
  • Name
    vcpu
    Type
    integer
    Description
  • Name
    dataCenterId
    Type
    string
    Description

Request

GET
/v1/vms/machine-types
curl 'https://rest.compute.cudo.org/v1/vms/machine-types' \
-H 'Accept: application/json'

Response

{
    "countVmAvailable": "integer",
    "cpuModels": "array",
    "dataCenters": "array",
    "gpuModels": "array",
    "hostConfigs": "array",
    "maxGpu": "integer",
    "maxMemoryGib": "integer",
    "maxVcpu": "integer",
    "request": "object"
}
GET/v1/vms/public-images

List public VM images

Description for this endpoint is coming soon.

Request

GET
/v1/vms/public-images
curl 'https://rest.compute.cudo.org/v1/vms/public-images' \
-H 'Accept: application/json'

Response

{
    "images": "array"
}