Operating System

Download schema

List all available OS that can be install on a baremetal server

GET

https://api.scaleway.com

/dedibox/v1/zones/{zone}/os

List all available OS that can be install on a baremetal server › path Parameters

zone

string · enum · required

The zone you want to target

Enum values:

fr-par-1

fr-par-2

nl-ams-1

List all available OS that can be install on a baremetal server › query Parameters

page

integer · uint32

Page number.

page_size

integer · uint32

Number of OS per page.

order_by

scaleway.dedibox.v1.ListOSRequest.OrderBy · enum

Order of the OS.

Enum values:

created_at_asc

created_at_desc

released_at_asc

released_at_desc

Default: created_at_asc

type

scaleway.dedibox.v1.OS.Type · enum

Type of the OS.

Enum values:

unknown_type

server

virtu

panel

desktop

custom

rescue

Default: unknown_type

project_id

string

Project ID.

List all available OS that can be install on a baremetal server › Responses

200

scaleway.dedibox.v1.ListOSResponse

total_count

integer · uint32

Total count of matching OS.

scaleway.dedibox.v1.OS[]

OS that match filters.

GET/dedibox/v1/zones/{zone}/os

curl -X GET \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  "https://api.scaleway.com/dedibox/v1/zones/{zone}/os"

Example Responses

{
  "total_count": 0,
  "os": [
    {
      "id": 0,
      "name": "name",
      "type": "unknown_type",
      "version": "version",
      "arch": "unknown_arch",
      "allow_custom_partitioning": true,
      "allow_ssh_keys": true,
      "requires_user": true,
      "requires_admin_password": true,
      "requires_panel_password": true,
      "allowed_filesystems": [
        "unknown"
      ],
      "requires_license": true,
      "license_offers": [
        {
          "id": 0,
          "name": "name",
          "catalog": "all",
          "payment_frequency": "monthly",
          "pricing": {
            "currency_code": "currency_code",
            "units": 0,
            "nanos": 0
          },
          "offer_id": 0,
          "server_info": {
            "bandwidth": 0,
            "stock": "empty",
            "commercial_range": "commercial_range",
            "disks": [
              {
                "capacity": 0,
                "type": "sata"
              }
            ],
            "cpus": [
              {
                "name": "name",
                "core_count": 0,
                "thread_count": 0,
                "frequency": 0
              }
            ],
            "memories": [
              {
                "capacity": 0,
                "type": "ddr2",
                "frequency": 0,
                "is_ecc": true
              }
            ],
            "persistent_memories": [
              {
                "capacity": 0,
                "frequency": 0,
                "model": "model"
              }
            ],
            "raid_controllers": [
              {
                "model": "model",
                "raid_level": [
                  "string"
                ]
              }
            ],
            "available_options": [
              null
            ],
            "rpn_version": 0,
            "connectivity": 0,
            "stock_by_datacenter": {
              "<stock_by_datacenterKey>": "empty"
            }
          },
          "service_level_info": {
            "support_ticket": true,
            "support_phone": true,
            "sales_support": true,
            "git": "git",
            "sla": 0,
            "priority_support": true,
            "high_rpn_bandwidth": true,
            "customization": true,
            "antidos": true,
            "extra_failover_quota": 0,
            "available_options": [
              null
            ]
          },
          "rpn_info": {
            "speed": 0
          },
          "san_info": {
            "size": 0,
            "ha": true,
            "device_type": "hdd"
          },
          "antidos_info": {
            "type": "minimal"
          },
          "backup_info": {
            "size": 0
          },
          "usb_storage_info": {
            "max_quota": 0,
            "size": 0
          },
          "storage_info": {
            "max_quota": 0,
            "size": 0
          },
          "license_info": {
            "bound_to_ip": true
          },
          "failover_ip_info": {},
          "failover_block_info": {},
          "bandwidth_info": {
            "speed": 0
          }
        }
      ],
      "max_partitions": 0,
      "display_name": "display_name",
      "password_regex": "password_regex",
      "panel_password_regex": "panel_password_regex",
      "requires_valid_hostname": true,
      "hostname_regex": "hostname_regex",
      "hostname_max_length": 0,
      "released_at": "2022-03-22T12:34:56.123456Z"
    }
  ]
}

json

application/json

Get an OS with a given ID

GET

https://api.scaleway.com

/dedibox/v1/zones/{zone}/os/{os_id}

Return specific OS for the given ID.

Get an OS with a given ID › path Parameters

zone

string · enum · required

The zone you want to target

Enum values:

fr-par-1

fr-par-2

nl-ams-1

os_id

integer · uint64 · required

ID of the OS.

Get an OS with a given ID › query Parameters

server_id

integer · uint64 · required

ID of the server.

project_id

string

Project ID.

Get an OS with a given ID › Responses

200

scaleway.dedibox.v1.OS

id

integer · uint64

ID of the OS.

name

string

Name of the OS.

type

scaleway.dedibox.v1.OS.Type · enum

Type of the OS.

Enum values:

unknown_type

server

virtu

panel

desktop

custom

rescue

Default: unknown_type

version

string

Version of the OS.

arch

scaleway.dedibox.v1.OS.Arch · enum

Architecture of the OS.

Enum values:

unknown_arch

amd64

x86

arm

arm64

Default: unknown_arch

allow_custom_partitioning

boolean

True if the OS allow custom partitioning.

allow_ssh_keys

boolean

True if the OS allow SSH Keys.

requires_user

boolean

True if the OS requires user.

requires_admin_password

boolean

True if the OS requires admin password.

requires_panel_password

boolean

True if the OS requires panel password.

allowed_filesystems

scaleway.dedibox.v1.Partition.FileSystem[]

True if the OS allow file systems.

Enum values:

unknown

efi

swap

ext4

ext3

ext2

xfs

ntfs

requires_license

boolean

True if the OS requires license.

scaleway.dedibox.v1.Offer[]

License offers available with the OS.

max_partitions

integer | null · uint32

Maximum number of partitions which can be created.

display_name

string

Display name of the OS.

password_regex

string

Regex used to validate the installation passwords.

panel_password_regex

string | null

Regex used to validate the panel installation password.

requires_valid_hostname

boolean | null

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

string | null

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

integer · uint32

Hostname max length.

released_at

string | null · date-time

OS release date. (RFC 3339 format)

GET/dedibox/v1/zones/{zone}/os/{os_id}

curl -X GET \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  "https://api.scaleway.com/dedibox/v1/zones/{zone}/os/{os_id}?server_id=42"

Example Responses

{
  "id": 0,
  "name": "name",
  "type": "unknown_type",
  "version": "version",
  "arch": "unknown_arch",
  "allow_custom_partitioning": true,
  "allow_ssh_keys": true,
  "requires_user": true,
  "requires_admin_password": true,
  "requires_panel_password": true,
  "allowed_filesystems": [
    "unknown"
  ],
  "requires_license": true,
  "license_offers": [
    {
      "id": 0,
      "name": "name",
      "catalog": "all",
      "payment_frequency": "monthly",
      "pricing": {
        "currency_code": "currency_code",
        "units": 0,
        "nanos": 0
      },
      "offer_id": 0,
      "server_info": {
        "bandwidth": 0,
        "stock": "empty",
        "commercial_range": "commercial_range",
        "disks": [
          {
            "capacity": 0,
            "type": "sata"
          }
        ],
        "cpus": [
          {
            "name": "name",
            "core_count": 0,
            "thread_count": 0,
            "frequency": 0
          }
        ],
        "memories": [
          {
            "capacity": 0,
            "type": "ddr2",
            "frequency": 0,
            "is_ecc": true
          }
        ],
        "persistent_memories": [
          {
            "capacity": 0,
            "frequency": 0,
            "model": "model"
          }
        ],
        "raid_controllers": [
          {
            "model": "model",
            "raid_level": [
              "string"
            ]
          }
        ],
        "available_options": [
          null
        ],
        "rpn_version": 0,
        "connectivity": 0,
        "stock_by_datacenter": {
          "<stock_by_datacenterKey>": "empty"
        }
      },
      "service_level_info": {
        "support_ticket": true,
        "support_phone": true,
        "sales_support": true,
        "git": "git",
        "sla": 0,
        "priority_support": true,
        "high_rpn_bandwidth": true,
        "customization": true,
        "antidos": true,
        "extra_failover_quota": 0,
        "available_options": [
          null
        ]
      },
      "rpn_info": {
        "speed": 0
      },
      "san_info": {
        "size": 0,
        "ha": true,
        "device_type": "hdd"
      },
      "antidos_info": {
        "type": "minimal"
      },
      "backup_info": {
        "size": 0
      },
      "usb_storage_info": {
        "max_quota": 0,
        "size": 0
      },
      "storage_info": {
        "max_quota": 0,
        "size": 0
      },
      "license_info": {
        "bound_to_ip": true
      },
      "failover_ip_info": {},
      "failover_block_info": {},
      "bandwidth_info": {
        "speed": 0
      }
    }
  ],
  "max_partitions": 0,
  "display_name": "display_name",
  "password_regex": "password_regex",
  "panel_password_regex": "panel_password_regex",
  "requires_valid_hostname": true,
  "hostname_regex": "hostname_regex",
  "hostname_max_length": 0,
  "released_at": "2022-03-22T12:34:56.123456Z"
}

json

application/json

Offers Network