Skip to main content
GET
/
v1
/
projects
/
{projectId}
/
vms
List virtual machines
curl --request GET \
  --url https://rest.compute.cudo.org/v1/projects/{projectId}/vms \
  --header 'Authorization: <api-key>'
{
  "VMs": [
    {
      "authorizedSshKeys": "<string>",
      "bootDisk": {
        "createTime": "2023-11-07T05:31:56Z",
        "dataCenterId": "<string>",
        "diskState": "UNKNOWN",
        "diskType": "DISK_TYPE_UNKNOWN",
        "id": "<string>",
        "privateImageId": "<string>",
        "projectId": "<string>",
        "publicImageId": "<string>",
        "sizeGib": 123,
        "vmId": "<string>"
      },
      "bootDiskSizeGib": 123,
      "commitmentEndTime": "2023-11-07T05:31:56Z",
      "commitmentTerm": "COMMITMENT_TERM_NONE",
      "cpuModel": "<string>",
      "createBy": "<string>",
      "createTime": "2023-11-07T05:31:56Z",
      "datacenterId": "<string>",
      "expireTime": "2023-11-07T05:31:56Z",
      "externalIpAddress": "<string>",
      "gpuModel": "<string>",
      "gpuModelId": "<string>",
      "gpuQuantity": 123,
      "id": "<string>",
      "imageId": "<string>",
      "imageName": "<string>",
      "internalIpAddress": "<string>",
      "machineType": "<string>",
      "memory": 123,
      "metadata": {},
      "nics": [
        {
          "externalIpAddress": "<string>",
          "internalIpAddress": "<string>",
          "networkAddress": "<string>",
          "networkId": "<string>",
          "securityGroupIds": [
            "<string>"
          ]
        }
      ],
      "price": {
        "gpuPriceHr": {
          "value": "<string>"
        },
        "ipv4AddressPriceHr": {
          "value": "<string>"
        },
        "memoryGibPriceHr": {
          "value": "<string>"
        },
        "storageGibPriceHr": {
          "value": "<string>"
        },
        "totalGpuPriceHr": {
          "value": "<string>"
        },
        "totalMemoryPriceHr": {
          "value": "<string>"
        },
        "totalPriceHr": {
          "value": "<string>"
        },
        "totalStoragePriceHr": {
          "value": "<string>"
        },
        "totalVcpuPriceHr": {
          "value": "<string>"
        },
        "vcpuPriceHr": {
          "value": "<string>"
        }
      },
      "privateImageId": "<string>",
      "projectId": "<string>",
      "publicImageId": "<string>",
      "publicImageName": "<string>",
      "publicIpAddress": "<string>",
      "renewableEnergy": true,
      "rules": [
        {
          "icmpType": "<string>",
          "id": "<string>",
          "ipRangeCidr": "<string>",
          "ports": "<string>",
          "protocol": "PROTOCOL_UNKNOWN",
          "ruleType": "RULE_TYPE_UNKNOWN"
        }
      ],
      "securityGroupIds": [
        "<string>"
      ],
      "securityGroups": [
        {
          "dataCenterId": "<string>",
          "description": "<string>",
          "id": "<string>",
          "projectId": "<string>",
          "rules": [
            {
              "icmpType": "<string>",
              "id": "<string>",
              "ipRangeCidr": "<string>",
              "ports": "<string>",
              "protocol": "PROTOCOL_UNKNOWN",
              "ruleType": "RULE_TYPE_UNKNOWN"
            }
          ]
        }
      ],
      "shortState": "<string>",
      "sshKeySource": "SSH_KEY_SOURCE_UNKNOWN",
      "state": "CLONING",
      "storageDisks": [
        {
          "createTime": "2023-11-07T05:31:56Z",
          "dataCenterId": "<string>",
          "diskState": "UNKNOWN",
          "diskType": "DISK_TYPE_UNKNOWN",
          "id": "<string>",
          "privateImageId": "<string>",
          "projectId": "<string>",
          "publicImageId": "<string>",
          "sizeGib": 123,
          "vmId": "<string>"
        }
      ],
      "vcpus": 123
    }
  ]
}

Authorizations

Authorization
string
header
required

Bearer HTTP authentication. Allowed headers-- Authorization: Bearer <api_key>

Path Parameters

projectId
string
required

Query Parameters

networkId
string

Response

A successful response.

VMs
object[]