Resources

API reference for Resources on CUDO Compute.

Reference
GET
/v1/resources/search

Search accessible resources

Path attributes

  • Name
    query
    Type
    string
    Description
Request
GET
/v1/resources/search
    
    curl 'https://rest.compute.cudo.org/v1/resources/search' \
-H 'Authorization: bearer <YOUR-API-KEY>'\
-H 'Accept: application/json'

    
  
Response
    
    {
  "results": [
    {
      "resourceType": "string",
      "resourceName": "string",
      "score": "number",
      "billingAccount": {
        "id": "string",
        "displayName": "string",
        "createTime": "string"
      },
      "project": {
        "id": "string",
        "billingAccountId": "string",
        "resourceCount": "integer",
        "createBy": "string"
      },
      "virtualMachine": {
        "projectId": "string",
        "id": "string",
        "dataCenterId": "string",
        "gpuModelId": "string",
        "gpus": "integer",
        "vcpus": "integer",
        "memoryGib": "integer",
        "bootDiskSizeGib": "integer",
        "bootDiskPublicImageId": "string",
        "bootDiskPrivateImageId": "string",
        "state": "string",
        "createTime": "string"
      },
      "disk": {
        "id": "string",
        "projectId": "string",
        "dataCenterId": "string",
        "vmId": "string",
        "sizeGib": "integer",
        "storageClass": "string",
        "diskType": "string",
        "publicImageId": "string",
        "privateImageId": "string",
        "createTime": "string",
        "diskState": "string"
      },
      "image": {
        "projectId": "string",
        "id": "string",
        "dataCenterId": "string",
        "sizeGib": "integer",
        "createTime": "string"
      },
      "network": {
        "projectId": "string",
        "id": "string",
        "dataCenterId": "string",
        "ipRange": "string",
        "gateway": "string",
        "priceHr": {
          "value": "string"
        },
        "externalIpAddress": "string",
        "internalIpAddress": "string",
        "vmState": "string",
        "createTime": "string",
        "state": "string"
      },
      "machine": {
        "projectId": "string",
        "id": "string",
        "dataCenterId": "string",
        "machineTypeId": "string",
        "architecture": "string",
        "state": "string",
        "powerState": "string",
        "ipv4Addresses": "integer",
        "externalIpAddresses": [
          "string"
        ],
        "os": "string",
        "cpuCores": "integer",
        "cpuSpeedMhz": "integer",
        "cpuModel": "string",
        "memoryGib": "integer",
        "disks": "integer",
        "diskSizeGib": "integer",
        "gpus": "integer",
        "gpuModelId": "string",
        "createTime": "string"
      },
      "cluster": {
        "projectId": "string",
        "id": "string",
        "dataCenterId": "string",
        "machineTypeId": "string",
        "machineCount": "integer",
        "commitmentTerm": "string",
        "commitmentEndTime": "string",
        "sshKeySource": "string",
        "customSshKeys": [
          "string"
        ],
        "startScript": "string",
        "state": "string",
        "architecture": "string",
        "cpuModel": "string",
        "cpuSpeedMhz": "integer",
        "gpuModelId": "string",
        "networkType": "string",
        "totalCpuCores": "integer",
        "totalDiskSizeGib": "integer",
        "totalGpus": "integer",
        "totalMemoryGib": "integer",
        "machinePriceHr": {
          "value": "string"
        },
        "totalMachinePriceHr": {
          "value": "string"
        },
        "totalPriceHr": {
          "value": "string"
        },
        "machines": [
          {
            "projectId": "string",
            "id": "string",
            "dataCenterId": "string",
            "machineTypeId": "string",
            "architecture": "string",
            "cpuCores": "integer",
            "cpuSpeedMhz": "integer",
            "cpuModel": "string",
            "memoryGib": "integer",
            "disks": "integer",
            "diskSizeGib": "integer",
            "gpus": "integer",
            "gpuModelId": "string",
            "externalIpAddress": "string",
            "internalIpAddress": "string",
            "powerState": "string",
            "state": "string",
            "priceHr": {
              "value": "string"
            },
            "createTime": "string",
            "createBy": "string",
            "volumeIds": [
              "string"
            ]
          }
        ],
        "createTime": "string",
        "createBy": "string"
      },
      "volume": {
        "projectId": "string",
        "id": "string",
        "dataCenterId": "string",
        "sizeGib": "integer",
        "sizeGibUsed": "integer",
        "nfsServer": "string",
        "nfsPath": "string",
        "state": "string",
        "gibPriceHr": {
          "value": "string"
        },
        "totalPriceHr": {
          "value": "string"
        },
        "commitmentTerm": "string",
        "commitmentEndTime": "string"
      }
    }
  ]
}