Apple siliconv1alpha1

Download OpenAPI

Scaleway Apple silicon M1 as-a-Service is built using the latest generation of Apple Mac mini hardware (fifth generation).

These dedicated Mac mini M1s are designed for developing, building, testing, and signing applications for Apple devices, including iPhones, iPads, Mac computers and much more.

Get set to explore, learn and build on a dedicated Mac mini M1 with more performance and speed than you ever thought possible.

Apple silicon as a Service comes with a minimum allocation period of 24 hours.

Mac mini and macOS are trademarks of Apple Inc., registered in the U.S. and other countries and regions. IOS is a trademark or registered trademark of Cisco in the U.S. and other countries and is used by Apple under license. Scaleway is not affiliated with Apple Inc.

Servers

List all servers

List all servers.

GET
/apple-silicon/v1alpha1/zones/{zone}/servers
Path Parameters
zone
required string
The global you want to target.
Query Parameters
order_by
string
The sort order of the returned servers. Possible values are created_at_asc and created_at_desc. The default value is created_at_asc.
project_id
nullable string
List only servers of this project ID.
organization_id
nullable string
List only servers of this organization ID.
page
number
A positive integer to choose the page to return. The default value is 1.
page_size
number
A positive integer lower or equal to 100 to select the number of items to return. The default value is 50.
200 Response
total_count
number
The total number of servers.
servers
array
The paginated returned servers.
id
string
UUID of the server.
type
string
Type of the server.
name
string
Name of the server.
project_id
string
Project this server is associated with.
organization_id
string
Organization this server is associated with.
ip
string
IPv4 address of the server (IPv4 address).
vnc_url
string
URL of the VNC.
status
string
Current status of the server. Possible values are unknown_status, starting, ready, error, rebooting, updating, locking, locked, unlocking and reinstalling. The default value is unknown_status.
created_at
string
The date at which the server was created.
updated_at
string
The date at which the server was last updated.
deletable_at
string
The date at which the server was last deleted.
zone
string
The zone of the server.
Response Example
{
  "total_count": 42,
  "servers": [
    {
      "id": "string",
      "type": "string",
      "name": "string",
      "project_id": "string",
      "organization_id": "string",
      "ip": "1.2.3.4",
      "vnc_url": "string",
      "status": "unknown_status",
      "created_at": "string",
      "updated_at": "string",
      "deletable_at": "string",
      "zone": "string"
    }
  ]
}

Create a server

Create a server.

POST
/apple-silicon/v1alpha1/zones/{zone}/servers
Path Parameters
zone
required string
The global you want to target.
Body
name
string
Create a server with this given name.
project_id
string
Create a server in the given project ID.
type
string
Create a server of the given type.
Request Example
{
  "name": "string",
  "project_id": "string",
  "type": "string"
}
200 Response
id
string
UUID of the server.
type
string
Type of the server.
name
string
Name of the server.
project_id
string
Project this server is associated with.
organization_id
string
Organization this server is associated with.
ip
string
IPv4 address of the server (IPv4 address).
vnc_url
string
URL of the VNC.
status
string
Current status of the server. Possible values are unknown_status, starting, ready, error, rebooting, updating, locking, locked, unlocking and reinstalling. The default value is unknown_status.
created_at
string
The date at which the server was created.
updated_at
string
The date at which the server was last updated.
deletable_at
string
The date at which the server was last deleted.
zone
string
The zone of the server.
Response Example
{
  "id": "string",
  "type": "string",
  "name": "string",
  "project_id": "string",
  "organization_id": "string",
  "ip": "1.2.3.4",
  "vnc_url": "string",
  "status": "unknown_status",
  "created_at": "string",
  "updated_at": "string",
  "deletable_at": "string",
  "zone": "string"
}

Get a server

Get a server.

GET
/apple-silicon/v1alpha1/zones/{zone}/servers/{server_id}
Path Parameters
zone
required string
The global you want to target.
server_id
required string
UUID of the server you want to get.
200 Response
id
string
UUID of the server.
type
string
Type of the server.
name
string
Name of the server.
project_id
string
Project this server is associated with.
organization_id
string
Organization this server is associated with.
ip
string
IPv4 address of the server (IPv4 address).
vnc_url
string
URL of the VNC.
status
string
Current status of the server. Possible values are unknown_status, starting, ready, error, rebooting, updating, locking, locked, unlocking and reinstalling. The default value is unknown_status.
created_at
string
The date at which the server was created.
updated_at
string
The date at which the server was last updated.
deletable_at
string
The date at which the server was last deleted.
zone
string
The zone of the server.
Response Example
{
  "id": "string",
  "type": "string",
  "name": "string",
  "project_id": "string",
  "organization_id": "string",
  "ip": "1.2.3.4",
  "vnc_url": "string",
  "status": "unknown_status",
  "created_at": "string",
  "updated_at": "string",
  "deletable_at": "string",
  "zone": "string"
}

Update a server

Update a server.

PATCH
/apple-silicon/v1alpha1/zones/{zone}/servers/{server_id}
Path Parameters
zone
required string
The global you want to target.
server_id
required string
UUID of the server you want to update.
Body
name
required string
Updated name for your server.
Request Example
{
  "name": "string"
}
200 Response
id
string
UUID of the server.
type
string
Type of the server.
name
string
Name of the server.
project_id
string
Project this server is associated with.
organization_id
string
Organization this server is associated with.
ip
string
IPv4 address of the server (IPv4 address).
vnc_url
string
URL of the VNC.
status
string
Current status of the server. Possible values are unknown_status, starting, ready, error, rebooting, updating, locking, locked, unlocking and reinstalling. The default value is unknown_status.
created_at
string
The date at which the server was created.
updated_at
string
The date at which the server was last updated.
deletable_at
string
The date at which the server was last deleted.
zone
string
The zone of the server.
Response Example
{
  "id": "string",
  "type": "string",
  "name": "string",
  "project_id": "string",
  "organization_id": "string",
  "ip": "1.2.3.4",
  "vnc_url": "string",
  "status": "unknown_status",
  "created_at": "string",
  "updated_at": "string",
  "deletable_at": "string",
  "zone": "string"
}

Delete a server

Delete a server.

DELETE
/apple-silicon/v1alpha1/zones/{zone}/servers/{server_id}
Path Parameters
zone
required string
The global you want to target.
server_id
required string
UUID of the server you want to delete.
204 Response
Empty response

Reboot a server

Reboot a server.

POST
/apple-silicon/v1alpha1/zones/{zone}/servers/{server_id}/reboot
Path Parameters
zone
required string
The global you want to target.
server_id
required string
UUID of the server you want to reboot.
Body
Request Example
{}
200 Response
id
string
UUID of the server.
type
string
Type of the server.
name
string
Name of the server.
project_id
string
Project this server is associated with.
organization_id
string
Organization this server is associated with.
ip
string
IPv4 address of the server (IPv4 address).
vnc_url
string
URL of the VNC.
status
string
Current status of the server. Possible values are unknown_status, starting, ready, error, rebooting, updating, locking, locked, unlocking and reinstalling. The default value is unknown_status.
created_at
string
The date at which the server was created.
updated_at
string
The date at which the server was last updated.
deletable_at
string
The date at which the server was last deleted.
zone
string
The zone of the server.
Response Example
{
  "id": "string",
  "type": "string",
  "name": "string",
  "project_id": "string",
  "organization_id": "string",
  "ip": "1.2.3.4",
  "vnc_url": "string",
  "status": "unknown_status",
  "created_at": "string",
  "updated_at": "string",
  "deletable_at": "string",
  "zone": "string"
}

Reinstall a server

Reinstall a server.

POST
/apple-silicon/v1alpha1/zones/{zone}/servers/{server_id}/reinstall
Path Parameters
zone
required string
The global you want to target.
server_id
required string
UUID of the server you want to reinstall.
Body
Request Example
{}
200 Response
id
string
UUID of the server.
type
string
Type of the server.
name
string
Name of the server.
project_id
string
Project this server is associated with.
organization_id
string
Organization this server is associated with.
ip
string
IPv4 address of the server (IPv4 address).
vnc_url
string
URL of the VNC.
status
string
Current status of the server. Possible values are unknown_status, starting, ready, error, rebooting, updating, locking, locked, unlocking and reinstalling. The default value is unknown_status.
created_at
string
The date at which the server was created.
updated_at
string
The date at which the server was last updated.
deletable_at
string
The date at which the server was last deleted.
zone
string
The zone of the server.
Response Example
{
  "id": "string",
  "type": "string",
  "name": "string",
  "project_id": "string",
  "organization_id": "string",
  "ip": "1.2.3.4",
  "vnc_url": "string",
  "status": "unknown_status",
  "created_at": "string",
  "updated_at": "string",
  "deletable_at": "string",
  "zone": "string"
}

Get a server type

Get a server technical details.

GET
/apple-silicon/v1alpha1/zones/{zone}/server-type/{server_type}
Path Parameters
zone
required string
The global you want to target.
server_type
required string
Server type identifier.
200 Response
cpu
object
CPU description.
name
string
core_count
number
disk
object
Size of the local disk of the server.
capacity
number
(in bytes).
type
string
name
string
Name of the type.
memory
object
Size of memory available.
capacity
number
(in bytes).
type
string
stock
string
Current stock. Possible values are unknown_stock, no_stock, low_stock and high_stock. The default value is unknown_stock.
minimum_lease_duration
nullable string
Minimum duration of the lease in seconds (example. 3.4s). (in seconds).
Response Example
{
  "cpu": {
    "name": "string",
    "core_count": 42
  },
  "disk": {
    "capacity": 42,
    "type": "string"
  },
  "name": "string",
  "memory": {
    "capacity": 42,
    "type": "string"
  },
  "stock": "unknown_stock",
  "minimum_lease_duration": "2.5s"
}

List server types

List all server types technical details.

GET
/apple-silicon/v1alpha1/zones/{zone}/server-types
Path Parameters
zone
required string
The global you want to target.
200 Response
server_types
array
The available server types.
cpu
object
CPU description.
name
string
core_count
number
disk
object
Size of the local disk of the server.
capacity
number
(in bytes).
type
string
name
string
Name of the type.
memory
object
Size of memory available.
capacity
number
(in bytes).
type
string
stock
string
Current stock. Possible values are unknown_stock, no_stock, low_stock and high_stock. The default value is unknown_stock.
minimum_lease_duration
nullable string
Minimum duration of the lease in seconds (example. 3.4s). (in seconds).
Response Example
{
  "server_types": [
    {
      "cpu": {
        "name": "string",
        "core_count": 42
      },
      "disk": {
        "capacity": 42,
        "type": "string"
      },
      "name": "string",
      "memory": {
        "capacity": 42,
        "type": "string"
      },
      "stock": "unknown_stock",
      "minimum_lease_duration": "2.5s"
    }
  ]
}

List all Operating System (OS)

List all Operating System (OS).

GET
/apple-silicon/v1alpha1/zones/{zone}/os
Path Parameters
zone
required string
The global you want to target.
Query Parameters
page
number
A positive integer to choose the page to return. The default value is 1.
page_size
number
A positive integer lower or equal to 100 to select the number of items to return. The default value is 50.
server_type
nullable string
List of compatible server type.
name
nullable string
Filter os by name (for eg. "11.1" will return "11.1.2" and "11.1" but not "12").
200 Response
total_count
number
Total number of os.
os
array
List of OS.
id
string
The OS unique ID.
name
string
The OS name.
label
string
The OS name as it should be displayed.
image_url
string
URL of the image.
compatible_server_types
array
List of compatible server types.
Response Example
{
  "total_count": 42,
  "os": [
    {
      "id": "string",
      "name": "string",
      "label": "string",
      "image_url": "string",
      "compatible_server_types": [
        "string"
      ]
    }
  ]
}

Get an Operating System (OS)

Get an Operating System (OS).

GET
/apple-silicon/v1alpha1/zones/{zone}/os/{os_id}
Path Parameters
zone
required string
The global you want to target.
os_id
required string
UUID of the OS you want to get.
200 Response
id
string
The OS unique ID.
name
string
The OS name.
label
string
The OS name as it should be displayed.
image_url
string
URL of the image.
compatible_server_types
array
List of compatible server types.
Response Example
{
  "id": "string",
  "name": "string",
  "label": "string",
  "image_url": "string",
  "compatible_server_types": [
    "string"
  ]
}

MISC

MISC methods

GetServiceInfo

GET
/apple-silicon/v1alpha1/zones/{zone}
Path Parameters
zone
required string
The global you want to target.
200 Response
name
string
description
string
version
string
documentation_url
nullable string
Response Example
{
  "name": "string",
  "description": "string",
  "version": "string",
  "documentation_url": "string"
}