OS

Download schema

Operating systems (OS) available for a given Mac mini server type. The macOS versions available for our Mac mini are macOS 13 Ventura, macOS 14 Sonoma, and macOS 15 Sequoia. Other OSes, e.g. Linux OS or Windows OS are not supported.

List all Operating Systems (OS)

GET

https://api.scaleway.com

/apple-silicon/v1alpha1/zones/{zone}/os

List all Operating Systems (OS). The response will include the total number of OS as well as their associated IDs, names and labels.

List all Operating Systems (OS) › path Parameters

zone

string · enum · required

The zone you want to target

Enum values:

fr-par-3

List all Operating Systems (OS) › query Parameters

page

integer · int32

Positive integer to choose the page to return.

page_size

integer · uint32

Positive integer lower or equal to 100 to select the number of items to return.

server_type

string

List of compatible server types.

name

string

Filter OS by name (note that "11.1" will return "11.1.2" and "11.1" but not "12")).

List all Operating Systems (OS) › Responses

200

scaleway.apple_silicon.v1alpha1.ListOSResponse

total_count

integer · uint32

Total number of OS.

scaleway.apple_silicon.v1alpha1.OS[]

List of OS.

GET/apple-silicon/v1alpha1/zones/{zone}/os

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

Example Responses

{
  "total_count": 0,
  "os": [
    {
      "id": "id",
      "name": "name",
      "label": "label",
      "image_url": "image_url",
      "family": "family",
      "is_beta": true,
      "version": "version",
      "xcode_version": "xcode_version",
      "compatible_server_types": [
        "string"
      ],
      "release_notes_url": "release_notes_url",
      "description": "description",
      "tags": [
        "string"
      ],
      "supported_server_types": [
        {
          "server_type": "server_type",
          "fast_delivery_available": true
        }
      ],
      "zone": "zone"
    }
  ]
}

json

application/json

Get an Operating System (OS)

GET

https://api.scaleway.com

/apple-silicon/v1alpha1/zones/{zone}/os/{os_id}

Get an Operating System (OS). The response will include the OS's unique ID as well as its name and label.

Get an Operating System (OS) › path Parameters

zone

string · enum · required

The zone you want to target

Enum values:

fr-par-3

os_id

string · required

UUID of the OS you want to get.

Get an Operating System (OS) › Responses

200

scaleway.apple_silicon.v1alpha1.OS

id

string

Unique ID of the OS.

name

string

OS name.

label

string

OS name as it should be displayed.

image_url

string

URL of the image.

family

string

The OS family to which this OS belongs, eg. 13 or 14.

is_beta

boolean

Describes if the OS is in beta.

version

string

The OS version number, eg. Sonoma has version number 14.3.

xcode_version

string

The current xcode version for this OS.

release_notes_url

string

Url of the release notes for the OS image or software pre-installed.

description

string

A summary of the OS image content and configuration.

tags

string[]

List of tags for the OS configuration.

scaleway.apple_silicon.v1alpha1.OS.SupportedServerType[]

List of server types which supports the OS configuration. Also gives information about immediate stock availability.

zone

string

Zone of OS.

Server Types Runners