Scaleway logo
Apple silicon API

scaleway.apple_silicon.v1alpha1.AppliedRunnerConfigurations

runner_configuration_ids
​string[]

(UUID format)

scaleway.apple_silicon.v1alpha1.BatchCreateServersRequest.BatchInnerCreateServerRequest

name
​string

scaleway.apple_silicon.v1alpha1.BatchCreateServersResponse

List of created servers.

scaleway.apple_silicon.v1alpha1.Commitment

Enum values:
duration_24h
renewed_monthly
none
Default: duration_24h
cancelled
​boolean

scaleway.apple_silicon.v1alpha1.Commitment.Type

string · enum
Enum values:
duration_24h
renewed_monthly
none
Default: duration_24h

scaleway.apple_silicon.v1alpha1.CommitmentTypeValue

commitment_type
​scaleway.apple_silicon.v1alpha1.Commitment.Type · enum
Enum values:
duration_24h
renewed_monthly
none
Default: duration_24h

scaleway.apple_silicon.v1alpha1.ConnectivityDiagnostic

id
​string
Enum values:
unknown_status
processing
error
completed
Default: unknown_status
is_healthy
​boolean
Enum values:
reboot_server
reinstall_server
error_message
​string
zone
​string

The zone you want to target

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

scaleway.apple_silicon.v1alpha1.ConnectivityDiagnostic.ActionType

string · enum
Enum values:
reboot_server
reinstall_server
Default: reboot_server

scaleway.apple_silicon.v1alpha1.ConnectivityDiagnostic.DiagnosticStatus

string · enum
Enum values:
unknown_status
processing
error
completed
Default: unknown_status

scaleway.apple_silicon.v1alpha1.ConnectivityDiagnostic.ServerHealth

last_checkin_date
​string | null · date-time

(RFC 3339 format)

is_server_alive
​boolean
is_agent_alive
​boolean
is_mdm_alive
​boolean
is_ssh_port_up
​boolean
is_vnc_port_up
​boolean

scaleway.apple_silicon.v1alpha1.GithubRunnerConfiguration

url
​string
token
​string
labels
​string[]

scaleway.apple_silicon.v1alpha1.GitlabRunnerConfiguration

url
​string
token
​string

scaleway.apple_silicon.v1alpha1.ListOSResponse

total_count
​integer · uint32

Total number of OS.

scaleway.apple_silicon.v1alpha1.ListRunnersResponse

total_count
​integer · uint64

scaleway.apple_silicon.v1alpha1.ListServerTypesResponse

Available server types.

scaleway.apple_silicon.v1alpha1.ListServersRequest.OrderBy

string · enum
Enum values:
created_at_asc
created_at_desc
Default: created_at_asc

scaleway.apple_silicon.v1alpha1.ListServersResponse

total_count
​integer · uint32

Total number of servers.

Paginated returned servers.

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.

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

zone
​string

Zone of OS.

scaleway.apple_silicon.v1alpha1.OS.SupportedServerType

server_type
​string
fast_delivery_available
​boolean

scaleway.apple_silicon.v1alpha1.Runner

id
​string

UUID of the runner.

Configuration of the runner.

status
​scaleway.apple_silicon.v1alpha1.Runner.Status · enum

Status of the runner.

Enum values:
unknown_status
waiting
enabled
disabled
error
Default: unknown_status
error_message
​string

Error message of the runner (if any).

zone
​string

Zone of the runner.

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

SRN of the runner.

scaleway.apple_silicon.v1alpha1.Runner.Status

string · enum
Enum values:
unknown_status
waiting
enabled
disabled
error
Default: unknown_status

scaleway.apple_silicon.v1alpha1.RunnerConfiguration

name
​string
url
​string
token
​string
Enum values:
unknown_provider
github
gitlab
Default: unknown_provider
download_runner
​boolean
Enum values:
unknown_action
remove
update
add
Default: unknown_action
id
​string
labels
​string[]

scaleway.apple_silicon.v1alpha1.RunnerConfiguration.Action

string · enum
Enum values:
unknown_action
remove
update
add
Default: unknown_action

scaleway.apple_silicon.v1alpha1.RunnerConfiguration.Provider

string · enum
Enum values:
unknown_provider
github
gitlab
Default: unknown_provider

scaleway.apple_silicon.v1alpha1.RunnerConfigurationV2

name
​string
Enum values:
unknown_provider
github
gitlab
Default: unknown_provider
​
​

scaleway.apple_silicon.v1alpha1.RunnerConfigurationV2.Provider

string · enum
Enum values:
unknown_provider
github
gitlab
Default: unknown_provider

scaleway.apple_silicon.v1alpha1.Server

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.

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.

scaleway.apple_silicon.v1alpha1.Server.PrivateNetworkStatus

string · enum
Enum values:
vpc_unknown_status
vpc_enabled
vpc_updating
vpc_disabled
Default: vpc_unknown_status

scaleway.apple_silicon.v1alpha1.Server.Status

string · enum
Enum values:
unknown_status
starting
ready
error
rebooting
updating
locking
locked
Default: unknown_status

scaleway.apple_silicon.v1alpha1.ServerType

Size of the local disk of the server.

name
​string

Name of the type.

Size of memory available.

Current stock.

Enum values:
unknown_stock
no_stock
low_stock
high_stock
Default: unknown_stock
minimum_lease_duration
​string | null

Minimum duration of the lease in seconds. Minimum duration of the lease in seconds (example. 3.4s). (in seconds)

Network description.

The default OS for this server type.

zone
​string

Zone of the server type.

scaleway.apple_silicon.v1alpha1.ServerType.CPU

name
​string
core_count
​integer · uint32
frequency
​integer · uint64
sockets
​integer · uint32
threads_per_core
​integer · uint32

scaleway.apple_silicon.v1alpha1.ServerType.Disk

capacity
​integer · uint64

(in bytes)

type
​string

scaleway.apple_silicon.v1alpha1.ServerType.GPU

count
​integer · uint64

scaleway.apple_silicon.v1alpha1.ServerType.Memory

capacity
​integer · uint64

(in bytes)

type
​string

scaleway.apple_silicon.v1alpha1.ServerType.NPU

count
​integer · uint64

scaleway.apple_silicon.v1alpha1.ServerType.Network

public_bandwidth_bps
​integer · uint64
supported_bandwidth
​integer[]
default_public_bandwidth
​integer · uint64

scaleway.apple_silicon.v1alpha1.ServerType.Stock

string · enum
Enum values:
unknown_stock
no_stock
low_stock
high_stock
Default: unknown_stock

scaleway.apple_silicon.v1alpha1.StartConnectivityDiagnosticResponse

diagnostic_id
​string

scaleway.apple_silicon.v1alpha1.UpdateRunnerConfigurationStatusResponse

scaleway.apple_silicon.v1alpha1.UserConfiguration

vnc_password
​string
ssh_keys
​string[]