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

Parameters
project_id: number
region_id: number
disabled: boolean
Optional

Flag for filtering disabled flavors in the region. Defaults to true

exclude_linux: boolean
Optional

Set to true to exclude flavors dedicated to linux images. Default False

exclude_windows: boolean
Optional

Set to true to exclude flavors dedicated to windows images. Default False

include_capacity: boolean
Optional

Set to true if the response should include flavor capacity

include_prices: boolean
Optional

Set to true if the response should include flavor prices

include_reservation_stock: boolean
Optional

Optional. Set to true if flavor listing should include count of reserved resources in stock.

Response fields
count: number
Optional

Number of objects

results: Array<>
Optional

Objects

Request example
200Example
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

Parameters
region_id: number
client_id_: number
Optional

Client identifier. Must be used for users w/o client_id in jwt

disabled: boolean
Optional

Flag for filtering disabled flavors in the region. Defaults to true

exclude_linux: boolean
Optional

Set to true to exclude flavors dedicated to linux images. Default False

exclude_windows: boolean
Optional

Set to true to exclude flavors dedicated to windows images. Default False

include_capacity: boolean
Optional

Set to true if the response should include flavor capacity

include_prices: boolean
Optional

Set to true if the response should include flavor prices

include_reservation_stock: boolean
Optional

Optional. Set to true if flavor listing should include count of reserved resources in stock.

Response fields
count: number
Optional

Number of objects

results: Array<>
Optional

Objects

Request example
200Example
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

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