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

Vnc:// URL to access Apple Remote Desktop.

ssh_username

string

SSH Username for remote shell.

sudo_password

string

Admin password required to execute commands.

vnc_port

integer · uint32

VNC port to use for remote desktop connection.

Initially installed OS. Initially installed OS, this does not necessarily reflect the current OS version.

full_os_version

string

Detailed initial installed OS version (..-). Initially installed OS, this does not necessarily reflect the current OS version.

status

scaleway.apple_silicon.v1alpha1.Server.Status · enum

Current status of the server.

Enum values:

unknown_status

starting

ready

error

rebooting

updating

locking

locked

Default: unknown_status

created_at

string | null · date-time

Date on which the server was created. (RFC 3339 format)

updated_at

string | null · date-time

Date on which the server was last updated. (RFC 3339 format)

deletable_at

string | null · date-time

Date from which the server can be deleted. (RFC 3339 format)

deletion_scheduled

boolean

If true, server will be automatically once deletable_at is reached. Set to true to mark the server for automatic deletion depending on deletable_at date. Set to false to cancel an existing deletion schedule. Leave unset otherwise.

zone

string

Zone of the server.

srn

string · pattern: ^srn://apple-silicon…

SRN of the server.

delivered

boolean

Indicate if the newly ordered server is ready to use. Set to true once the server has completed its provisioning steps and is ready to use. Some OS configurations might require a reinstallation of the server before delivery depending on the available stock. A reinstallation after the initial delivery will not change this flag and can be tracked using the server status.

vpc_status

scaleway.apple_silicon.v1alpha1.Server.PrivateNetworkStatus · enum

Activation status of optional Private Network feature support for this server.

Enum values:

vpc_unknown_status

vpc_enabled

vpc_updating

vpc_disabled

Default: vpc_unknown_status

Commitment scheme applied to this server.

public_bandwidth_bps

integer · uint64

Public bandwidth configured for this server. Expressed in bits per second.

tags

string[]

A list of tags attached to the server.

applied_runner_configuration_ids

string[]

Runner configurations applied on the server, optional.

kext_enabled

boolean

Status of kernel extensions for the server.

POST/apple-silicon/v1alpha1/zones/{zone}/servers

curl -X POST \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "enable_kext": false,
    "enable_vpc": false,
    "name": "string",
    "project_id": "string",
    "public_bandwidth_bps": 42,
    "type": "string"
  }' \
  "https://api.scaleway.com/apple-silicon/v1alpha1/zones/{zone}/servers"

Example Request Body

{
  "name": "name",
  "project_id": "project_id",
  "type": "type",
  "os_id": "os_id",
  "enable_vpc": true,
  "commitment_type": "duration_24h",
  "public_bandwidth_bps": 0,
  "runner_configuration": {
    "name": "name",
    "url": "url",
    "token": "token",
    "provider": "unknown_provider",
    "download_runner": true,
    "action": "unknown_action",
    "id": "id",
    "labels": [
      "string"
    ]
  },
  "applied_runner_configurations": {
    "runner_configuration_ids": [
      "6170692e-7363-616c-6577-61792e636f6d"
    ]
  },
  "enable_kext": true
}

json

Example Responses

{
  "id": "id",
  "type": "type",
  "name": "name",
  "project_id": "project_id",
  "organization_id": "organization_id",
  "ip": "1.2.3.4",
  "vnc_url": "vnc_url",
  "ssh_username": "ssh_username",
  "sudo_password": "sudo_password",
  "vnc_port": 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"
  },
  "full_os_version": "full_os_version",
  "status": "unknown_status",
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "deletable_at": "2022-03-22T12:34:56.123456Z",
  "deletion_scheduled": true,
  "zone": "zone",
  "srn": "srn",
  "delivered": true,
  "vpc_status": "vpc_unknown_status",
  "commitment": {
    "type": "duration_24h",
    "cancelled": true
  },
  "public_bandwidth_bps": 0,
  "runner_configuration": {
    "name": "name",
    "url": "url",
    "token": "token",
    "provider": "unknown_provider",
    "download_runner": true,
    "action": "unknown_action",
    "id": "id",
    "labels": [
      "string"
    ]
  },
  "tags": [
    "string"
  ],
  "applied_runner_configuration_ids": [
    "string"
  ],
  "kext_enabled": true
}

json

application/json

Get a server

GET

https://api.scaleway.com

/apple-silicon/v1alpha1/zones/{zone}/servers/{server_id}

Retrieve information about an existing Apple silicon server, specified by its server ID. Its full details, including name, status and IP address, are returned in the response object.

Get a server › path Parameters

zone

string · enum · required

The zone you want to target

Enum values:

fr-par-3

server_id

string · required

UUID of the server you want to get.

Get a server › Responses

200

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

Vnc:// URL to access Apple Remote Desktop.

ssh_username

string

SSH Username for remote shell.

sudo_password

string

Admin password required to execute commands.

vnc_port

integer · uint32

VNC port to use for remote desktop connection.

Initially installed OS. Initially installed OS, this does not necessarily reflect the current OS version.

full_os_version

string

Detailed initial installed OS version (..-). Initially installed OS, this does not necessarily reflect the current OS version.

status

scaleway.apple_silicon.v1alpha1.Server.Status · enum

Current status of the server.

Enum values:

unknown_status

starting

ready

error

rebooting

updating

locking

locked

Default: unknown_status

created_at

string | null · date-time

Date on which the server was created. (RFC 3339 format)

updated_at

string | null · date-time

Date on which the server was last updated. (RFC 3339 format)

deletable_at

string | null · date-time

Date from which the server can be deleted. (RFC 3339 format)

deletion_scheduled

boolean

zone

string

Zone of the server.

srn

string · pattern: ^srn://apple-silicon…

SRN of the server.

delivered

boolean

vpc_status

scaleway.apple_silicon.v1alpha1.Server.PrivateNetworkStatus · enum

Activation status of optional Private Network feature support for this server.

Enum values:

vpc_unknown_status

vpc_enabled

vpc_updating

vpc_disabled

Default: vpc_unknown_status

scaleway.apple_silicon.v1alpha1.CommitmentTypeValue

Commitment scheme applied to this server.

public_bandwidth_bps

integer · uint64

Public bandwidth configured for this server. Expressed in bits per second.

tags

string[]

A list of tags attached to the server.

applied_runner_configuration_ids

string[]

Runner configurations applied on the server, optional.

kext_enabled

boolean

Status of kernel extensions for the server.

GET/apple-silicon/v1alpha1/zones/{zone}/servers/{server_id}

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

Example Responses

{
  "id": "id",
  "type": "type",
  "name": "name",
  "project_id": "project_id",
  "organization_id": "organization_id",
  "ip": "1.2.3.4",
  "vnc_url": "vnc_url",
  "ssh_username": "ssh_username",
  "sudo_password": "sudo_password",
  "vnc_port": 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"
  },
  "full_os_version": "full_os_version",
  "status": "unknown_status",
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "deletable_at": "2022-03-22T12:34:56.123456Z",
  "deletion_scheduled": true,
  "zone": "zone",
  "srn": "srn",
  "delivered": true,
  "vpc_status": "vpc_unknown_status",
  "commitment": {
    "type": "duration_24h",
    "cancelled": true
  },
  "public_bandwidth_bps": 0,
  "runner_configuration": {
    "name": "name",
    "url": "url",
    "token": "token",
    "provider": "unknown_provider",
    "download_runner": true,
    "action": "unknown_action",
    "id": "id",
    "labels": [
      "string"
    ]
  },
  "tags": [
    "string"
  ],
  "applied_runner_configuration_ids": [
    "string"
  ],
  "kext_enabled": true
}

json

application/json

Update a server

PATCH

https://api.scaleway.com

/apple-silicon/v1alpha1/zones/{zone}/servers/{server_id}

Update the parameters of an existing Apple silicon server, specified by its server ID.

Update a server › path Parameters

zone

string · enum · required

The zone you want to target

Enum values:

fr-par-3

server_id

string · required

UUID of the server you want to update.

Update a server › Request Body

name

string | null

Updated name for your server.

schedule_deletion

boolean | null

Specify whether the server should be flagged for automatic deletion.

enable_vpc

boolean | null

Activate or deactivate Private Network support for this server.

Change commitment. Use 'none' to automatically cancel a renewing commitment.

public_bandwidth_bps

integer | null · uint64

Public bandwidth configured for this server. Public bandwidth to configure for this server. Setting an higher bandwidth incurs additional costs. Supported bandwidth levels depends on server type and can be queried using the /server-types endpoint.

scaleway.apple_silicon.v1alpha1.AppliedRunnerConfigurations

Runner configurations to apply on the server, optional. Runner configurations to apply on the server, existing ones missing from the specified configuration will be removed from the server.

Update a server › Responses

200

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

Vnc:// URL to access Apple Remote Desktop.

ssh_username

string

SSH Username for remote shell.

sudo_password

string

Admin password required to execute commands.

vnc_port

integer · uint32

VNC port to use for remote desktop connection.

Initially installed OS. Initially installed OS, this does not necessarily reflect the current OS version.

full_os_version

string

Detailed initial installed OS version (..-). Initially installed OS, this does not necessarily reflect the current OS version.

status

scaleway.apple_silicon.v1alpha1.Server.Status · enum

Current status of the server.

Enum values:

unknown_status

starting

ready

error

rebooting

updating

locking

locked

Default: unknown_status

created_at

string | null · date-time

Date on which the server was created. (RFC 3339 format)

updated_at

string | null · date-time

Date on which the server was last updated. (RFC 3339 format)

deletable_at

string | null · date-time

Date from which the server can be deleted. (RFC 3339 format)

deletion_scheduled

boolean

zone

string

Zone of the server.

srn

string · pattern: ^srn://apple-silicon…

SRN of the server.

delivered

boolean

vpc_status

scaleway.apple_silicon.v1alpha1.Server.PrivateNetworkStatus · enum

Activation status of optional Private Network feature support for this server.

Enum values:

vpc_unknown_status

vpc_enabled

vpc_updating

vpc_disabled

Default: vpc_unknown_status

Commitment scheme applied to this server.

public_bandwidth_bps

integer · uint64

Public bandwidth configured for this server. Expressed in bits per second.

tags

string[]

A list of tags attached to the server.

applied_runner_configuration_ids

string[]

Runner configurations applied on the server, optional.

kext_enabled

boolean

Status of kernel extensions for the server.

PATCH/apple-silicon/v1alpha1/zones/{zone}/servers/{server_id}

curl -X PATCH \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{}' \
  "https://api.scaleway.com/apple-silicon/v1alpha1/zones/{zone}/servers/{server_id}"

Example Request Body

{
  "name": "name",
  "schedule_deletion": true,
  "enable_vpc": true,
  "commitment_type": {
    "commitment_type": "duration_24h"
  },
  "public_bandwidth_bps": 0,
  "applied_runner_configurations": {
    "runner_configuration_ids": [
      "6170692e-7363-616c-6577-61792e636f6d"
    ]
  }
}

json

Example Responses

{
  "id": "id",
  "type": "type",
  "name": "name",
  "project_id": "project_id",
  "organization_id": "organization_id",
  "ip": "1.2.3.4",
  "vnc_url": "vnc_url",
  "ssh_username": "ssh_username",
  "sudo_password": "sudo_password",
  "vnc_port": 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"
  },
  "full_os_version": "full_os_version",
  "status": "unknown_status",
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "deletable_at": "2022-03-22T12:34:56.123456Z",
  "deletion_scheduled": true,
  "zone": "zone",
  "srn": "srn",
  "delivered": true,
  "vpc_status": "vpc_unknown_status",
  "commitment": {
    "type": "duration_24h",
    "cancelled": true
  },
  "public_bandwidth_bps": 0,
  "runner_configuration": {
    "name": "name",
    "url": "url",
    "token": "token",
    "provider": "unknown_provider",
    "download_runner": true,
    "action": "unknown_action",
    "id": "id",
    "labels": [
      "string"
    ]
  },
  "tags": [
    "string"
  ],
  "applied_runner_configuration_ids": [
    "string"
  ],
  "kext_enabled": true
}

json

application/json

Delete a server

DELETE

https://api.scaleway.com

/apple-silicon/v1alpha1/zones/{zone}/servers/{server_id}

Delete an existing Apple silicon server, specified by its server ID. Deleting a server is permanent, and cannot be undone. Note that the minimum allocation period for Apple silicon-as-a-service is 24 hours, meaning you cannot delete your server prior to that.

Delete a server › path Parameters

zone

string · enum · required

The zone you want to target

Enum values:

fr-par-3

server_id

string · required

UUID of the server you want to delete.

Delete a server › Responses

No data returned

Reboot a server

POST

https://api.scaleway.com

/apple-silicon/v1alpha1/zones/{zone}/servers/{server_id}/reboot

Reboot an existing Apple silicon server, specified by its server ID.

Reboot a server › path Parameters

zone

string · enum · required

The zone you want to target

Enum values:

fr-par-3

server_id

string · required

UUID of the server you want to reboot.

Reboot a server › Request Body

Reboot a server › Responses

200

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

Vnc:// URL to access Apple Remote Desktop.

ssh_username

string

SSH Username for remote shell.

sudo_password

string

Admin password required to execute commands.

vnc_port

integer · uint32

VNC port to use for remote desktop connection.

Initially installed OS. Initially installed OS, this does not necessarily reflect the current OS version.

full_os_version

string

Detailed initial installed OS version (..-). Initially installed OS, this does not necessarily reflect the current OS version.

status

scaleway.apple_silicon.v1alpha1.Server.Status · enum

Current status of the server.

Enum values:

unknown_status

starting

ready

error

rebooting

updating

locking

locked

Default: unknown_status

created_at

string | null · date-time

Date on which the server was created. (RFC 3339 format)

updated_at

string | null · date-time

Date on which the server was last updated. (RFC 3339 format)

deletable_at

string | null · date-time

Date from which the server can be deleted. (RFC 3339 format)

deletion_scheduled

boolean

zone

string

Zone of the server.

srn

string · pattern: ^srn://apple-silicon…

SRN of the server.

delivered

boolean

vpc_status

scaleway.apple_silicon.v1alpha1.Server.PrivateNetworkStatus · enum

Activation status of optional Private Network feature support for this server.

Enum values:

vpc_unknown_status

vpc_enabled

vpc_updating

vpc_disabled

Default: vpc_unknown_status

Commitment scheme applied to this server.

public_bandwidth_bps

integer · uint64

Public bandwidth configured for this server. Expressed in bits per second.

tags

string[]

A list of tags attached to the server.

applied_runner_configuration_ids

string[]

Runner configurations applied on the server, optional.

kext_enabled

boolean

Status of kernel extensions for the server.

POST/apple-silicon/v1alpha1/zones/{zone}/servers/{server_id}/reboot

curl -X POST \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{}' \
  "https://api.scaleway.com/apple-silicon/v1alpha1/zones/{zone}/servers/{server_id}/reboot"

Example Request Body

{}

json

Example Responses

{
  "id": "id",
  "type": "type",
  "name": "name",
  "project_id": "project_id",
  "organization_id": "organization_id",
  "ip": "1.2.3.4",
  "vnc_url": "vnc_url",
  "ssh_username": "ssh_username",
  "sudo_password": "sudo_password",
  "vnc_port": 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"
  },
  "full_os_version": "full_os_version",
  "status": "unknown_status",
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "deletable_at": "2022-03-22T12:34:56.123456Z",
  "deletion_scheduled": true,
  "zone": "zone",
  "srn": "srn",
  "delivered": true,
  "vpc_status": "vpc_unknown_status",
  "commitment": {
    "type": "duration_24h",
    "cancelled": true
  },
  "public_bandwidth_bps": 0,
  "runner_configuration": {
    "name": "name",
    "url": "url",
    "token": "token",
    "provider": "unknown_provider",
    "download_runner": true,
    "action": "unknown_action",
    "id": "id",
    "labels": [
      "string"
    ]
  },
  "tags": [
    "string"
  ],
  "applied_runner_configuration_ids": [
    "string"
  ],
  "kext_enabled": true
}

json

application/json

Reinstall a server

POST

https://api.scaleway.com

/apple-silicon/v1alpha1/zones/{zone}/servers/{server_id}/reinstall

Reinstall an existing Apple silicon server (specified by its server ID) from a new image (OS). All the data on the disk is deleted and all configuration is reset to the default configuration values of the image (OS).

Reinstall a server › path Parameters

zone

string · enum · required

The zone you want to target

Enum values:

fr-par-3

server_id

string · required

UUID of the server you want to reinstall.

Reinstall a server › Request Body

os_id

string | null

Reinstall the server with the OS corresponding to the os_id. Reinstall the server with the target OS, when no os_id provided the default OS for the server type is used.

enable_kext

boolean

Enable kernel extensions. Enable kernel extensions in this install of mac OS.

Reinstall a server › Responses

200

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

Vnc:// URL to access Apple Remote Desktop.

ssh_username

string

SSH Username for remote shell.

sudo_password

string

Admin password required to execute commands.

vnc_port

integer · uint32

VNC port to use for remote desktop connection.

Initially installed OS. Initially installed OS, this does not necessarily reflect the current OS version.

full_os_version

string

Detailed initial installed OS version (..-). Initially installed OS, this does not necessarily reflect the current OS version.

status

scaleway.apple_silicon.v1alpha1.Server.Status · enum

Current status of the server.

Enum values:

unknown_status

starting

ready

error

rebooting

updating

locking

locked

Default: unknown_status

created_at

string | null · date-time

Date on which the server was created. (RFC 3339 format)

updated_at

string | null · date-time

Date on which the server was last updated. (RFC 3339 format)

deletable_at

string | null · date-time

Date from which the server can be deleted. (RFC 3339 format)

deletion_scheduled

boolean

zone

string

Zone of the server.

srn

string · pattern: ^srn://apple-silicon…

SRN of the server.

delivered

boolean

vpc_status

scaleway.apple_silicon.v1alpha1.Server.PrivateNetworkStatus · enum

Activation status of optional Private Network feature support for this server.

Enum values:

vpc_unknown_status

vpc_enabled

vpc_updating

vpc_disabled

Default: vpc_unknown_status