Scaleway logo
Elastic Metal API
Elastic Metal API

OS

Download schema

An Operating System (OS) is the underlying software installed on your server. This command lists the IDs of the OS available for this server.

List available OSes

GET
https://api.scaleway.com
/baremetal/v1/zones/{zone}/os

List all OSes that are available for installation on Elastic Metal servers.

List available OSes › path Parameters

zone
​string · enum · required

The zone you want to target

Enum values:
fr-par-1
fr-par-2
nl-ams-1
nl-ams-2
pl-waw-2
pl-waw-3

List available OSes › query Parameters

page
​integer · int32

Page number.

page_size
​integer · uint32

Number of OS per page.

offer_id
​string

Offer IDs to filter OSes for.

List available OSes › Responses

200
scaleway.baremetal.v1.ListOSResponse
total_count
​integer · uint32

Total count of matching OS.

OS that match filters.

Get OS with an ID

GET
https://api.scaleway.com
/baremetal/v1/zones/{zone}/os/{os_id}

Return the specific OS for the ID.

Get OS with an ID › path Parameters

zone
​string · enum · required

The zone you want to target

Enum values:
fr-par-1
fr-par-2
nl-ams-1
nl-ams-2
pl-waw-2
pl-waw-3
os_id
​string · required

ID of the OS.

Get OS with an ID › Responses

200
scaleway.baremetal.v1.OS
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.

Object defining the SSH requirements to install the OS.

Object defining the username requirements to install the OS.

Object defining the password requirements to install the OS.

Object defining the username requirements to install the service.

Object defining the password requirements to install the service.

enabled
​boolean

Defines if the operating system is enabled or not.

license_required
​boolean

License required (check server options for pricing details).

allowed
​boolean

Defines if a specific Organization is allowed to install this OS type.

custom_partitioning_supported
​boolean

Defines if custom partitioning is supported by this OS.

cloud_init_supported
​boolean

Defines if cloud-init is supported by this OS.

cloud_init_version
​string | null

Defines the cloud-init API version used by this OS.

Object defining the network boot requirements for booting server.

network_boot_persistent_editable
​boolean

Defines if the network boot can be persisted or not.

zone
​string

Zone in which is the OS is available.

OptionsPartitioning-schemas