Sign in

v32

latestOpenAPI 3.1.0raw.githubusercontent.com2026-05-151,1412,2144.5 MB
Bare Metal

Get bare metal server

Retrieve detailed information about a specific baremetal instance. This endpoint always returns ddos_profile (if present) and therefore always requires DDOS_READ.

get/cloud/v1/bminstances/{project_id}/{region_id}/{server_id}

Path parameters

project_idinteger required

Project ID

Example:1

Project ID

region_idinteger required

Region ID

Example:1

Region ID

server_idstring uuid4 required

Server ID

Example:024a29e-b4b7-4c91-9a46-505be123d9f8

Server ID

Response

OK

addressesobject required

Map of network_name to list of addresses in that network

created_atstring date-time required

Datetime when bare metal server was created

creator_task_idstring nullable required

Task that created this entity

idstring uuid4 required

Bare metal server ID

namestring required

Bare metal server name

project_idinteger required

Project ID

regionstring required

Region name

region_idinteger required

Region ID

ssh_key_namestring nullable required

SSH key assigned to bare metal server

status'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' required
task_idstring nullable 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.

task_statestring nullable required

Task state

vm_state'active' | 'building' | 'deleted' | 'error' | 'paused' | 'rescued' | 'resized' | 'shelved' | 'shelved_offloaded' | 'soft-deleted' | 'stopped' | 'suspended' required

Example response

{
  "blackhole_ports": [
    {
      "AlarmEnd": "2025-02-05 12:04:30Z",
      "AlarmStart": "2025-02-05 12:04:11Z",
      "AlertDuration": "2 hours",
      "DestinationIP": "80.240.114.116"
    }
  ],
  "created_at": "2023-11-29T10:56:49Z",
  "ddos_profile": {
    "fields": [
      {
        "base_field": 10,
        "description": "ARK server ports. Valid port values are in range 1000-65535",
        "field_value": 45046,
        "id": 11,
        "name": "ARK Ports",
        "required": true,
        "validation_schema": {
          "items": {
            "maximum": 65535,
            "minimum": 1000,
            "type": "integer"
          },
          "minItems": 1,
          "type": "array"
        }
      }
    ],
    "options": {
      "active": true,
      "bgp": true
    },
    "profile_template": {
      "description": "description",
      "fields": [
        {
          "description": "ARK server ports. Valid port values are in range 1000-65535",
          "id": 11,
          "name": "ARK Ports",
          "required": true,
          "validation_schema": {
            "items": {
              "maximum": 65535,
              "minimum": 1000,
              "type": "integer"
            },
            "minItems": 1,
            "type": "array"
          }
        }
      ],
      "id": 123,
      "name": "ICMP port"
    },
    "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": "An error occured while deleting profile",
      "status": "Error Deleting"
    }
  },
  "fixed_ip_assignments": [
    {
      "ip_address": "123.123.123.1",
      "subnet_id": "eaafdc3c-f48b-4eb4-826f-057dfc7d6476"
    }
  ],
  "flavor": {
    "architecture": "x86_64",
    "flavor_id": "g2-standard-32-64",
    "flavor_name": "g2-standard-32-64",
    "hardware_description": {
      "cpu": "1x Intel Xeon 4C/8T 3.7 GHz",
      "disk": "2x 250GiB SSD",
      "license": "Windows License",
      "network": "1x 500Mbps",
      "ram": "32 GiB"
    },
    "os_type": "linux",
    "ram": 2048,
    "resource_class": "bm2-hf-medium",
    "vcpus": 1
  },
  "id": "6c6aa80f-7836-4dc2-a2ae-125e248be476",
  "instance_isolation": {
    "reason": "Suspicious activities"
  },
  "name": "my-server-1",
  "project_id": 1,
  "region": "Luxembourg",
  "region_id": 1,
  "tags": [
    {
      "key": "my-tag",
      "read_only": false,
      "value": "my-tag-value"
    }
  ]
}