Skip to main content
GET
/
cloud
/
v1
/
bminstances
/
{project_id}
/
{region_id}
/
{server_id}
Get bare metal server
curl --request GET \
  --url https://api.gcore.com/cloud/v1/bminstances/{project_id}/{region_id}/{server_id} \
  --header 'Authorization: <api-key>'
{
  "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>",
      "license": "<string>",
      "network": "<string>",
      "ram": "<string>"
    },
    "os_type": "<string>",
    "ram": 123,
    "resource_class": "<string>",
    "vcpus": 123
  },
  "id": "<string>",
  "instance_isolation": {
    "reason": "Suspicious activities"
  },
  "name": "<string>",
  "project_id": 123,
  "region": "<string>",
  "region_id": 123,
  "ssh_key_name": "<string>",
  "status": "ACTIVE",
  "tags": [
    {
      "key": "<string>",
      "read_only": true,
      "value": "<string>"
    }
  ],
  "task_id": null,
  "task_state": "<string>",
  "vm_state": "active"
}

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 Project ID

region_id
integer
required

Region ID Region ID

server_id
string<uuid4>
required

Server ID Server ID

Response

200 - application/json

OK

addresses
Addresses · object
required

Map of network_name to list of addresses in that network

blackhole_ports
BlackholePortSerializer · object[]
required

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

created_at
string<date-time>
required

Datetime when bare metal server was created

creator_task_id
string | null
required

Task that created this entity

ddos_profile
GetClientProfileSerializer · object
required

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

fixed_ip_assignments
IpAssignmentsSerializer · object[]
required

Fixed IP assigned to instance

flavor
Bare metal flavor · object
required

Flavor details

id
string<uuid4>
required

Bare metal server ID

instance_isolation
IsolationSerializer · object
required

Instance isolation information

name
string
required

Bare metal server name

project_id
integer
required

Project ID

region
string
required

Region name

region_id
integer
required

Region ID

ssh_key_name
string | null
required

SSH key assigned to bare metal server

status
enum<string>
required

Bare metal server 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
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.

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

task_state
string | null
required

Task state

vm_state
enum<string>
required

Bare metal server state

Available options:
active,
building,
deleted,
error,
paused,
rescued,
resized,
shelved,
shelved_offloaded,
soft-deleted,
stopped,
suspended