DataCenters

These are the endpoints for DataCenters. 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 'Accept: application/json'

Response

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

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 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
    "id": "string",
    "lngLat": "object",
    "oneFrontendId": "string",
    "regionId": "string",
    "renewableEnergy": "boolean",
    "supplierName": "string"
}'

Response

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

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

Update data center

Updates a data center

Body attributes

  • Name
    lngLat
    Type
    object
    Description
  • Name
    oneFrontendId
    Type
    string
    Description
  • Name
    regionId
    Type
    string
    Description
  • Name
    renewableEnergy
    Type
    boolean
    Description
  • Name
    supplierName
    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 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
    "lngLat": "object",
    "oneFrontendId": "string",
    "regionId": "string",
    "renewableEnergy": "boolean",
    "supplierName": "string"
}'

Response

{
    "createBy": "string",
    "id": "string",
    "lngLat": {
        "lat": "number",
        "lng": "number"
    },
    "oneFrontendId": "string",
    "regionId": "string",
    "renewableEnergy": "boolean",
    "supplierName": "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 'Accept: application/json'

Response

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

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 '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 'Accept: application/json'

Response

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

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 'Accept: application/json'

Response

{
    "createBy": "string",
    "id": "string",
    "lngLat": {
        "lat": "number",
        "lng": "number"
    },
    "oneFrontendId": "string",
    "regionId": "string",
    "renewableEnergy": "boolean",
    "supplierName": "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 'Accept: application/json'

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 'Accept: application/json'

Response

{
    "cpuUtilization": "number",
    "gpuFree": "integer",
    "gpuTotal": "integer",
    "gpuUsed": "integer",
    "gpuUtilization": "number",
    "memoryGibFree": "integer",
    "memoryGibTotal": "integer",
    "memoryGibUsed": "integer",
    "memoryUtilization": "number",
    "utilization": "number",
    "vcpuFree": "integer",
    "vcpuTotal": "integer",
    "vcpuUsed": "integer"
}

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 'Accept: application/json'

Response

{
    "timeRevenue": [
        {
            "revenueUsd": {
                "value": "string"
            },
            "time": "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 'Accept: application/json'

Response

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