Documentation

Baremetal

baremetal

Domain types

BaremetalFlavorPricingSchema = { currency_code, disabled, flavor_id, 6 more... }

Bare metal flavors

Baremetal

Capacity

baremetal.capacity

Methods

Get Amount Of Available Bare Metal Nodes It S Similar V1 Bmcapacity Just With Project ID In Path ->
BaremetalCapacity
get/v1/bmcapacity/{project_id}/{region_id}

Get amount of available bare metal nodes It's similar v1/bmcapacity just with in path

Get Amount Of Available Bare Metal Nodes Without Client S Reservations It S Similar V2 Bmcapacity Just Without Project ID In Path ->
BaremetalCapacity
get/v2/bmcapacity/{region_id}

Get amount of available bare metal nodes without client's reservations It's similar v2/bmcapacity just without in path

Domain types

BaremetalCapacity = { capacity }

Available bare metal nodes count per flavor

Baremetal

Flavors

baremetal.flavors

Methods

List Bare Metal Flavors -> { count, results }
get/v1/bmflavors/{project_id}/{region_id}

Retrieve a list of flavors. When the include_prices query parameter is specified, the list shows prices. A client in trial mode gets all price values as 0. If you get Pricing Error contact the support

List Bare Metal Flavors From Default Project For Current Client -> { count, results }
get/v1/bmflavors/{region_id}

Retrieve a list of flavors. When the include_prices query parameter is specified, the list shows prices. A client in trial mode gets all price values as 0. If you get Pricing Error contact the support

Baremetal

Images

baremetal.images

Methods

Create Image -> { tasks }
post/v1/bmimages/{project_id}/{region_id}

Create image

List Images For Bare Metal Servers -> { count, results }
get/v1/bmimages/{project_id}/{region_id}

Retrieve the available images list for bare metal servers. Returned entities may or may not be owned by the project

Parameters
project_id: number
region_id: number
include_prices: boolean
Optional

Show price

metadata_k: string
Optional

Filter by metadata keys. Must be a valid JSON string. ' curl -G --data-urlencode 'metadata_k=["key1", "key2"]' --url 'http://localhost:1111/v1/images/1/1'

metadata_kv: string
Optional

Filter by metadata key-value pairs. Must be a valid JSON string. 'curl -G --data-urlencode 'metadata_kv={"key": "value"}' --url 'http://localhost:1111/v1/images/1/1'"

private: string
Optional

Any value to show private images

visibility:
Optional

Image visibility. Globally visible images are public

"private"
"public"
"shared"
Response fields
count: number
Optional

Number of objects

results: Array<
Image
>
Optional

Objects

Request example
200Example
Baremetal

Instances

baremetal.instances

Methods

Check Quota For Bare Metal Server Creation -> { baremetal_basic_count_limit, baremetal_basic_count_requested, baremetal_basic_count_usage, 126 more... }
post/v1/bminstances/{project_id}/{region_id}/check_limits

Check if regional quota is exceeded, if yes the number of additional quotas needed to create the specified bare metal server will be calculated

Create Bare Metal Server -> { tasks }
post/v1/bminstances/{project_id}/{region_id}

Create a new bare metal server or multiple servers

Get Flavors For Bare Metal Server -> { count, results }
post/v1/bminstances/{project_id}/{region_id}/available_flavors

Get flavors available for a potential bare metal server

List Bare Metal Servers -> OffsetPage<{ addresses, blackhole_ports, creator_task_id, 21 more... }>
get/v1/bminstances/{project_id}/{region_id}

The date and time stamp format in changes-since or changes-before should be ISO 8601: CCYY-MM-DDThh:mm:ss±hh:mm For example, 2015-08-27T09:49:58-05:00. Values must be urlencoded. If the time zone is omitted, the UTC time zone is assumed. When both changes-since and changes-before are specified, the value of the changes-since must be earlier than or equal to the value of the changes-before.

Rebuild Bare Metal Server -> { tasks }
post/v1/bminstances/{project_id}/{region_id}/{instance_id}/rebuild

Rebuild bare metal server