Sign in
latestOpenAPI 3.1.02026-08-23100133183.1 KB

0d66c7340876

Clusters

Deploy cluster

Deploy a new cluster.

Before deploying add at least one SSH key to enable access to your cluster.

Cluster types can be listed using the GET /v1/cluster-types endpoint. Image types can be listed using the GET /v1/images/cluster endpoint.

post/v1/clusters

Headers

user-agentstring required
cf-connecting-ipstring required

Request body

cluster_typestring required

Cluster instance type. Can be listed using the GET /v1/cluster-types endpoint.

imagestring required

OS image specification for the cluster. For a list of supported images, check GET /v1/images/cluster endpoint, "image_type" property.

startup_script_idstring

Startup script ID to run on cluster initialization

hostnamestring required
descriptionstring required
location_codestring required

Location code for the cluster and its shared volume

contract'PAY_AS_YOU_GO' | 'LONG_TERM'

Contract type. For clusters, only PAY_AS_YOU_GO currently supported.

extension_settings'auto_renew' | 'pay_as_you_go' | 'end_contract'

Extension settings for long-term contracts. Takes priority over auto_rental_extension and turn_to_pay_as_you_go.

auto_rental_extensionboolean

Deprecated: use extension_settings instead. Enable automatic rental extension for long-term contracts.

turn_to_pay_as_you_goboolean

Deprecated: use extension_settings instead. Automatically convert to pay-as-you-go after the long-term period ends.

Example request

{
  "cluster_type": "16H200",
  "image": "ubuntu-22.04-cuda-12.4-cluster",
  "startup_script_id": "1ce9bb88-9fac-4ade-87be-8e3f3eb030fc",
  "hostname": "dark-vm-shrinks-fin-01",
  "description": "ubuntu-22-04-cuda-12-4-16b200-fin-01",
  "tags": [
    {
      "key": "environment",
      "value": "production"
    },
    {
      "key": "benchmark"
    }
  ],
  "location_code": "FIN-01",
  "contract": "PAY_AS_YOU_GO",
  "shared_volume": {
    "name": "SFS-pmAna3o2",
    "size": 30000
  },
  "existing_volumes": []
}

Response

Cluster deployed

idstring required

Example response

{
  "id": "a5ca0753-53e5-4d8c-bf34-a09b0f213c51"
}