Skip to main content
POST
/
v1
/
projects
/
{projectId}
/
clusters
Create a cluster
curl --request POST \
  --url https://rest.compute.cudo.org/v1/projects/{projectId}/clusters \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "commitmentTerm": "COMMITMENT_TERM_NONE",
  "customSshKeys": [
    "<string>"
  ],
  "dataCenterId": "<string>",
  "id": "<string>",
  "machineCount": 123,
  "machinePriceHr": {
    "value": "<string>"
  },
  "machineTypeId": "<string>",
  "networkType": "NETWORK_TYPE_UNSPECIFIED",
  "sshKeySource": "SSH_KEY_SOURCE_UNKNOWN",
  "startScript": "<string>",
  "state": "STATE_UNSPECIFIED",
  "totalMachinePriceHr": {
    "value": "<string>"
  },
  "totalPriceHr": {
    "value": "<string>"
  }
}'
{
  "architecture": "<string>",
  "commitmentEndTime": "2023-11-07T05:31:56Z",
  "commitmentTerm": "COMMITMENT_TERM_NONE",
  "cpuModel": "<string>",
  "cpuSpeedMhz": 123,
  "createBy": "<string>",
  "createTime": "2023-11-07T05:31:56Z",
  "customSshKeys": [
    "<string>"
  ],
  "dataCenterId": "<string>",
  "gpuModelId": "<string>",
  "id": "<string>",
  "machineCount": 123,
  "machinePriceHr": {
    "value": "<string>"
  },
  "machineTypeId": "<string>",
  "machines": [
    {
      "architecture": "<string>",
      "cpuCores": 123,
      "cpuModel": "<string>",
      "cpuSpeedMhz": 123,
      "createBy": "<string>",
      "createTime": "2023-11-07T05:31:56Z",
      "dataCenterId": "<string>",
      "diskSizeGib": 123,
      "disks": 123,
      "externalIpAddress": "<string>",
      "gpuModelId": "<string>",
      "gpus": 123,
      "id": "<string>",
      "internalIpAddress": "<string>",
      "machineTypeId": "<string>",
      "memoryGib": 123,
      "powerState": "MACHINE_POWER_STATE_UNSPECIFIED",
      "priceHr": {
        "value": "<string>"
      },
      "projectId": "<string>",
      "state": "STATE_UNSPECIFIED",
      "volumeIds": [
        "<string>"
      ]
    }
  ],
  "networkType": "NETWORK_TYPE_UNSPECIFIED",
  "projectId": "<string>",
  "sshKeySource": "SSH_KEY_SOURCE_UNKNOWN",
  "startScript": "<string>",
  "state": "STATE_UNSPECIFIED",
  "totalCpuCores": 123,
  "totalDiskSizeGib": 123,
  "totalGpus": 123,
  "totalMachinePriceHr": {
    "value": "<string>"
  },
  "totalMemoryGib": 123,
  "totalPriceHr": {
    "value": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
projectId
string
required

Body

application/json

Create cluster params

​
dataCenterId
string
required
​
id
string
required
​
machineCount
integer
required
​
machineTypeId
string
required
​
commitmentTerm
enum<string>
default:COMMITMENT_TERM_NONE
Available options:
COMMITMENT_TERM_NONE,
COMMITMENT_TERM_1_MONTH,
COMMITMENT_TERM_3_MONTHS,
COMMITMENT_TERM_6_MONTHS,
COMMITMENT_TERM_12_MONTHS,
COMMITMENT_TERM_24_MONTHS,
COMMITMENT_TERM_36_MONTHS,
COMMITMENT_TERM_60_MONTHS
​
customSshKeys
string[]
​
machinePriceHr
object

A representation of a decimal value, such as 2.5. Clients may convert values into language-native decimal formats, such as Java's BigDecimal or Python's decimal.Decimal.

​
networkType
enum<string>
default:NETWORK_TYPE_UNSPECIFIED
Available options:
NETWORK_TYPE_UNSPECIFIED,
ETHERNET,
INFINIBAND
​
sshKeySource
enum<string>
default:SSH_KEY_SOURCE_UNKNOWN
Available options:
SSH_KEY_SOURCE_UNKNOWN,
SSH_KEY_SOURCE_PROJECT,
SSH_KEY_SOURCE_USER,
SSH_KEY_SOURCE_NONE
​
startScript
string
​
state
enum<string>
default:STATE_UNSPECIFIED
Available options:
STATE_UNSPECIFIED,
CREATING,
ACTIVE,
UPDATING,
DELETING,
FAILED
​
totalMachinePriceHr
object

A representation of a decimal value, such as 2.5. Clients may convert values into language-native decimal formats, such as Java's BigDecimal or Python's decimal.Decimal.

​
totalPriceHr
object

A representation of a decimal value, such as 2.5. Clients may convert values into language-native decimal formats, such as Java's BigDecimal or Python's decimal.Decimal.

Response

A successful response.

​
dataCenterId
string
required
​
id
string
required
​
machineCount
integer
required
​
machineTypeId
string
required
​
projectId
string
required
​
architecture
string
​
commitmentEndTime
string<date-time>
​
commitmentTerm
enum<string>
default:COMMITMENT_TERM_NONE
Available options:
COMMITMENT_TERM_NONE,
COMMITMENT_TERM_1_MONTH,
COMMITMENT_TERM_3_MONTHS,
COMMITMENT_TERM_6_MONTHS,
COMMITMENT_TERM_12_MONTHS,
COMMITMENT_TERM_24_MONTHS,
COMMITMENT_TERM_36_MONTHS,
COMMITMENT_TERM_60_MONTHS
​
cpuModel
string
​
cpuSpeedMhz
integer
​
createBy
string
​
createTime
string<date-time>
​
customSshKeys
string[]
​
gpuModelId
string
​
machinePriceHr
object

A representation of a decimal value, such as 2.5. Clients may convert values into language-native decimal formats, such as Java's BigDecimal or Python's decimal.Decimal.

​
machines
object[]
​
networkType
enum<string>
default:NETWORK_TYPE_UNSPECIFIED
Available options:
NETWORK_TYPE_UNSPECIFIED,
ETHERNET,
INFINIBAND
​
sshKeySource
enum<string>
default:SSH_KEY_SOURCE_UNKNOWN
Available options:
SSH_KEY_SOURCE_UNKNOWN,
SSH_KEY_SOURCE_PROJECT,
SSH_KEY_SOURCE_USER,
SSH_KEY_SOURCE_NONE
​
startScript
string
​
state
enum<string>
default:STATE_UNSPECIFIED
Available options:
STATE_UNSPECIFIED,
CREATING,
ACTIVE,
UPDATING,
DELETING,
FAILED
​
totalCpuCores
integer
​
totalDiskSizeGib
integer
​
totalGpus
integer
​
totalMachinePriceHr
object

A representation of a decimal value, such as 2.5. Clients may convert values into language-native decimal formats, such as Java's BigDecimal or Python's decimal.Decimal.

​
totalMemoryGib
integer
​
totalPriceHr
object

A representation of a decimal value, such as 2.5. Clients may convert values into language-native decimal formats, such as Java's BigDecimal or Python's decimal.Decimal.