Skip to main content
PATCH
/
cloud
/
v3
/
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
  }
}
'
{
  "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

Example:
{
  "credentials": { "ssh_key_name": "my-key" },
  "user_data": "eyJ0ZXN0IjogImRhdGEifQ=="
}
​
tags
UpdateTagsSerializer · object

Update key-value tags using JSON Merge Patch semantics (RFC 7386). Provide key-value pairs to add or update tags. Set tag values to null to remove tags. Unspecified tags remain unchanged. Read-only tags are always preserved and cannot be modified.

Examples:

  • Add/update tags: {'tags': {'environment': 'production', 'team': 'backend'}} adds new tags or updates existing ones.
  • Delete tags: {'tags': {'old_tag': null}} removes specific tags.
  • Remove all tags: {'tags': null} removes all user-managed tags (read-only tags are preserved).
  • Partial update: {'tags': {'environment': 'staging'}} only updates specified tags.
  • Mixed operations: {'tags': {'environment': 'production', 'cost_center': 'engineering', 'deprecated_tag': null}} adds/updates 'environment' and 'cost_center' while removing 'deprecated_tag', preserving other existing tags.
  • Replace all: first delete existing tags with null values, then add new ones in the same request.
Example:
{
  "my-tag": "my-tag-value",
  "my-tag-to-remove": null
}

Response

200 - application/json

OK

​
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

​
id
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
​
status
enum<string>
required

Cluster status

Available options:
active,
creating,
degraded,
deleting,
error,
rebooting,
rebuilding,
resizing,
shutoff
Example:

"active"

​
tags
TagSerializer · object[]
required

List of key-value tags associated with the resource. A tag is a key-value pair that can be associated with a resource, enabling efficient filtering and grouping for better organization and management. Some tags are read-only and cannot be modified by the user. Tags are also integrated with cost reports, allowing cost data to be filtered based on tag keys or values.

Example:
[
  {
    "key": "my-tag",
    "read_only": false,
    "value": "my-tag-value"
  }
]
​
updated_at
string<date-time> | null
required

Cluster update date time

Example:

"2025-01-11T23:59:59Z"