Data Centers

These are the endpoints for Data Centers. More information coming soon.

GET

/v1/data-centers

List data centers

Returns the data centers in an organization

Path attributes

Name
pageToken
Type
string
Description
Name
pageSize
Type
integer
Description

Request

GET

/v1/data-centers

curl 'https://rest.compute.cudo.org/v1/data-centers' \
-H 'Authorization: bearer <YOUR-API-KEY>'\
-H 'Accept: application/json'

Response

{
  "dataCenters": [
    {
      "id": "string",
      "regionId": "string",
      "supplierName": "string",
      "renewableEnergy": "boolean",
      "lngLat": {
        "lat": "number",
        "lng": "number"
      },
      "createBy": "string",
      "oneFrontendId": "string",
      "s3Endpoint": "string"
    }
  ],
  "pageToken": "string",
  "pageSize": "integer"
}

POST

/v1/data-centers

Create data center

Creates a new data center

Request

POST

/v1/data-centers

curl 'https://rest.compute.cudo.org/v1/data-centers' \
-H 'Authorization: bearer <YOUR-API-KEY>'\
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
    "id": "string",
    "regionId": "string",
    "supplierName": "string",
    "renewableEnergy": "boolean",
    "lngLat": "object",
    "oneFrontendId": "string",
    "s3Endpoint": "string"
}'

Response

{
  "id": "string",
  "regionId": "string",
  "supplierName": "string",
  "renewableEnergy": "boolean",
  "lngLat": {
    "lat": "number",
    "lng": "number"
  },
  "createBy": "string",
  "oneFrontendId": "string",
  "s3Endpoint": "string"
}

PATCH

/v1/data-centers/{dataCenter.id}

Update data center

Updates a data center

Body attributes

Name
dataCenter
Type
object
Description
Name
updateMask
Type
string
Description

Path attributes

Name
dataCenter.id
Type
string
Description

Request

PATCH

/v1/data-centers/{dataCenter.id}

curl 'https://rest.compute.cudo.org/v1/data-centers/{dataCenter.id}' \
-H 'Authorization: bearer <YOUR-API-KEY>'\
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
    "dataCenter": "object",
    "updateMask": "string"
}'

Response

{
  "id": "string",
  "regionId": "string",
  "supplierName": "string",
  "renewableEnergy": "boolean",
  "lngLat": {
    "lat": "number",
    "lng": "number"
  },
  "createBy": "string",
  "oneFrontendId": "string",
  "s3Endpoint": "string"
}

GET

/v1/data-centers/{dataCenterId}/clusters

List clusters

Returns the clusters in a data center

Path attributes

Name
dataCenterId
Type
string
Description

Request

GET

/v1/data-centers/{dataCenterId}/clusters

curl 'https://rest.compute.cudo.org/v1/data-centers/{dataCenterId}/clusters' \
-H 'Authorization: bearer <YOUR-API-KEY>'\
-H 'Accept: application/json'

Response

{
  "clusters": [
    {
      "machineType": "string",
      "cpuModel": "string",
      "vcpuPerCpuThread": "integer",
      "vcpuPriceHr": {
        "value": "string"
      },
      "memoryGibPriceHr": {
        "value": "string"
      },
      "gpuModel": "string",
      "gpuModelId": "string",
      "gpuModelPciTypes": [
        "string"
      ],
      "gpuPriceHr": {
        "value": "string"
      },
      "minVcpuPerMemoryGib": "number",
      "maxVcpuPerMemoryGib": "number",
      "minVcpuPerGpu": "number",
      "maxVcpuPerGpu": "number",
      "createTime": "string",
      "updateTime": "string",
      "hostCount": "integer",
      "hostProblemCount": "integer",
      "vmCount": "integer",
      "vcpuFree": "integer",
      "vcpuUsed": "integer",
      "memoryGibFree": "integer",
      "memoryGibUsed": "integer",
      "gpuFree": "integer",
      "gpuUsed": "integer",
      "minVcpu": "number",
      "minMemoryGib": "number"
    }
  ]
}

GET

/v1/data-centers/{dataCenterId}/host-count

Get host count

Returns the number of hosts in a data center

Path attributes

Name
dataCenterId
Type
string
Description

Request

GET

/v1/data-centers/{dataCenterId}/host-count

curl 'https://rest.compute.cudo.org/v1/data-centers/{dataCenterId}/host-count' \
-H 'Authorization: bearer <YOUR-API-KEY>'\
-H 'Accept: application/json'

Response

{
  "count": "integer"
}

GET

/v1/data-centers/{dataCenterId}/hosts

List hosts

Returns the hosts in a data center

Path attributes

Name
dataCenterId
Type
string
Description

Request

GET

/v1/data-centers/{dataCenterId}/hosts

curl 'https://rest.compute.cudo.org/v1/data-centers/{dataCenterId}/hosts' \
-H 'Authorization: bearer <YOUR-API-KEY>'\
-H 'Accept: application/json'

Response

{
  "hosts": [
    {
      "machineType": "string",
      "cpuModel": "string",
      "vcpuPerCpuThread": "integer",
      "gpuModel": "string",
      "gpuModelId": "string",
      "createTime": "string",
      "updateTime": "string",
      "vmCount": "integer",
      "vcpuFree": "integer",
      "vcpuUsed": "integer",
      "memoryGibFree": "integer",
      "memoryGibUsed": "integer",
      "gpuFree": "integer",
      "gpuUsed": "integer",
      "online": "boolean",
      "name": "string"
    }
  ]
}

GET

/v1/data-centers/{id}

Get data center

Returns a data center

Path attributes

Name
id
Type
string
Description

Request

GET

/v1/data-centers/{id}

curl 'https://rest.compute.cudo.org/v1/data-centers/{id}' \
-H 'Authorization: bearer <YOUR-API-KEY>'\
-H 'Accept: application/json'

Response

{
  "id": "string",
  "regionId": "string",
  "supplierName": "string",
  "renewableEnergy": "boolean",
  "lngLat": {
    "lat": "number",
    "lng": "number"
  },
  "createBy": "string",
  "oneFrontendId": "string",
  "s3Endpoint": "string"
}

DELETE

/v1/data-centers/{id}

Delete data center

Deletes a data center

Path attributes

Name
id
Type
string
Description

Request

DELETE

/v1/data-centers/{id}

curl 'https://rest.compute.cudo.org/v1/data-centers/{id}' \
-H 'Authorization: bearer <YOUR-API-KEY>'\
-H 'Accept: application/json'

Response

{}

GET

/v1/data-centers/{id}/live-utilization

Get live utilization

Returns the live utilization of a data center

Path attributes

Name
id
Type
string
Description

Request

GET

/v1/data-centers/{id}/live-utilization

curl 'https://rest.compute.cudo.org/v1/data-centers/{id}/live-utilization' \
-H 'Authorization: bearer <YOUR-API-KEY>'\
-H 'Accept: application/json'

Response

{
  "utilization": "number",
  "vcpuUsed": "integer",
  "vcpuFree": "integer",
  "vcpuTotal": "integer",
  "cpuUtilization": "number",
  "memoryGibUsed": "integer",
  "memoryGibFree": "integer",
  "memoryGibTotal": "integer",
  "memoryUtilization": "number",
  "gpuUsed": "integer",
  "gpuFree": "integer",
  "gpuTotal": "integer",
  "gpuUtilization": "number",
  "ipv4Used": "integer",
  "ipv4Free": "integer",
  "ipv4Total": "integer",
  "ipv4Utilization": "number",
  "storageGibUsed": "integer",
  "storageGibFree": "integer",
  "storageGibTotal": "integer",
  "storageUtilization": "number"
}

GET

/v1/data-centers/{id}/revenue

Get revenue time series

Returns the revenue of a data center over time

Path attributes

Name
id
Type
string
Description
Name
startTime
Type
string
Description
Name
endTime
Type
string
Description
Name
interval
Type
string
Description

Request

GET

/v1/data-centers/{id}/revenue

curl 'https://rest.compute.cudo.org/v1/data-centers/{id}/revenue' \
-H 'Authorization: bearer <YOUR-API-KEY>'\
-H 'Accept: application/json'

Response

{
  "timeRevenue": [
    {
      "time": "string",
      "revenueUsd": {
        "value": "string"
      }
    }
  ]
}

GET

/v1/data-centers/{id}/revenue-by-resource

Get revenue by resource

Returns the revenue of a data center by resource (CPU, Memory, Storage, etc.)

Path attributes

Name
id
Type
string
Description
Name
startTime
Type
string
Description
Name
endTime
Type
string
Description

Request

GET

/v1/data-centers/{id}/revenue-by-resource

curl 'https://rest.compute.cudo.org/v1/data-centers/{id}/revenue-by-resource' \
-H 'Authorization: bearer <YOUR-API-KEY>'\
-H 'Accept: application/json'

Response

{
  "resources": [
    {
      "resourceType": "string",
      "resourceId": "string",
      "quantity": {
        "value": "string"
      },
      "unit": "string",
      "revenueUsd": {
        "value": "string"
      }
    }
  ]
}

Rest ApiBilling

Rest ApiDisks