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
List all OSes that are available for installation on Elastic Metal servers.
path Parameters
zoneThe zone you want to target
query Parameters
pagePage number.
page_sizeNumber of OS per page.
offer_idOffer IDs to filter OSes for.
List available OSes › Responses
total_countTotal count of matching OS.
OS that match filters.
Get OS with an ID
Return the specific OS for the ID.
path Parameters
zoneThe zone you want to target
os_idID of the OS.
Get OS with an ID › Responses
idID of the OS.
nameName of the OS.
versionVersion of the OS.
logo_urlURL 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.
enabledDefines if the operating system is enabled or not.
license_requiredLicense required (check server options for pricing details).
allowedDefines if a specific Organization is allowed to install this OS type.
custom_partitioning_supportedDefines if custom partitioning is supported by this OS.
cloud_init_supportedDefines if cloud-init is supported by this OS.
cloud_init_versionDefines the cloud-init API version used by this OS.
zoneZone in which is the OS is available.