v32

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

Bare Metal

List bare metal servers

List all bare metal servers in the specified project and region. Results can be filtered by various parameters like name, status, and IP address.

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

Path parameters

project_idinteger required

Project ID

Example:1

Project ID

region_idinteger required

Region ID

Example:1

Region ID

Query parameters

changes-beforestring date-time

Filters the instances by a date and time stamp when the instances last changed.

Example:2025-10-01T12:00:00Z

Filters the instances by a date and time stamp when the instances last changed.

changes-sincestring date-time

Filters the instances by a date and time stamp when the instances last changed status.

Example:2025-10-01T12:00:00Z

Filters the instances by a date and time stamp when the instances last changed status.

flavor_idstring

Filter out instances by flavor_id. Flavor id must match exactly.

Example:bm2-hf-small

Filter out instances by flavor_id. Flavor id must match exactly.

flavor_prefixstring

Filter out instances by flavor_prefix.

Example:bm2-

Filter out instances by flavor_prefix.

include_k8sboolean

Include managed k8s worker nodes

ipstring

An IPv4 address to filter results by. Note: partial matches are allowed. For example, searching for 192.168.0.1 will return 192.168.0.1, 192.168.0.10, 192.168.0.110, and so on.

Example:192.168.0.1

An IPv4 address to filter results by. Note: partial matches are allowed. For example, searching for 192.168.0.1 will return 192.168.0.1, 192.168.0.10, 192.168.0.110, and so on.

limitinteger

Optional. Limit the number of returned items

Example:1000

Optional. Limit the number of returned items

namestring

Filter instances by name. You can provide a full or partial name, instances with matching names will be returned. For example, entering 'test' will return all instances that contain 'test' in their name.

offsetinteger

Optional. Offset value is used to exclude the first set of records from the result

only_isolatedboolean

Include only isolated instances

only_with_fixed_external_ipboolean

Return bare metals only with external fixed IP addresses.

Example:true

Return bare metals only with external fixed IP addresses.

Order by field and direction.

profile_namestring

Filter result by ddos protection profile name. Effective only with with_ddos set to true.

Example:profile_name

Filter result by ddos protection profile name. Effective only with with_ddos set to true.

protection_status'Active' | 'Queued' | 'Error'

Filter result by DDoS protection_status. Effective only with with_ddos set to true. (Active, Queued or Error)

Example:Active

Filter result by DDoS protection_status. Effective only with with_ddos set to true. (Active, Queued or Error)

Filters instances by a server status, as a string.

tag_key_valuestring

Optional. Filter by tag key-value pairs.

tag_valuestring[]

Optional. Filter by tag values. ?tag_value=value1&tag_value=value2

[
  "value1",
  "value2"
]

type_ddos_profile'basic' | 'advanced'

Return bare metals either only with advanced or only basic DDoS protection. Effective only with with_ddos set to true. (advanced or basic)

Example:advanced

Return bare metals either only with advanced or only basic DDoS protection. Effective only with with_ddos set to true. (advanced or basic)

uuidstring

Filter the server list result by the UUID of the server. Allowed UUID part

Example:b5b4d65d-945f-4b98-ab6f-332319c724ef

Filter the server list result by the UUID of the server. Allowed UUID part

with_ddosboolean

Include DDoS profile information for bare-metal servers in the response when set to true. Otherwise, the ddos_profile field in the response is null by default.

Example:true

Include DDoS profile information for bare-metal servers in the response when set to true. Otherwise, the ddos_profile field in the response is null by default.

with_interfaces_nameboolean

Include interface_name in the addresses

Example:true

Include interface_name in the addresses

Response

countinteger required

Number of objects

Example response

{
  "count": 1,
  "results": [
    {
      "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"
        }
      ]
    }
  ]
}