Get bare metal GPU cluster

curl --request GET \
  --url https://api.gcore.com/cloud/v2/ai/clusters/{project_id}/{region_id}/{cluster_id} \
  --header 'Authorization: <api-key>'

{
  "cluster_id": "<string>",
  "cluster_name": "<string>",
  "cluster_status": "ACTIVE",
  "created_at": "2025-04-17 12:05:22.597284",
  "creator_task_id": "d1e1500b-e2be-40aa-9a4b-cc493fa1af30",
  "flavor": "<string>",
  "image_id": "<string>",
  "image_name": "ubuntu-22.04-x64-nvidia-a100/h100-550-12.4-eni",
  "interfaces": [
    {
      "network_id": "<string>",
      "port_id": "<string>",
      "subnet_id": "<string>",
      "type": "<string>"
    }
  ],
  "password": "my-password",
  "project_id": 123,
  "region": "<string>",
  "region_id": 123,
  "servers": [
    {
      "addresses": {},
      "blackhole_ports": [
        {
          "AlarmEnd": "2023-11-07T05:31:56Z",
          "AlarmStart": "2023-11-07T05:31:56Z",
          "AlarmState": "ACK_REQ",
          "AlertDuration": "<string>",
          "DestinationIP": "<string>",
          "ID": 123
        }
      ],
      "created_at": "2023-11-07T05:31:56Z",
      "creator_task_id": "<string>",
      "ddos_profile": {
        "fields": [
          {
            "base_field": 10,
            "default": null,
            "description": "ARK server ports. Valid port values are in range 1000-65535",
            "field_name": "ARK Ports",
            "field_type": null,
            "field_value": "<unknown>",
            "id": 123,
            "name": "<string>",
            "required": true,
            "validation_schema": "<unknown>",
            "value": null
          }
        ],
        "id": 123,
        "options": {
          "active": true,
          "bgp": true
        },
        "profile_template": {
          "description": "description",
          "fields": [
            {
              "default": null,
              "description": "ARK server ports. Valid port values are in range 1000-65535",
              "field_type": null,
              "id": 123,
              "name": "<string>",
              "required": true,
              "validation_schema": "<unknown>"
            }
          ],
          "id": 123,
          "name": "<string>"
        },
        "profile_template_description": "ARK server ports. Valid port values are in range 1000-65535",
        "protocols": [
          {
            "port": "80",
            "protocols": [
              "TCP",
              "HTTP"
            ]
          },
          {
            "port": "53",
            "protocols": [
              "UDP"
            ]
          }
        ],
        "site": "ED",
        "status": {
          "error_description": "",
          "status": "Updated"
        }
      },
      "fixed_ip_assignments": [
        {
          "external": true,
          "ip_address": "<string>",
          "subnet_id": "<string>"
        }
      ],
      "flavor": {
        "architecture": "<string>",
        "flavor_id": "<string>",
        "flavor_name": "<string>",
        "hardware_description": {
          "cpu": "<string>",
          "disk": "<string>",
          "gpu": "<string>",
          "license": "<string>",
          "network": "<string>",
          "ram": "<string>"
        },
        "os_type": "<string>",
        "ram": 123,
        "resource_class": "<string>",
        "vcpus": 123
      },
      "id": "<string>",
      "instance_description": "Instance description",
      "instance_isolation": {
        "reason": "Suspicious activities"
      },
      "name": "<string>",
      "project_id": 123,
      "region": "<string>",
      "region_id": 123,
      "security_groups": [
        {
          "name": "<string>"
        }
      ],
      "ssh_key_name": "my-ssh-key",
      "status": "ACTIVE",
      "tags": [
        {
          "key": "<string>",
          "read_only": true,
          "value": "<string>"
        }
      ],
      "task_id": null,
      "task_state": "<string>",
      "vm_state": "active"
    }
  ],
  "ssh_key_name": "my-ssh-key",
  "tags": [
    {
      "key": "<string>",
      "read_only": true,
      "value": "<string>"
    }
  ],
  "task_id": "d1e1500b-e2be-40aa-9a4b-cc493fa1af30",
  "task_status": "CLUSTER_CLEAN_UP",
  "user_data": "<string>",
  "username": "my-username"
}

GET

cloud

clusters

{project_id}

{region_id}

{cluster_id}

Get bare metal GPU cluster

curl --request GET \
  --url https://api.gcore.com/cloud/v2/ai/clusters/{project_id}/{region_id}/{cluster_id} \
  --header 'Authorization: <api-key>'

{
  "cluster_id": "<string>",
  "cluster_name": "<string>",
  "cluster_status": "ACTIVE",
  "created_at": "2025-04-17 12:05:22.597284",
  "creator_task_id": "d1e1500b-e2be-40aa-9a4b-cc493fa1af30",
  "flavor": "<string>",
  "image_id": "<string>",
  "image_name": "ubuntu-22.04-x64-nvidia-a100/h100-550-12.4-eni",
  "interfaces": [
    {
      "network_id": "<string>",
      "port_id": "<string>",
      "subnet_id": "<string>",
      "type": "<string>"
    }
  ],
  "password": "my-password",
  "project_id": 123,
  "region": "<string>",
  "region_id": 123,
  "servers": [
    {
      "addresses": {},
      "blackhole_ports": [
        {
          "AlarmEnd": "2023-11-07T05:31:56Z",
          "AlarmStart": "2023-11-07T05:31:56Z",
          "AlarmState": "ACK_REQ",
          "AlertDuration": "<string>",
          "DestinationIP": "<string>",
          "ID": 123
        }
      ],
      "created_at": "2023-11-07T05:31:56Z",
      "creator_task_id": "<string>",
      "ddos_profile": {
        "fields": [
          {
            "base_field": 10,
            "default": null,
            "description": "ARK server ports. Valid port values are in range 1000-65535",
            "field_name": "ARK Ports",
            "field_type": null,
            "field_value": "<unknown>",
            "id": 123,
            "name": "<string>",
            "required": true,
            "validation_schema": "<unknown>",
            "value": null
          }
        ],
        "id": 123,
        "options": {
          "active": true,
          "bgp": true
        },
        "profile_template": {
          "description": "description",
          "fields": [
            {
              "default": null,
              "description": "ARK server ports. Valid port values are in range 1000-65535",
              "field_type": null,
              "id": 123,
              "name": "<string>",
              "required": true,
              "validation_schema": "<unknown>"
            }
          ],
          "id": 123,
          "name": "<string>"
        },
        "profile_template_description": "ARK server ports. Valid port values are in range 1000-65535",
        "protocols": [
          {
            "port": "80",
            "protocols": [
              "TCP",
              "HTTP"
            ]
          },
          {
            "port": "53",
            "protocols": [
              "UDP"
            ]
          }
        ],
        "site": "ED",
        "status": {
          "error_description": "",
          "status": "Updated"
        }
      },
      "fixed_ip_assignments": [
        {
          "external": true,
          "ip_address": "<string>",
          "subnet_id": "<string>"
        }
      ],
      "flavor": {
        "architecture": "<string>",
        "flavor_id": "<string>",
        "flavor_name": "<string>",
        "hardware_description": {
          "cpu": "<string>",
          "disk": "<string>",
          "gpu": "<string>",
          "license": "<string>",
          "network": "<string>",
          "ram": "<string>"
        },
        "os_type": "<string>",
        "ram": 123,
        "resource_class": "<string>",
        "vcpus": 123
      },
      "id": "<string>",
      "instance_description": "Instance description",
      "instance_isolation": {
        "reason": "Suspicious activities"
      },
      "name": "<string>",
      "project_id": 123,
      "region": "<string>",
      "region_id": 123,
      "security_groups": [
        {
          "name": "<string>"
        }
      ],
      "ssh_key_name": "my-ssh-key",
      "status": "ACTIVE",
      "tags": [
        {
          "key": "<string>",
          "read_only": true,
          "value": "<string>"
        }
      ],
      "task_id": null,
      "task_state": "<string>",
      "vm_state": "active"
    }
  ],
  "ssh_key_name": "my-ssh-key",
  "tags": [
    {
      "key": "<string>",
      "read_only": true,
      "value": "<string>"
    }
  ],
  "task_id": "d1e1500b-e2be-40aa-9a4b-cc493fa1af30",
  "task_status": "CLUSTER_CLEAN_UP",
  "user_data": "<string>",
  "username": "my-username"
}

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

region_id

integer

required

Region ID

cluster_id

string

required

GPU cluster ID

Response

200 - application/json

GPU cluster

cluster_id

string<uuid4>

required

GPU Cluster ID

cluster_name

string

required

GPU Cluster Name

cluster_status

enum<string>

required

GPU Cluster status

Available options:

ACTIVE,

ERROR,

PENDING,

SUSPENDED

created_at

string | null

required

Datetime when the cluster was created

Example:

"2025-04-17 12:05:22.597284"

creator_task_id

string<uuid4> | null

required

deprecated

Task that created this entity

Example:

"d1e1500b-e2be-40aa-9a4b-cc493fa1af30"

flavor

string

required

Flavor ID is the same as the name

image_id

string<uuid4>

required

Image ID

image_name

string | null

required

Image name

Example:

"ubuntu-22.04-x64-nvidia-a100/h100-550-12.4-eni"

interfaces

AIClusterNetworkSerializer · object[] | null

required

Networks managed by user and associated with the cluster

Show child attributes

interfaces.network_id

string<uuid4>

required

Network ID

interfaces.port_id

string<uuid4>

required

Network ID the subnet belongs to. Port will be plugged in this network

interfaces.subnet_id

string<uuid4>

required

Port is assigned to IP address from the subnet

interfaces.type

string

required

Network type

password

string | null

required

A password for a bare metal server. This parameter is used to set a password for the "Admin" user on a Windows instance, a default user or a new user on a Linux instance

Example:

"my-password"

project_id

integer

required

Project ID

region

string

required

Region name

region_id

integer

required

Region ID

servers

GPUClusterServerSerializer · object[]

required

GPU cluster servers

Show child attributes

servers.addresses

Addresses · object

required

Map of network_name to list of addresses in that network

Show child attributes

servers.addresses.{key}

(Floating IP Address · object | Fixed IP Address (short) · object | Fixed IP Address · object)[]

Schema for floating addresses.

Floating IP Address
Fixed IP Address (short)
Fixed IP Address

Show child attributes

servers.addresses.{key}.addr

string

required

Address

servers.addresses.{key}.type

string

required

Type of the address

Allowed value: "floating"

servers.blackhole_ports

BlackholePortSerializer · object[]

required

IP addresses of the instances that are blackholed by DDoS mitigation system

Show child attributes

servers.blackhole_ports.AlarmEnd

string<date-time>

required

A date-time string giving the time that the alarm ended. If not yet ended, time will be given as 0001-01-01T00:00:00Z

servers.blackhole_ports.AlarmStart

string<date-time>

required

A date-time string giving the time that the alarm started

servers.blackhole_ports.AlarmState

enum<string>

required

Current state of alarm

Available options:

ACK_REQ,

ALARM,

ARCHIVED,

CLEAR,

CLEARING,

CLEARING_FAIL,

END_GRACE,

END_WAIT,

MANUAL_CLEAR,

MANUAL_CLEARING,

MANUAL_CLEARING_FAIL,

MANUAL_MITIGATING,

MANUAL_STARTING,

MANUAL_STARTING_FAIL,

MITIGATING,

STARTING,

STARTING_FAIL,

START_WAIT,

ack_req,

alarm,

archived,

clear,

clearing,

clearing_fail,

end_grace,

end_wait,

manual_clear,

manual_clearing,

manual_clearing_fail,

manual_mitigating,

manual_starting,

manual_starting_fail,

mitigating,

start_wait,

starting,

starting_fail

servers.blackhole_ports.AlertDuration

string

required

Total alert duration

servers.blackhole_ports.DestinationIP

string

required

Notification destination IP address

servers.blackhole_ports.ID

integer

required

servers.created_at

string<date-time>

required

Datetime when GPU server was created

servers.creator_task_id

string | null

required

Task that created this entity

servers.ddos_profile

GetClientProfileSerializer · object

required

Advanced DDoS protection profile. It is always null if query parameter with_ddos=true is not set.

Show child attributes

servers.ddos_profile.fields

ClientProfileFieldSerializer · object[]

required

List of configured field values for the protection profile

Show child attributes

servers.ddos_profile.fields.base_field

integer | null

required

ID of DDoS profile field

Example:

10

servers.ddos_profile.fields.default

string | null

required

Predefined default value for the field if not specified

Maximum string length: 100

Example:

null

servers.ddos_profile.fields.description

string | null

required

Detailed description explaining the field's purpose and usage guidelines

Maximum string length: 255

Example:

"ARK server ports. Valid port values are in range 1000-65535"

servers.ddos_profile.fields.field_name

string | null

required

Name of DDoS profile field

Example:

"ARK Ports"

servers.ddos_profile.fields.field_type

string | null

required

Data type classification of the field (e.g., string, integer, array)

Example:

null

servers.ddos_profile.fields.field_value

any

required

Complex value. Only one of 'value' or 'field_value' must be specified.

servers.ddos_profile.fields.id

integer

required

Unique identifier for the DDoS protection field

servers.ddos_profile.fields.name

string

required

Human-readable name of the protection field

Maximum string length: 30

servers.ddos_profile.fields.required

boolean | null

required

Indicates whether this field must be provided when creating a protection profile

Example:

true

servers.ddos_profile.fields.validation_schema

any

required

JSON schema defining validation rules and constraints for the field value

servers.ddos_profile.fields.value

string | null

required

Basic type value. Only one of 'value' or 'field_value' must be specified.

Example:

null

servers.ddos_profile.id

integer

required

Unique identifier for the DDoS protection profile

servers.ddos_profile.options

ProfileOptionsSerializer · object

required

Configuration options controlling profile activation and BGP routing

Show child attributes

servers.ddos_profile.options.active

boolean

required

Controls whether the DDoS protection profile is enabled and actively protecting the resource

servers.ddos_profile.options.bgp

boolean

required

Enables Border Gateway Protocol (BGP) routing for DDoS protection traffic

servers.ddos_profile.profile_template

ClientProfileTemplateSerializer · object

required

Complete template configuration data used for this profile

Show child attributes

servers.ddos_profile.profile_template.description

string | null

required

Detailed description explaining the template's purpose and use cases

Example:

"description"

servers.ddos_profile.profile_template.fields

ClientProfileTemplateFieldSerializer · object[]

required

List of configurable fields that define the template's protection parameters

Show child attributes

servers.ddos_profile.profile_template.fields.default

string | null

required

Predefined default value for the field if not specified

Maximum string length: 100

Example:

null

servers.ddos_profile.profile_template.fields.description

string | null

required

Detailed description explaining the field's purpose and usage guidelines

Maximum string length: 255

Example:

"ARK server ports. Valid port values are in range 1000-65535"

servers.ddos_profile.profile_template.fields.field_type

string | null

required

Data type classification of the field (e.g., string, integer, array)

Example:

null

servers.ddos_profile.profile_template.fields.id

integer

required

Unique identifier for the DDoS protection field

servers.ddos_profile.profile_template.fields.name

string

required

Human-readable name of the protection field

Maximum string length: 30

servers.ddos_profile.profile_template.fields.required

boolean | null

required

Indicates whether this field must be provided when creating a protection profile

Example:

true

servers.ddos_profile.profile_template.fields.validation_schema

any

required

JSON schema defining validation rules and constraints for the field value

servers.ddos_profile.profile_template.id

integer

required

Unique identifier for the DDoS protection template

servers.ddos_profile.profile_template.name

string

required

Human-readable name of the protection template

Maximum string length: 100

servers.ddos_profile.profile_template_description

string | null

required

Detailed description of the protection template used for this profile

Example:

"ARK server ports. Valid port values are in range 1000-65535"

servers.ddos_profile.protocols

ProtocolsOnPortSerializer · object[] | null

required

List of network protocols and ports configured for protection

Show child attributes

servers.ddos_profile.protocols.port

string

required

Network port number for which protocols are configured

servers.ddos_profile.protocols.protocols

string[]

required

List of network protocols enabled on the specified port

Example:

[
  {
    "port": "80",
    "protocols": ["TCP", "HTTP"]
  },
  { "port": "53", "protocols": ["UDP"] }
]

servers.ddos_profile.site

string | null

required

Geographic site identifier where the protection is deployed

Maximum string length: 50

Example:

"ED"

servers.ddos_profile.status

DdosProfileStatusSerializer · object

required

Current operational status and any error information for the profile

Show child attributes

servers.ddos_profile.status.error_description

string

required

Detailed error message describing any issues with the profile operation

servers.ddos_profile.status.status

string

required

Current operational status of the DDoS protection profile

Required string length: 3 - 30

Example:

{
  "error_description": "",
  "status": "Updated"
}

servers.fixed_ip_assignments

IpAssignmentsSerializer · object[] | null

required

Fixed IP assigned to instance

Show child attributes

servers.fixed_ip_assignments.external

boolean

required

Is network external

servers.fixed_ip_assignments.ip_address

string

required

Ip address

servers.fixed_ip_assignments.subnet_id

string

required

Interface subnet id

servers.flavor

GPU cluster flavor · object

required

Flavor

Show child attributes

servers.flavor.architecture

string

required

CPU architecture

servers.flavor.flavor_id

string

required

Flavor ID is the same as name

servers.flavor.flavor_name

string

required

Flavor name

servers.flavor.hardware_description

Detailed flavor hardware description of GPU cluster server flavor · object

required

Additional hardware description

Show child attributes

servers.flavor.hardware_description.cpu

string

required

Human-readable CPU description

servers.flavor.hardware_description.disk

string

required

Human-readable disk description

servers.flavor.hardware_description.gpu

string

required

Human-readable GPU description

servers.flavor.hardware_description.license

string

required

If the flavor is licensed, this field contains the license type

servers.flavor.hardware_description.network

string

required

Human-readable NIC description

servers.flavor.hardware_description.ram

string

required

Human-readable RAM description

servers.flavor.os_type

string

required

Operating system

servers.flavor.ram

integer

required

RAM size in MiB

servers.flavor.resource_class

string

required

Flavor resource class for mapping to hardware capacity

servers.flavor.vcpus

integer

required

Virtual CPU count. For bare metal flavors, it's a physical CPU count

servers.id

string<uuid4>

required

GPU server ID

servers.instance_description

string | null

required

Instance description

Example:

"Instance description"

servers.instance_isolation

IsolationSerializer · object

required

Instance isolation information

Show child attributes

servers.instance_isolation.reason

string | null

The reason of instance isolation if it is isolated from external internet.

Example:

"Suspicious activities"

servers.name

string

required

GPU server name

servers.project_id

integer

required

Project ID

servers.region

string

required

Region name

servers.region_id

integer

required

Region ID

servers.security_groups

NameSerializerPydantic · object[]

required

Security groups

Show child attributes

servers.security_groups.name

string

required

Name.

servers.ssh_key_name

string | null

required

SSH key name assigned to instance

Example:

"my-ssh-key"

servers.status

enum<string>

required

Instance status

Available options:

ACTIVE,

BUILD,

DELETED,

ERROR,

HARD_REBOOT,

MIGRATING,

PASSWORD,

PAUSED,

REBOOT,

REBUILD,

RESCUE,

RESIZE,

REVERT_RESIZE,

SHELVED,

SHELVED_OFFLOADED,

SHUTOFF,

SOFT_DELETED,

SUSPENDED,

UNKNOWN,

VERIFY_RESIZE

servers.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.

Show child attributes

servers.tags.key

string

required

Tag key. The maximum size for a key is 255 characters.

servers.tags.read_only

boolean

required

If true, the tag is read-only and cannot be modified by the user

servers.tags.value

string

required

Tag value. The maximum size for a value is 255 characters.

servers.task_id

string | null

required

The UUID of the active task that currently holds a lock on the resource. This lock prevents concurrent modifications to ensure consistency. If null, the resource is not locked.

Example:

null

servers.task_state

string | null

required

Task state

servers.vm_state

enum<string>

required

Virtual machine state (active)

Available options:

active,

building,

deleted,

error,

paused,

rescued,

resized,

shelved,

shelved_offloaded,

soft-deleted,

stopped,

suspended

ssh_key_name

string | null

required

Keypair name to inject into new cluster(s)

Example:

"my-ssh-key"

Overview

IAM

CDN

Managed DNS

Cloud

DDoS Protection

FastEdge

WAAP

Streaming

Object Storage

Resellers

Get bare metal GPU cluster

Authorizations

Path Parameters

Response