List all available OS that can be install on a baremetal server
path Parameters
zoneThe zone you want to target
query Parameters
server_idFilter OS by compatible server ID.
pagePage number.
page_sizeNumber of OS per page.
order_byOrder of the OS.
typeType of the OS.
project_idProject ID.
List all available OS that can be install on a baremetal server › Responses
total_countTotal count of matching OS.
OS that match filters.
Get an OS with a given ID
Return specific OS for the given ID.
path Parameters
zoneThe zone you want to target
os_idID of the OS.
query Parameters
server_idID of the server.
project_idProject ID.
Get an OS with a given ID › Responses
idID of the OS.
nameName of the OS.
typeType of the OS.
versionVersion of the OS.
archArchitecture of the OS.
allow_custom_partitioningTrue if the OS allow custom partitioning.
allow_ssh_keysTrue if the OS allow SSH Keys.
requires_userTrue if the OS requires user.
requires_admin_passwordTrue if the OS requires admin password.
requires_panel_passwordTrue if the OS requires panel password.
allowed_filesystemsTrue if the OS allow file systems.
requires_licenseTrue if the OS requires license.
License offers available with the OS.
max_partitionsMaximum number of partitions which can be created.
display_nameDisplay name of the OS.
password_regexRegex used to validate the installation passwords.
panel_password_regexRegex used to validate the panel installation password.
requires_valid_hostnameWhether or not the installation requires a valid hostname (ex: my.scaleway.com). If both requires_valid_hostname & hostname_regex are set, it means that at least one of the criteria must be valid.
hostname_regexRegex used to validate the hostname during the installation. If both requires_valid_hostname & hostname_regex are set, it means that at least one of the criteria must be valid.
hostname_max_lengthHostname max length.
released_atOS release date. (RFC 3339 format)