Elastic metal APIv1

Download OpenAPI

Introduction

Elastic metal as a service allows ordering a dedicated server on-demand like a cloud instance. Dedicated servers could be used for large workloads, big data, those requiring more security, ….

Technical Limitations

  • Elastic metal is available in fr-par-1, fr-par-2, nl-ams-1 zones

  • Installation is done by preseed (± 10min) (preseed: complete install from a virtual media)

Features

  • Install (Server is installed by preseed (preseed: complete install from a virtual media), you must define at least one ssh key to install your server)

  • Start/Stop/Reboot

  • Rescue Reboot, a rescue image is an operating system image designed to help you diagnose and fix an OS experiencing failures. When your server boot on rescue, you can mount your disks and start diagnosing/fixing your image.

  • Billed by minute (The billing start when the server is delivered and stop when the server is deleted)

  • IPv6, all servers are available with an IPv6 /128

  • ReverseIP, You can configure your reverse IP (IPv4 and IPv6), you must register the server IP in your DNS records before calling the endpoint

  • Basic monitoring with ping status

  • Flexible IP is available (documentation)

  • IP failovers are not available in api v1, use the api v1alpha1

How can I get my SSH key id?

You can find your $SCW_SECRET_KEY and your SCW_DEFAULT_ORGANIZATION_ID at the following page: https://console.scaleway.com/project/credentials

Servers

A server represents a dedicated elastic metal server.

List elastic metal servers for organization

List elastic metal servers for organization.

GET
/baremetal/v1/zones/{zone}/servers
Path Parameters
zone
required string
The zone you want to target. Possible values are fr-par-1, fr-par-2 and nl-ams-1.
Query Parameters
page
number
Page number. The default value is 1.
page_size
number
Number of server per page. The default value is 20.
order_by
string
Order of the servers. Possible values are created_at_asc and created_at_desc. The default value is created_at_asc.
tags
array
Filter by tags.
status
array
Filter by status.
name
nullable string
Filter by name.
organization_id
nullable string
Filter by organization ID.
project_id
nullable string
Filter by project ID.
option_id
nullable string
Filter by option ID.
200 Response
total_count
number
Total count of matching servers.
servers
array
Servers that match filters.
Response Example

Create an elastic metal server

Create a new elastic metal server. Once the server is created, you probably want to install an OS.

POST
/baremetal/v1/zones/{zone}/servers
Path Parameters
zone
required string
The zone you want to target. Possible values are fr-par-1, fr-par-2 and nl-ams-1.
Body
offer_id
required string
Offer ID of the new server.
organization_id
deprecated string
Organization ID with which the server will be created. Only one of organization_id and project_id may be set.
project_id
string
Project ID with which the server will be created. Only one of organization_id and project_id may be set.
name
required string
Name of the server (≠hostname).
description
required string
Description associated to the server, max 255 characters.
tags
array
Tags to associate to the server.
install
object
Configuration of installation.
option_ids
array
IDs of options to enable on server.
Request Example
200 Response
id
string
ID of the server.
organization_id
string
Organization ID the server is attached to.
project_id
string
Project ID the server is attached to.
name
string
Name of the server.
description
string
Description of the server.
updated_at
string
Date of last modification of the server (RFC 3339 format).
created_at
string
Date of creation of the server (RFC 3339 format).
status
string
Status of the server. Possible values are unknown, delivering, ready, stopping, stopped, starting, error, deleting, locked, out_of_stock and ordered. The default value is unknown.
offer_id
string
Offer ID of the server.
offer_name
string
Offer name of the server.
tags
array
Array of customs tags attached to the server.
ips
array
Array of IPs attached to the server.
domain
string
Domain of the server.
boot_type
string
Boot type of the server. Possible values are unknown_boot_type, normal and rescue. The default value is unknown_boot_type.
zone
string
The zone in which is the server.
install
object
Configuration of installation.
ping_status
string
Server status of ping. Possible values are ping_status_unknown, ping_status_up and ping_status_down. The default value is ping_status_unknown.
options
array
Options enabled on server.
rescue_server
object
Configuration of rescue boot.
Response Example

Get a specific elastic metal server

Get the server associated with the given ID.

GET
/baremetal/v1/zones/{zone}/servers/{server_id}
Path Parameters
zone
required string
The zone you want to target. Possible values are fr-par-1, fr-par-2 and nl-ams-1.
server_id
required string
ID of the server.
200 Response
id
string
ID of the server.
organization_id
string
Organization ID the server is attached to.
project_id
string
Project ID the server is attached to.
name
string
Name of the server.
description
string
Description of the server.
updated_at
string
Date of last modification of the server (RFC 3339 format).
created_at
string
Date of creation of the server (RFC 3339 format).
status
string
Status of the server. Possible values are unknown, delivering, ready, stopping, stopped, starting, error, deleting, locked, out_of_stock and ordered. The default value is unknown.
offer_id
string
Offer ID of the server.
offer_name
string
Offer name of the server.
tags
array
Array of customs tags attached to the server.
ips
array
Array of IPs attached to the server.
domain
string
Domain of the server.
boot_type
string
Boot type of the server. Possible values are unknown_boot_type, normal and rescue. The default value is unknown_boot_type.
zone
string
The zone in which is the server.
install
object
Configuration of installation.
ping_status
string
Server status of ping. Possible values are ping_status_unknown, ping_status_up and ping_status_down. The default value is ping_status_unknown.
options
array
Options enabled on server.
rescue_server
object
Configuration of rescue boot.
Response Example

Update an elastic metal server

Update the server associated with the given ID.

PATCH
/baremetal/v1/zones/{zone}/servers/{server_id}
Path Parameters
zone
required string
The zone you want to target. Possible values are fr-par-1, fr-par-2 and nl-ams-1.
server_id
required string
ID of the server to update.
Body
name
nullable string
Name of the server (≠hostname), not updated if null.
description
nullable string
Description associated to the server, max 255 characters, not updated if null.
tags
nullable array
Tags associated to the server, not updated if null.
Request Example
200 Response
id
string
ID of the server.
organization_id
string
Organization ID the server is attached to.
project_id
string
Project ID the server is attached to.
name
string
Name of the server.
description
string
Description of the server.
updated_at
string
Date of last modification of the server (RFC 3339 format).
created_at
string
Date of creation of the server (RFC 3339 format).
status
string
Status of the server. Possible values are unknown, delivering, ready, stopping, stopped, starting, error, deleting, locked, out_of_stock and ordered. The default value is unknown.
offer_id
string
Offer ID of the server.
offer_name
string
Offer name of the server.
tags
array
Array of customs tags attached to the server.
ips
array
Array of IPs attached to the server.
domain
string
Domain of the server.
boot_type
string
Boot type of the server. Possible values are unknown_boot_type, normal and rescue. The default value is unknown_boot_type.
zone
string
The zone in which is the server.
install
object
Configuration of installation.
ping_status
string
Server status of ping. Possible values are ping_status_unknown, ping_status_up and ping_status_down. The default value is ping_status_unknown.
options
array
Options enabled on server.
rescue_server
object
Configuration of rescue boot.
Response Example

Delete an elastic metal server

Delete the server associated with the given ID.

DELETE
/baremetal/v1/zones/{zone}/servers/{server_id}
Path Parameters
zone
required string
The zone you want to target. Possible values are fr-par-1, fr-par-2 and nl-ams-1.
server_id
required string
ID of the server to delete.
200 Response
id
string
ID of the server.
organization_id
string
Organization ID the server is attached to.
project_id
string
Project ID the server is attached to.
name
string
Name of the server.
description
string
Description of the server.
updated_at
string
Date of last modification of the server (RFC 3339 format).
created_at
string
Date of creation of the server (RFC 3339 format).
status
string
Status of the server. Possible values are unknown, delivering, ready, stopping, stopped, starting, error, deleting, locked, out_of_stock and ordered. The default value is unknown.
offer_id
string
Offer ID of the server.
offer_name
string
Offer name of the server.
tags
array
Array of customs tags attached to the server.
ips
array
Array of IPs attached to the server.
domain
string
Domain of the server.
boot_type
string
Boot type of the server. Possible values are unknown_boot_type, normal and rescue. The default value is unknown_boot_type.
zone
string
The zone in which is the server.
install
object
Configuration of installation.
ping_status
string
Server status of ping. Possible values are ping_status_unknown, ping_status_up and ping_status_down. The default value is ping_status_unknown.
options
array
Options enabled on server.
rescue_server
object
Configuration of rescue boot.
Response Example

List server events

List events associated to the given server ID.

GET
/baremetal/v1/zones/{zone}/servers/{server_id}/events
Path Parameters
zone
required string
The zone you want to target. Possible values are fr-par-1, fr-par-2 and nl-ams-1.
server_id
required string
ID of the server events searched.
Query Parameters
page
number
Page number. The default value is 1.
page_size
number
Number of server events per page. The default value is 20.
order_by
string
Order of the server events. Possible values are created_at_asc and created_at_desc. The default value is created_at_asc.
200 Response
total_count
number
Total count of matching events.
events
array
Server events that match filters.
Response Example

Install an elastic metal server

Install an OS on the server associated with the given ID.

POST
/baremetal/v1/zones/{zone}/servers/{server_id}/install
Path Parameters
zone
required string
The zone you want to target. Possible values are fr-par-1, fr-par-2 and nl-ams-1.
server_id
required string
Server ID to install.
Body
os_id
required string
ID of the OS to install on the server.
hostname
required string
Hostname of the server.
ssh_key_ids
required array
SSH key IDs authorized on the server.
user
nullable string
User used for the installation.
password
nullable string
Password used for the installation.
service_user
nullable string
User used for the service to install.
service_password
nullable string
Password used for the service to install.
Request Example
200 Response
id
string
ID of the server.
organization_id
string
Organization ID the server is attached to.
project_id
string
Project ID the server is attached to.
name
string
Name of the server.
description
string
Description of the server.
updated_at
string
Date of last modification of the server (RFC 3339 format).
created_at
string
Date of creation of the server (RFC 3339 format).
status
string
Status of the server. Possible values are unknown, delivering, ready, stopping, stopped, starting, error, deleting, locked, out_of_stock and ordered. The default value is unknown.
offer_id
string
Offer ID of the server.
offer_name
string
Offer name of the server.
tags
array
Array of customs tags attached to the server.
ips
array
Array of IPs attached to the server.
domain
string
Domain of the server.
boot_type
string
Boot type of the server. Possible values are unknown_boot_type, normal and rescue. The default value is unknown_boot_type.
zone
string
The zone in which is the server.
install
object
Configuration of installation.
ping_status
string
Server status of ping. Possible values are ping_status_unknown, ping_status_up and ping_status_down. The default value is ping_status_unknown.
options
array
Options enabled on server.
rescue_server
object
Configuration of rescue boot.
Response Example

Update IP

Configure ip associated with the given server ID and ipID. You can use this method to set a reverse dns for an IP.

PATCH
/baremetal/v1/zones/{zone}/servers/{server_id}/ips/{ip_id}
Path Parameters
zone
required string
The zone you want to target. Possible values are fr-par-1, fr-par-2 and nl-ams-1.
server_id
required string
ID of the server.
ip_id
required string
ID of the IP to update.
Body
reverse
nullable string
New reverse IP to update, not updated if null.
Request Example
200 Response
id
string
ID of the IP.
address
string
Address of the IP (IP address).
reverse
string
Reverse IP value.
version
string
Version of IP (v4 or v6). Possible values are IPv4 and IPv6. The default value is IPv4.
reverse_status
string
Status of the reverse. Possible values are unknown, pending, active and error. The default value is unknown.
reverse_status_message
string
A message related to the reverse status, in case of an error for example.
Response Example

Return server metrics

Give the ping status on the server associated with the given ID.

GET
/baremetal/v1/zones/{zone}/servers/{server_id}/metrics
Path Parameters
zone
required string
The zone you want to target. Possible values are fr-par-1, fr-par-2 and nl-ams-1.
server_id
required string
Server ID to get the metrics.
200 Response
pings
object
Timeseries of ping on the server.
Response Example

Add server option

Add an option to a specific server.

POST
/baremetal/v1/zones/{zone}/servers/{server_id}/options/{option_id}
Path Parameters
zone
required string
The zone you want to target. Possible values are fr-par-1, fr-par-2 and nl-ams-1.
server_id
required string
ID of the server.
option_id
required string
ID of the option to add.
Body
expires_at
string
Auto expire the option after this date (RFC 3339 format).
Request Example
200 Response
id
string
ID of the server.
organization_id
string
Organization ID the server is attached to.
project_id
string
Project ID the server is attached to.
name
string
Name of the server.
description
string
Description of the server.
updated_at
string
Date of last modification of the server (RFC 3339 format).
created_at
string
Date of creation of the server (RFC 3339 format).
status
string
Status of the server. Possible values are unknown, delivering, ready, stopping, stopped, starting, error, deleting, locked, out_of_stock and ordered. The default value is unknown.
offer_id
string
Offer ID of the server.
offer_name
string
Offer name of the server.
tags
array
Array of customs tags attached to the server.
ips
array
Array of IPs attached to the server.
domain
string
Domain of the server.
boot_type
string
Boot type of the server. Possible values are unknown_boot_type, normal and rescue. The default value is unknown_boot_type.
zone
string
The zone in which is the server.
install
object
Configuration of installation.
ping_status
string
Server status of ping. Possible values are ping_status_unknown, ping_status_up and ping_status_down. The default value is ping_status_unknown.
options
array
Options enabled on server.
rescue_server
object
Configuration of rescue boot.
Response Example

Delete server option

Delete an option from a specific server.

DELETE
/baremetal/v1/zones/{zone}/servers/{server_id}/options/{option_id}
Path Parameters
zone
required string
The zone you want to target. Possible values are fr-par-1, fr-par-2 and nl-ams-1.
server_id
required string
ID of the server.
option_id
required string
ID of the option to delete.
200 Response
id
string
ID of the server.
organization_id
string
Organization ID the server is attached to.
project_id
string
Project ID the server is attached to.
name
string
Name of the server.
description
string
Description of the server.
updated_at
string
Date of last modification of the server (RFC 3339 format).
created_at
string
Date of creation of the server (RFC 3339 format).
status
string
Status of the server. Possible values are unknown, delivering, ready, stopping, stopped, starting, error, deleting, locked, out_of_stock and ordered. The default value is unknown.
offer_id
string
Offer ID of the server.
offer_name
string
Offer name of the server.
tags
array
Array of customs tags attached to the server.
ips
array
Array of IPs attached to the server.
domain
string
Domain of the server.
boot_type
string
Boot type of the server. Possible values are unknown_boot_type, normal and rescue. The default value is unknown_boot_type.
zone
string
The zone in which is the server.
install
object
Configuration of installation.
ping_status
string
Server status of ping. Possible values are ping_status_unknown, ping_status_up and ping_status_down. The default value is ping_status_unknown.
options
array
Options enabled on server.
rescue_server
object
Configuration of rescue boot.
Response Example

Server Actions

Server actions allows you to start, stop or reboot your servers.

Reboot an elastic metal server

Reboot the server associated with the given ID, use boot param to reboot in rescue.

POST
/baremetal/v1/zones/{zone}/servers/{server_id}/reboot
Path Parameters
zone
required string
The zone you want to target. Possible values are fr-par-1, fr-par-2 and nl-ams-1.
server_id
required string
ID of the server to reboot.
Body
boot_type
string
The type of boot. Possible values are unknown_boot_type, normal and rescue. The default value is unknown_boot_type.
Request Example
200 Response
id
string
ID of the server.
organization_id
string
Organization ID the server is attached to.
project_id
string
Project ID the server is attached to.
name
string
Name of the server.
description
string
Description of the server.
updated_at
string
Date of last modification of the server (RFC 3339 format).
created_at
string
Date of creation of the server (RFC 3339 format).
status
string
Status of the server. Possible values are unknown, delivering, ready, stopping, stopped, starting, error, deleting, locked, out_of_stock and ordered. The default value is unknown.
offer_id
string
Offer ID of the server.
offer_name
string
Offer name of the server.
tags
array
Array of customs tags attached to the server.
ips
array
Array of IPs attached to the server.
domain
string
Domain of the server.
boot_type
string
Boot type of the server. Possible values are unknown_boot_type, normal and rescue. The default value is unknown_boot_type.
zone
string
The zone in which is the server.
install
object
Configuration of installation.
ping_status
string
Server status of ping. Possible values are ping_status_unknown, ping_status_up and ping_status_down. The default value is ping_status_unknown.
options
array
Options enabled on server.
rescue_server
object
Configuration of rescue boot.
Response Example

Start an elastic metal server

Start the server associated with the given ID.

POST
/baremetal/v1/zones/{zone}/servers/{server_id}/start
Path Parameters
zone
required string
The zone you want to target. Possible values are fr-par-1, fr-par-2 and nl-ams-1.
server_id
required string
ID of the server to start.
Body
boot_type
string
The type of boot. Possible values are unknown_boot_type, normal and rescue. The default value is unknown_boot_type.
Request Example
200 Response
id
string
ID of the server.
organization_id
string
Organization ID the server is attached to.
project_id
string
Project ID the server is attached to.
name
string
Name of the server.
description
string
Description of the server.
updated_at
string
Date of last modification of the server (RFC 3339 format).
created_at
string
Date of creation of the server (RFC 3339 format).
status
string
Status of the server. Possible values are unknown, delivering, ready, stopping, stopped, starting, error, deleting, locked, out_of_stock and ordered. The default value is unknown.
offer_id
string
Offer ID of the server.
offer_name
string
Offer name of the server.
tags
array
Array of customs tags attached to the server.
ips
array
Array of IPs attached to the server.
domain
string
Domain of the server.
boot_type
string
Boot type of the server. Possible values are unknown_boot_type, normal and rescue. The default value is unknown_boot_type.
zone
string
The zone in which is the server.
install
object
Configuration of installation.
ping_status
string
Server status of ping. Possible values are ping_status_unknown, ping_status_up and ping_status_down. The default value is ping_status_unknown.
options
array
Options enabled on server.
rescue_server
object
Configuration of rescue boot.
Response Example

Stop an elastic metal server

Stop the server associated with the given ID.

POST
/baremetal/v1/zones/{zone}/servers/{server_id}/stop
Path Parameters
zone
required string
The zone you want to target. Possible values are fr-par-1, fr-par-2 and nl-ams-1.
server_id
required string
ID of the server to stop.
Body
Request Example
200 Response
id
string
ID of the server.
organization_id
string
Organization ID the server is attached to.
project_id
string
Project ID the server is attached to.
name
string
Name of the server.
description
string
Description of the server.
updated_at
string
Date of last modification of the server (RFC 3339 format).
created_at
string
Date of creation of the server (RFC 3339 format).
status
string
Status of the server. Possible values are unknown, delivering, ready, stopping, stopped, starting, error, deleting, locked, out_of_stock and ordered. The default value is unknown.
offer_id
string
Offer ID of the server.
offer_name
string
Offer name of the server.
tags
array
Array of customs tags attached to the server.
ips
array
Array of IPs attached to the server.
domain
string
Domain of the server.
boot_type
string
Boot type of the server. Possible values are unknown_boot_type, normal and rescue. The default value is unknown_boot_type.
zone
string
The zone in which is the server.
install
object
Configuration of installation.
ping_status
string
Server status of ping. Possible values are ping_status_unknown, ping_status_up and ping_status_down. The default value is ping_status_unknown.
options
array
Options enabled on server.
rescue_server
object
Configuration of rescue boot.
Response Example

BMC access

BMC (Baseboard Management Controller) access allow you to access serie console of your elastic metal server. The BMC (Baseboard Management Controller) access feature is available one hour after the installation of the server. You need first to create an option Remote Access. You will find the ID and the price with a call to listOffers (https://developers.scaleway.com/en/products/baremetal/api/#get-78db92). Then you can add the option https://developers.scaleway.com/en/products/baremetal/api/#post-b14abd. Do not forget to delete the Option. Then you need to create Remote Access https://developers.scaleway.com/en/products/baremetal/api/#post-1af723. And filnally Get Remote Access to get the login/password https://developers.scaleway.com/en/products/baremetal/api/#get-cefc0f.

Get BMC (Baseboard Management Controller) access for a given elastic metal server

Get the BMC (Baseboard Management Controller) access associated with the given ID.

GET
/baremetal/v1/zones/{zone}/servers/{server_id}/bmc-access
Path Parameters
zone
required string
The zone you want to target. Possible values are fr-par-1, fr-par-2 and nl-ams-1.
server_id
required string
ID of the server.
200 Response
url
string
URL to access to the server console.
login
string
The login to use for the BMC (Baseboard Management Controller) access authentification.
password
string
The password to use for the BMC (Baseboard Management Controller) access authentification.
expires_at
string
The date after which the BMC (Baseboard Management Controller) access will be closed (RFC 3339 format).
Response Example

Start BMC (Baseboard Management Controller) access for a given elastic metal server

Start BMC (Baseboard Management Controller) access associated with the given ID. The BMC (Baseboard Management Controller) access is available one hour after the installation of the server. You need first to create an option Remote Access. You will find the ID and the price with a call to listOffers (https://developers.scaleway.com/en/products/baremetal/api/#get-78db92). Then you can add the option https://developers.scaleway.com/en/products/baremetal/api/#post-b14abd. Do not forget to delete the Option. After start BMC, you need to Get Remote Access to get the login/password https://developers.scaleway.com/en/products/baremetal/api/#get-cefc0f.

POST
/baremetal/v1/zones/{zone}/servers/{server_id}/bmc-access
Path Parameters
zone
required string
The zone you want to target. Possible values are fr-par-1, fr-par-2 and nl-ams-1.
server_id
required string
ID of the server.
Body
ip
required string
The IP authorized to connect to the given server (IPv4 address).
Request Example
200 Response
url
string
URL to access to the server console.
login
string
The login to use for the BMC (Baseboard Management Controller) access authentification.
password
string
The password to use for the BMC (Baseboard Management Controller) access authentification.
expires_at
string
The date after which the BMC (Baseboard Management Controller) access will be closed (RFC 3339 format).
Response Example

Stop BMC (Baseboard Management Controller) access for a given elastic metal server

Stop BMC (Baseboard Management Controller) access associated with the given ID.

DELETE
/baremetal/v1/zones/{zone}/servers/{server_id}/bmc-access
Path Parameters
zone
required string
The zone you want to target. Possible values are fr-par-1, fr-par-2 and nl-ams-1.
server_id
required string
ID of the server.
204 Response
Empty response

List offers

List all available server offers.

GET
/baremetal/v1/zones/{zone}/offers
Path Parameters
zone
required string
The zone you want to target. Possible values are fr-par-1, fr-par-2 and nl-ams-1.
Query Parameters
page
number
Page number. The default value is 1.
page_size
number
Number of offers per page. The default value is 20.
subscription_period
string
Period of subscription to filter offers. Possible values are unknown_subscription_period, hourly and monthly. The default value is unknown_subscription_period.
200 Response
total_count
number
Total count of matching offers.
offers
array
Offers that match filters.
Response Example

Get offer

Return specific offer for the given ID.

GET
/baremetal/v1/zones/{zone}/offers/{offer_id}
Path Parameters
zone
required string
The zone you want to target. Possible values are fr-par-1, fr-par-2 and nl-ams-1.
offer_id
required string
ID of the researched Offer.
200 Response
id
string
ID of the offer.
name
string
Name of the offer.
stock
string
Stock level. Possible values are empty, low and available. The default value is empty.
bandwidth
number
Bandwidth available in bits/s with the offer.
commercial_range
string
Commercial range of the offer.
price_per_hour
object
Price of the offer for the next 60 minutes (a server order at 11h32 will be payed until 12h32).
price_per_month
object
Price of the offer per months.
disks
array
Disks specifications of the offer.
enable
boolean
True if the offer is currently available.
cpus
array
CPU specifications of the offer.
memories
array
Memory specifications of the offer.
quota_name
string
Name of the quota associated to the offer.
persistent_memories
array
Persistent memory specifications of the offer.
raid_controllers
array
Raid controller specifications of the offer.
incompatible_os_ids
array
Array of incompatible OS ids.
subscription_period
string
Period of subscription for the offer. Possible values are unknown_subscription_period, hourly and monthly. The default value is unknown_subscription_period.
operation_path
string
Operation path of the service.
fee
object
Fee to pay on order.
options
array
Options available on offer.
Response Example

List options

List all options matching with filters.

GET
/baremetal/v1/zones/{zone}/options
Path Parameters
zone
required string
The zone you want to target. Possible values are fr-par-1, fr-par-2 and nl-ams-1.
Query Parameters
page
number
Page number. The default value is 1.
page_size
number
Number of options per page. The default value is 20.
offer_id
nullable string
Filter options by offer_id.
name
nullable string
Filter options by name.
200 Response
total_count
number
Total count of matching options.
options
array
Options that match filters.
Response Example

Get option

Return specific option for the given ID.

GET
/baremetal/v1/zones/{zone}/options/{option_id}
Path Parameters
zone
required string
The zone you want to target. Possible values are fr-par-1, fr-par-2 and nl-ams-1.
option_id
required string
ID of the option.
200 Response
id
string
ID of the option.
name
string
Name of the option.
manageable
boolean
Is false if the option could not be added or removed.
Response Example

List all settings

Return all settings for a project ID.

GET
/baremetal/v1/zones/{zone}/settings
Path Parameters
zone
required string
The zone you want to target. Possible values are fr-par-1, fr-par-2 and nl-ams-1.
Query Parameters
page
number
Page number. The default value is 1.
page_size
number
Set the maximum list size. The default value is 20.
order_by
string
Order the response. Possible values are created_at_asc and created_at_desc. The default value is created_at_asc.
project_id
required string
ID of the project (UUID format).
200 Response
total_count
number
Total count of matching sttings.
settings
array
Settings that match filters.
Response Example

Update setting

Update a setting for a project ID (enable or disable).

PATCH
/baremetal/v1/zones/{zone}/settings/{setting_id}
Path Parameters
zone
required string
The zone you want to target. Possible values are fr-par-1, fr-par-2 and nl-ams-1.
setting_id
required string
ID of the setting.
Body
enabled
nullable boolean
Enable/Disable the setting.
Request Example
200 Response
id
string
ID of the setting.
type
string
Type of the setting. Possible values are unknown and smtp. The default value is unknown.
project_id
string
ID of the project ID.
enabled
boolean
The setting is enable or disable.
Response Example

List all available OS that can be install on an elastic metal server

List all available OS that can be install on an elastic metal server.

GET
/baremetal/v1/zones/{zone}/os
Path Parameters
zone
required string
The zone you want to target. Possible values are fr-par-1, fr-par-2 and nl-ams-1.
Query Parameters
page
number
Page number. The default value is 1.
page_size
number
Number of OS per page. The default value is 20.
offer_id
nullable string
Filter OS by offer ID.
200 Response
total_count
number
Total count of matching OS.
os
array
OS that match filters.
Response Example

Get an OS with a given ID

Return specific OS for the given ID.

GET
/baremetal/v1/zones/{zone}/os/{os_id}
Path Parameters
zone
required string
The zone you want to target. Possible values are fr-par-1, fr-par-2 and nl-ams-1.
os_id
required string
ID of the OS.
200 Response
id
string
ID of the OS.
name
string
Name of the OS.
version
string
Version of the OS.
logo_url
string
URL of this os's logo.
ssh
object
Define the SSH requirements to install the OS.
user
object
Define the username requirements to install the OS.
password
object
Define the password requirements to install the OS.
service_user
object
Define the username requirements to install the service.
service_password
object
Define the password requirements to install the service.
enabled
boolean
State of OS.
Response Example