Update virtual GPU cluster

curl --request PATCH \
  --url https://api.gcore.com/cloud/v3/gpu/virtual/{project_id}/{region_id}/clusters/{cluster_id} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "gpu-cluster-1",
  "servers_settings": {
    "credentials": {
      "ssh_key_name": "my-ssh-key"
    },
    "user_data": "eyJ0ZXN0IjogImRhdGEifQ==",
    "volumes": [
      {
        "boot_index": 1,
        "name": "my-data-disk",
        "size": 100,
        "source": "<string>",
        "delete_on_termination": true,
        "tags": {
          "key1": "value1"
        }
      }
    ]
  },
  "tags": {
    "my-tag": "my-tag-value",
    "my-tag-to-remove": null
  }
}
'

import requests

url = "https://api.gcore.com/cloud/v3/gpu/virtual/{project_id}/{region_id}/clusters/{cluster_id}"

payload = {
    "name": "gpu-cluster-1",
    "servers_settings": {
        "credentials": { "ssh_key_name": "my-ssh-key" },
        "user_data": "eyJ0ZXN0IjogImRhdGEifQ==",
        "volumes": [
            {
                "boot_index": 1,
                "name": "my-data-disk",
                "size": 100,
                "source": "<string>",
                "delete_on_termination": True,
                "tags": { "key1": "value1" }
            }
        ]
    },
    "tags": {
        "my-tag": "my-tag-value",
        "my-tag-to-remove": None
    }
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'gpu-cluster-1',
    servers_settings: {
      credentials: {ssh_key_name: 'my-ssh-key'},
      user_data: 'eyJ0ZXN0IjogImRhdGEifQ==',
      volumes: [
        {
          boot_index: 1,
          name: 'my-data-disk',
          size: 100,
          source: '<string>',
          delete_on_termination: true,
          tags: {key1: 'value1'}
        }
      ]
    },
    tags: {'my-tag': 'my-tag-value', 'my-tag-to-remove': null}
  })
};

fetch('https://api.gcore.com/cloud/v3/gpu/virtual/{project_id}/{region_id}/clusters/{cluster_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.gcore.com/cloud/v3/gpu/virtual/{project_id}/{region_id}/clusters/{cluster_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'gpu-cluster-1',
    'servers_settings' => [
        'credentials' => [
                'ssh_key_name' => 'my-ssh-key'
        ],
        'user_data' => 'eyJ0ZXN0IjogImRhdGEifQ==',
        'volumes' => [
                [
                                'boot_index' => 1,
                                'name' => 'my-data-disk',
                                'size' => 100,
                                'source' => '<string>',
                                'delete_on_termination' => true,
                                'tags' => [
                                                                'key1' => 'value1'
                                ]
                ]
        ]
    ],
    'tags' => [
        'my-tag' => 'my-tag-value',
        'my-tag-to-remove' => null
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.gcore.com/cloud/v3/gpu/virtual/{project_id}/{region_id}/clusters/{cluster_id}"

	payload := strings.NewReader("{\n  \"name\": \"gpu-cluster-1\",\n  \"servers_settings\": {\n    \"credentials\": {\n      \"ssh_key_name\": \"my-ssh-key\"\n    },\n    \"user_data\": \"eyJ0ZXN0IjogImRhdGEifQ==\",\n    \"volumes\": [\n      {\n        \"boot_index\": 1,\n        \"name\": \"my-data-disk\",\n        \"size\": 100,\n        \"source\": \"<string>\",\n        \"delete_on_termination\": true,\n        \"tags\": {\n          \"key1\": \"value1\"\n        }\n      }\n    ]\n  },\n  \"tags\": {\n    \"my-tag\": \"my-tag-value\",\n    \"my-tag-to-remove\": null\n  }\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.gcore.com/cloud/v3/gpu/virtual/{project_id}/{region_id}/clusters/{cluster_id}")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"gpu-cluster-1\",\n  \"servers_settings\": {\n    \"credentials\": {\n      \"ssh_key_name\": \"my-ssh-key\"\n    },\n    \"user_data\": \"eyJ0ZXN0IjogImRhdGEifQ==\",\n    \"volumes\": [\n      {\n        \"boot_index\": 1,\n        \"name\": \"my-data-disk\",\n        \"size\": 100,\n        \"source\": \"<string>\",\n        \"delete_on_termination\": true,\n        \"tags\": {\n          \"key1\": \"value1\"\n        }\n      }\n    ]\n  },\n  \"tags\": {\n    \"my-tag\": \"my-tag-value\",\n    \"my-tag-to-remove\": null\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.gcore.com/cloud/v3/gpu/virtual/{project_id}/{region_id}/clusters/{cluster_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"gpu-cluster-1\",\n  \"servers_settings\": {\n    \"credentials\": {\n      \"ssh_key_name\": \"my-ssh-key\"\n    },\n    \"user_data\": \"eyJ0ZXN0IjogImRhdGEifQ==\",\n    \"volumes\": [\n      {\n        \"boot_index\": 1,\n        \"name\": \"my-data-disk\",\n        \"size\": 100,\n        \"source\": \"<string>\",\n        \"delete_on_termination\": true,\n        \"tags\": {\n          \"key1\": \"value1\"\n        }\n      }\n    ]\n  },\n  \"tags\": {\n    \"my-tag\": \"my-tag-value\",\n    \"my-tag-to-remove\": null\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "created_at": "2024-12-31T23:59:59Z",
  "flavor": "g3-ai-32-192-1500-l40s-48-1",
  "has_pending_changes": false,
  "id": "1aaaab48-10d0-46d9-80cc-85209284ceb4",
  "name": "my virtual gpu cluster",
  "servers_count": 2,
  "servers_ids": [
    "b4522653-fbcd-44a0-a949-541570a52281",
    "e56192de-ed28-452a-b775-eeeacc795e3b"
  ],
  "servers_settings": {
    "file_shares": [
      {
        "id": "a3f2d1b8-45e6-4f8a-bb5d-19dbf2cd7e9a",
        "mount_path": "/mnt/vast"
      }
    ],
    "interfaces": [
      {
        "ip_family": "ipv4",
        "name": "eth0",
        "security_groups": [
          {
            "id": "ae74714c-c380-48b4-87f8-758d656cdad6",
            "name": "default"
          }
        ],
        "type": "<string>"
      }
    ],
    "security_groups": [
      {
        "id": "ae74714c-c380-48b4-87f8-758d656cdad6",
        "name": "default"
      }
    ],
    "ssh_key_name": "my-ssh-key",
    "user_data": "eyJ0ZXN0IjogImRhdGEifQ==",
    "volumes": [
      {
        "boot_index": 1,
        "delete_on_termination": true,
        "image_id": "3793c250-0b3b-4678-bab3-e11afbc29657",
        "name": "my-data-disk",
        "size": 100,
        "tags": [
          {
            "key": "my-tag",
            "read_only": false,
            "value": "my-tag-value"
          }
        ]
      }
    ]
  },
  "tags": [
    {
      "key": "my-tag",
      "read_only": false,
      "value": "my-tag-value"
    }
  ],
  "updated_at": "2025-01-11T23:59:59Z"
}

PATCH

cloud

gpu

virtual

{project_id}

{region_id}

clusters

{cluster_id}

Update virtual GPU cluster

curl --request PATCH \
  --url https://api.gcore.com/cloud/v3/gpu/virtual/{project_id}/{region_id}/clusters/{cluster_id} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "gpu-cluster-1",
  "servers_settings": {
    "credentials": {
      "ssh_key_name": "my-ssh-key"
    },
    "user_data": "eyJ0ZXN0IjogImRhdGEifQ==",
    "volumes": [
      {
        "boot_index": 1,
        "name": "my-data-disk",
        "size": 100,
        "source": "<string>",
        "delete_on_termination": true,
        "tags": {
          "key1": "value1"
        }
      }
    ]
  },
  "tags": {
    "my-tag": "my-tag-value",
    "my-tag-to-remove": null
  }
}
'

import requests

url = "https://api.gcore.com/cloud/v3/gpu/virtual/{project_id}/{region_id}/clusters/{cluster_id}"

payload = {
    "name": "gpu-cluster-1",
    "servers_settings": {
        "credentials": { "ssh_key_name": "my-ssh-key" },
        "user_data": "eyJ0ZXN0IjogImRhdGEifQ==",
        "volumes": [
            {
                "boot_index": 1,
                "name": "my-data-disk",
                "size": 100,
                "source": "<string>",
                "delete_on_termination": True,
                "tags": { "key1": "value1" }
            }
        ]
    },
    "tags": {
        "my-tag": "my-tag-value",
        "my-tag-to-remove": None
    }
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'gpu-cluster-1',
    servers_settings: {
      credentials: {ssh_key_name: 'my-ssh-key'},
      user_data: 'eyJ0ZXN0IjogImRhdGEifQ==',
      volumes: [
        {
          boot_index: 1,
          name: 'my-data-disk',
          size: 100,
          source: '<string>',
          delete_on_termination: true,
          tags: {key1: 'value1'}
        }
      ]
    },
    tags: {'my-tag': 'my-tag-value', 'my-tag-to-remove': null}
  })
};

fetch('https://api.gcore.com/cloud/v3/gpu/virtual/{project_id}/{region_id}/clusters/{cluster_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.gcore.com/cloud/v3/gpu/virtual/{project_id}/{region_id}/clusters/{cluster_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'gpu-cluster-1',
    'servers_settings' => [
        'credentials' => [
                'ssh_key_name' => 'my-ssh-key'
        ],
        'user_data' => 'eyJ0ZXN0IjogImRhdGEifQ==',
        'volumes' => [
                [
                                'boot_index' => 1,
                                'name' => 'my-data-disk',
                                'size' => 100,
                                'source' => '<string>',
                                'delete_on_termination' => true,
                                'tags' => [
                                                                'key1' => 'value1'
                                ]
                ]
        ]
    ],
    'tags' => [
        'my-tag' => 'my-tag-value',
        'my-tag-to-remove' => null
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.gcore.com/cloud/v3/gpu/virtual/{project_id}/{region_id}/clusters/{cluster_id}"

	payload := strings.NewReader("{\n  \"name\": \"gpu-cluster-1\",\n  \"servers_settings\": {\n    \"credentials\": {\n      \"ssh_key_name\": \"my-ssh-key\"\n    },\n    \"user_data\": \"eyJ0ZXN0IjogImRhdGEifQ==\",\n    \"volumes\": [\n      {\n        \"boot_index\": 1,\n        \"name\": \"my-data-disk\",\n        \"size\": 100,\n        \"source\": \"<string>\",\n        \"delete_on_termination\": true,\n        \"tags\": {\n          \"key1\": \"value1\"\n        }\n      }\n    ]\n  },\n  \"tags\": {\n    \"my-tag\": \"my-tag-value\",\n    \"my-tag-to-remove\": null\n  }\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.gcore.com/cloud/v3/gpu/virtual/{project_id}/{region_id}/clusters/{cluster_id}")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"gpu-cluster-1\",\n  \"servers_settings\": {\n    \"credentials\": {\n      \"ssh_key_name\": \"my-ssh-key\"\n    },\n    \"user_data\": \"eyJ0ZXN0IjogImRhdGEifQ==\",\n    \"volumes\": [\n      {\n        \"boot_index\": 1,\n        \"name\": \"my-data-disk\",\n        \"size\": 100,\n        \"source\": \"<string>\",\n        \"delete_on_termination\": true,\n        \"tags\": {\n          \"key1\": \"value1\"\n        }\n      }\n    ]\n  },\n  \"tags\": {\n    \"my-tag\": \"my-tag-value\",\n    \"my-tag-to-remove\": null\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.gcore.com/cloud/v3/gpu/virtual/{project_id}/{region_id}/clusters/{cluster_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"gpu-cluster-1\",\n  \"servers_settings\": {\n    \"credentials\": {\n      \"ssh_key_name\": \"my-ssh-key\"\n    },\n    \"user_data\": \"eyJ0ZXN0IjogImRhdGEifQ==\",\n    \"volumes\": [\n      {\n        \"boot_index\": 1,\n        \"name\": \"my-data-disk\",\n        \"size\": 100,\n        \"source\": \"<string>\",\n        \"delete_on_termination\": true,\n        \"tags\": {\n          \"key1\": \"value1\"\n        }\n      }\n    ]\n  },\n  \"tags\": {\n    \"my-tag\": \"my-tag-value\",\n    \"my-tag-to-remove\": null\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "created_at": "2024-12-31T23:59:59Z",
  "flavor": "g3-ai-32-192-1500-l40s-48-1",
  "has_pending_changes": false,
  "id": "1aaaab48-10d0-46d9-80cc-85209284ceb4",
  "name": "my virtual gpu cluster",
  "servers_count": 2,
  "servers_ids": [
    "b4522653-fbcd-44a0-a949-541570a52281",
    "e56192de-ed28-452a-b775-eeeacc795e3b"
  ],
  "servers_settings": {
    "file_shares": [
      {
        "id": "a3f2d1b8-45e6-4f8a-bb5d-19dbf2cd7e9a",
        "mount_path": "/mnt/vast"
      }
    ],
    "interfaces": [
      {
        "ip_family": "ipv4",
        "name": "eth0",
        "security_groups": [
          {
            "id": "ae74714c-c380-48b4-87f8-758d656cdad6",
            "name": "default"
          }
        ],
        "type": "<string>"
      }
    ],
    "security_groups": [
      {
        "id": "ae74714c-c380-48b4-87f8-758d656cdad6",
        "name": "default"
      }
    ],
    "ssh_key_name": "my-ssh-key",
    "user_data": "eyJ0ZXN0IjogImRhdGEifQ==",
    "volumes": [
      {
        "boot_index": 1,
        "delete_on_termination": true,
        "image_id": "3793c250-0b3b-4678-bab3-e11afbc29657",
        "name": "my-data-disk",
        "size": 100,
        "tags": [
          {
            "key": "my-tag",
            "read_only": false,
            "value": "my-tag-value"
          }
        ]
      }
    ]
  },
  "tags": [
    {
      "key": "my-tag",
      "read_only": false,
      "value": "my-tag-value"
    }
  ],
  "updated_at": "2025-01-11T23:59:59Z"
}

Authorizations

Authorization

string

header

required

API key for authentication. Make sure to include the word apikey, followed by a single space and then your token. Example: apikey 1234$abcdef

Path Parameters

project_id

integer

required

Project ID

Example:

1

region_id

integer

required

Region ID

Example:

7

cluster_id

string<uuid4>

required

Cluster unique identifier

Example:

"1aaaab48-10d0-46d9-80cc-85209284ceb4"

Body

application/json

name

string

Cluster name

Maximum string length: 63

Pattern: ^[a-zA-Z0-9][a-zA-Z 0-9._\-]{1,61}[a-zA-Z0-9._]$

Example:

"gpu-cluster-1"

servers_settings

PatchVirtualServerSettingsInputSerializer · object

Configuration settings for the servers in the cluster

Show child attributes

Example:

{
  "credentials": { "ssh_key_name": "my-key" },
  "user_data": "eyJ0ZXN0IjogImRhdGEifQ=="
}

Response

200 - application/json

created_at

string<date-time>

required

Cluster creation date time

Example:

"2024-12-31T23:59:59Z"

flavor

string

required

Cluster flavor name

Example:

"g3-ai-32-192-1500-l40s-48-1"

has_pending_changes

boolean

required

True if any server in the cluster has pending (not yet applied) settings changes

Example:

false

string<uuid4>

required

Cluster unique identifier

Example:

"1aaaab48-10d0-46d9-80cc-85209284ceb4"

name

string

required

Cluster name

Example:

"my virtual gpu cluster"

servers_count

integer

required

Cluster servers count

Example:

2

servers_ids

string<uuid4>[]

required

List of cluster nodes

Example:

[
  "b4522653-fbcd-44a0-a949-541570a52281",
  "e56192de-ed28-452a-b775-eeeacc795e3b"
]

servers_settings

VirtualServerSettingsOutputSerializer · object

required

Show child attributes

status

enum<string>

required

Cluster status

Available options:

active,

creating,

degraded,

deleting,

error,

rebooting,

rebuilding,

resizing,

shutoff

Example:

"active"